-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
media: fixing the Swagger Tag for consistency #21581
Conversation
The other Swagger Tags for this Operation are `StreamingEndpoints`, this is a typo for the Update operation and should be consistent
Hi, @tombuildsstuff Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
tools/importer-rest-api-specs: adding a swagger data workaround for Azure/azure-rest-api-specs#21581
@allenjzhang what's needed to get this one merged? |
/azp run |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
streamingservice.json | 2020-05-01(e814adc) | 2020-05-01(main) |
streamingservice.json | 2021-06-01(e814adc) | 2021-06-01(main) |
streamingservice.json | 2021-11-01(e814adc) | 2021-11-01(main) |
streamingservice.json | 2022-08-01(e814adc) | 2022-08-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-metadata-2022-08 | package-metadata-2022-08(e814adc) | package-metadata-2022-08(main) |
package-2022-08 | package-2022-08(e814adc) | package-2022-08(main) |
package-account-2021-11 | package-account-2021-11(e814adc) | package-account-2021-11(main) |
package-2021-11 | package-2021-11(e814adc) | package-2021-11(main) |
package-2021-06 | package-2021-06(e814adc) | package-2021-06(main) |
package-2021-05 | package-2021-05(e814adc) | package-2021-05(main) |
package-2020-05 | package-2020-05(e814adc) | package-2020-05(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L30 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L30 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L76 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L76 |
MissingXmsErrorResponse |
Response code 404 is defined without a x-ms-error-response. Location: Streaming/stable/2020-05-01/streamingservice.json#L108 |
MissingXmsErrorResponse |
Response code 404 is defined without a x-ms-error-response. Location: Streaming/stable/2020-05-01/streamingservice.json#L108 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L124 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L124 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Streaming/stable/2020-05-01/streamingservice.json#L209 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:location. Location: Streaming/stable/2020-05-01/streamingservice.json#L214 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:location. Location: Streaming/stable/2020-05-01/streamingservice.json#L214 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L226 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L226 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L246 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L246 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L274 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L274 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L295 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L295 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L296 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Streaming/stable/2020-05-01/streamingservice.json#L296 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L324 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Streaming/stable/2020-05-01/streamingservice.json#L324 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L342 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Streaming/stable/2020-05-01/streamingservice.json#L342 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/mediaservices/resource-manager/readme.md tag: specification/mediaservices/resource-manager/readme.md#tag-package-metadata-2022-08 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 28 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @tombuildsstuff, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@qiaozha to confirm the JS sdk breaking change |
@raych1 Could you help take a look at the model validation error ? Thanks |
Approved it as it's not caused by this PR change. |
The other Swagger Tags for this Operation are `StreamingEndpoints`, this is a typo for the Update operation and should be consistent
The other Swagger Tags for this Operation are
StreamingEndpoints
, this is a typo for the Update operation and should be consistent