python sdk readme guide #10123
Merged
python sdk readme guide #10123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[Staging] Swagger Validation Report
️✔️ |
|
Azure Pipelines successfully started running 1 pipeline(s). |
azure-sdk-for-go - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-net - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-js - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
Trenton Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-java - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python-track2 - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
|
Can one of the admins verify this patch? |
akning-ms
reviewed
Jul 15, 2020
| ~~~~ | ||
|
|
||
| ### tag | ||
| A tag can contains a bunch of swagger files which are used to generate the SDK. For Example: |
There was a problem hiding this comment.
Should we add some name rule for tag to unify it?
There was a problem hiding this comment.
yes, @akning-ms , I think we can recommend it as: package-yyyy-mm-dd[-xxxx]. where the xxxx can be 'preview' or 'only'. I will add it in this PR.
|
Azure Pipelines successfully started running 1 pipeline(s). |
nickzhums
reviewed
Jul 17, 2020
| @@ -0,0 +1,229 @@ | |||
| # Readme Configuration Guide for Python SDK | |||
| This file describe how to configure readme files to make it avaiable for Python SDK code generation. | |||
nickzhums
reviewed
Jul 17, 2020
| description: xxxx Configuration Client | ||
| openapi-type: arm | ||
| tag: package-xxxx-xx-xx | ||
| ``` |
There was a problem hiding this comment.
can we use a real example here?
nickzhums
reviewed
Jul 17, 2020
| ~~~~ | ||
|
|
||
| ### tag | ||
| A tag can contains a bunch of swagger files which are used to generate the SDK. |
There was a problem hiding this comment.
do we need to explain benefits of using tag for service team?
nickzhums
reviewed
Jul 17, 2020
| ~~~ | ||
|
|
||
| ## Multi-api | ||
| If a multi-api package is need to be released, 'batch' should be used in the readme.python.md. |
There was a problem hiding this comment.
Maybe explain a little bit about multi-api to the service team. Basically it's a package that contains the API versions?
nickzhums
reviewed
Jul 17, 2020
|
|
||
| ## Run codegen | ||
| After configure all the readme files, autorest can be used to generate SDK. | ||
| ### Track1 |
There was a problem hiding this comment.
Describe Track 1 (Based on AutoRest version xxxxx that's going to be replaced by version yyyyy)
nickzhums
reviewed
Jul 17, 2020
| autorest --keep-version-file --multiapi --no-async --python --python-mode=update --python-sdks-folder=C:\ZZ\projects\codegen\azure-sdk-for-python\sdk --use=@microsoft.azure/autorest.python@~4.0.71 --version=V2 ..\azure-rest-api-specs\specification\appconfiguration\resource-manager\readme.md | ||
| ~~~ | ||
|
|
||
| ### Track2 |
There was a problem hiding this comment.
Track 2 is based on the latest AutoRest code generator
|
Azure Pipelines successfully started running 1 pipeline(s). |
nickzhums
approved these changes
Jul 20, 2020
00Kai0
pushed a commit
to 00Kai0/azure-rest-api-specs
that referenced
this pull request
Oct 12, 2020
* python sdk readme guide * add tag name rule * address comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.
Please follow the link to find more details on API review process.