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.

Sign up for GitHub

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

Jump to bottom

The description is wrong for R4018 OperationsApiResponseSchema #11651

Closed
aim-for-better opened this issue Nov 12, 2020 · 3 comments · Fixed by #11208
Closed

The description is wrong for R4018 OperationsApiResponseSchema #11651

aim-for-better opened this issue Nov 12, 2020 · 3 comments · Fixed by #11208
Assignees
@raych1
Labels
needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team.

Comments

@aim-for-better
Copy link
Member

The description for R4018 OperationsApiResponseSchema
is

Description : The operations API should have a response body schema consistent with the contract spec. The required properties such as isDataAction,display.description **or** display.resource,must be included.

But in fact it should be "and", display.description and display.resource must be included or the error can't be fixed.
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Nov 12, 2020
@aim-for-better
Copy link
Member Author

Either the autorest tool is wrong or the document is wrong.

@raych1
Copy link
Member

raych1 commented Nov 13, 2020

@jianyexi , can you have a look at this lint rule document?

@jianyexi
Copy link
Contributor

@aim-for-better Thanks, this is a good suggestion, the document is confusing , I will fix it ASAP.
The operation API should follow the schema in https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#exposing-available-operations

@jianyexi jianyexi mentioned this issue Nov 17, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@raych1 raych1

Labels
needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update openapi-authoring-automated-guidelines.md to avoid comfusing Azure/azure-rest-api-specs
3 participants
@aim-for-better @raych1 @jianyexi