Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add help-content #898

Merged
merged 2 commits into from
Mar 3, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,39 @@ scope-black/emitter:
output-artifact: python-files
```

# Help

```yaml
help-content:
python: # type: Help as defined in autorest-core/help.ts
activationScope: python
categoryFriendlyName: Python Generator
settings:
- key: python-sdks-folder
description: The path to the root directory of your azure-sdk-for-python clone. Be sure to note that we include `sdk` in the folder path.
- key: black
description: Runs black formatting on your generated files. Defaults to `false`.
type: string
- key: basic-setup-py
description: Whether to generate a build script for setuptools to package your SDK. Defaults to `false`, generally not suggested if you are going to wrap the generated code
type: bool
- key: multiapi
description: Whether to generate a multiapi client.
type: bool
- key: default-api
description: In the case of `--multiapi`, you can override the default service API version with this flag. If not specified, we use the latest GA service version as the default API.
type: string
- key: no-namespace-folders
description: Specify if you don't want pkgutil-style namespace folders. Defaults to `false`.
type: bool
- key: credential-default-policy-type
description: Specify the default credential policy (authentication policy) for your client. Use in conjunction with `--add-credential`. Currently only supports `BearerTokenCredentialPolicy` and `AzureKeyCredentialPolicy`. Default value is `BearerTokenCredentialPolicy`. `--credential-scopes` is tied with `BearerTokenCredentialPolicy`, do not pass them in if you want `AzureKeyCredentialPolicy`.
type: string
- key: credential-key-header-name
description: The name of the header which will pass the credential. Use if you have `--credential-default-policy-type` set to `AzureKeyCredentialPolicy`. For example, if generating cognitive services code, you might use `--credential-key-header-name=Ocp-Apim-Subscription-Key`
type: string
```

<!-- LINKS -->

[python_docs]: https://github.com/Azure/autorest.python/tree/autorestv3/docs/readme.md
Expand Down