Adding Swagger for Domain renewal API#2155
Conversation
| "204": { | ||
| "description": "Domain does not exist." | ||
| }, | ||
| "400": { |
There was a problem hiding this comment.
All the negative response status code descriptions MUST be defined in the description of the "default" status code (if the intention is for documentation purpose only). Example: "description": "'404' - 'Not found'.\n'400' - 'Bad request'.\n'500': 'Internal Server Error'."'
There was a problem hiding this comment.
I'm not sure what you mean. Do you mean just changing the description from something like "Malformed domain renewal request." to "'400' - 'Bad request'." ?
There was a problem hiding this comment.
If you list a response code like this it will be treated as a valid response code. Thus you must not list error response codes but put all of them in meaningful descriptions in status code "default". E.g.:
| "200": { | ||
| "description": "Domain renewal was successful." | ||
| }, | ||
| "202": { |
There was a problem hiding this comment.
Is this a long running operation? Please add "x-ms-long-running-operation": true if so.
| ], | ||
| "summary": "Renew a domain.", | ||
| "description": "Renew a domain.", | ||
| "operationId": "Domains_Renew", |
There was a problem hiding this comment.
Please add an example to this operation. See https://github.com/Azure/azure-rest-api-specs/blob/current/documentation/x-ms-examples.md
There was a problem hiding this comment.
Done with latest commit.
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": {} |
There was a problem hiding this comment.
Remove "body": {} since the operation doesn't return a body
| "domainName": "example.com" | ||
| }, | ||
| "responses": { | ||
| "200": { |
There was a problem hiding this comment.
Please also add 202 and 204 here
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
|
Was unable to find SDK Azure/azure-sdk-for-python PR for this closed PR. |
|
Was unable to find SDK Azure/azure-sdk-for-python PR for this closed PR. |
|
No modification for AutorestCI/azure-sdk-for-python |
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger