-
Notifications
You must be signed in to change notification settings - Fork 101
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
Fix UCP examples to conform with oav validate-example
command
#4532
Conversation
...tion/ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/examples/CredentialsPut.json
Outdated
Show resolved
Hide resolved
swagger/specification/ucp/resource-manager/UCP/preview/examples/ResourceGroupsList.json
Show resolved
Hide resolved
swagger/specification/ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/ucp.json
Show resolved
Hide resolved
swagger/specification/ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/ucp.json
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
plane/resourcegroup changes look good
135cfde
to
73a4863
Compare
5b72e6e
to
b2e97bb
Compare
oav validate-example
command oav validate-example
command
...er/Applications.Core/preview/2022-03-15-privatepreview/examples/ApplicationsListByScope.json
Outdated
Show resolved
Hide resolved
...n/ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/examples/AWSCredentialsGet.json
Show resolved
Hide resolved
...n/ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/examples/AWSCredentialsPut.json
Show resolved
Hide resolved
...ucp/resource-manager/UCP/preview/2022-09-01-privatepreview/examples/AzureCredentialsGet.json
Show resolved
Hide resolved
Is there some instruction to run the oav locally? |
@asilverman thanks for this work. I have the suggestion. We have not run the linter for all swagger files for a while. We can add oav linter CI check first but set it as optional check, so it should not block PR merge. Then we can fix the discovered linter errors iteratively. WDYT? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM (needs a rebase)
Yes - |
Description
The examples we specify in our OpenAPI spec (
x-ms-examples
) should be verified to conform to the spec. This PR adds a check for the UCP OpenAPI spec in the CI/CD pipeline to ensure that moving forward we update any drifts from the spec as the spec evolves.Fixes #4566
Changes
ucp.json
spec to remove async operations (per conversation with @Vinaya)api-version
param to Credentials