friedrichweinmann / autorest Goto Github PK

Because that's a must

Need to add good example and the schema reference for transform files

<path>:<method>

Name             : Name of the command to generate
Synopsis         : Synopsis part of the command help
Description      : Description part of the command help
DocumentationUrl : Link to the online documentation
ServiceName      : Specific service override to include. Needs to be implemented in the Rest Command used.
Scopes           : Scopes required in delegate authentication mode. Will be included in help and passed to rest command.
RestCommand      : Command to use to execute the rest request and handle authentication
ProcessorCommand : An additional command used to process the output. This command must be implemented manually.
ParameterSets    : Hashtable mapping parameterset name to its description. Used in examples.

Parameters:
To override individual properties on parameters, create a child-hashtable.
Each key is the system name of the parameter, entries govern the properties to override.
Example:

Parameters = @{
    MachineID = @{
        Description = 'ID of the machine to get recommendations for.'
    }
}

As an enhancement idea:
Would it be ok to use the templating functionality of PSModuleDevelopment for generation of the function code? Currently the regular string-format is used, with multiple nested layers and placeholders up to {12}. In my experience this is a little bit hard/confusing if you want to modify it.

If this would be acceptable I'd be happy to contribute again. My implementation plan would be

• create templates out of the existing format-strings
• put the template names into the PSF Configuration framework
• change the function generation process to use the template functions
  (enhancement from PSMD issue 166 would be great 😄)

The advantage of this implementation would be that the templates would be easier to maintain and adjustments to the texts could be made without adjusting the code.

... and provide a simple way to generate it for your own code

Some OpenAPI documents contain a response schema
Generating format-XML for those - and supporting configuration options for it - would provide benefits to user experience

The included ConvertTo-Hashtable includes every attribute if the include Parameter is an empty HashTable.

Issue only opened for documentation purpose, I've fixed it within my fork, PR will be created after the issue/enhancement entries.

Background:

My Dracoon PowerShell module uses the generic Rest Helper Module ARAH. As I didn't find the time to implement functions for every endpoint (>200) I used your module to create functions for them. But my underlying Rest-Invoke-Method needs the connection to be passed as a parameter.

Enhancement idea

Add functionality to the transform capability to add non-existing parameters to the created functions

Request opened for documentation purpose, I've already added it within my fork, PR will be created after the issue/enhancement entries. I hope everything will be ok within the PR.

Should be disabled by default
Performance optimization should make this an opt-in thing for debugging purposes

In order to use the module with the Dracoon specification I needed the support for header parameters.

Request opened for documentation purpose, I've already added it within my fork, PR will be created after the issue/enhancement entries. I hope everything will be ok within the PR.