SRP Swagger Updates for Sep21 [2021-09-01] Api Version GA #18070
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
… and validation check done.
…an Prettier and Validation check
…Migration and SCGRS operations
…eted versions and snapshotr
…at policy level with deprecated comment.
… Run prettier check and validation
…D for UA Identities, Update existing Example
HimanshuChhabra
requested review from
msyyc,
BigCat20196,
ArcturusZhang and
JasonYang-MSFT
as code owners
|
Hi, @HimanshuChhabra 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. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
ghost
added
the
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: TableOperationPutOrPatchAcls Location: Microsoft.Storage/stable/2021-09-01/table.json#L219 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L1469 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/common.json#L34 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/common.json#L34 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/common.json#L34 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/common.json#L34 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Storage/stable/2021-09-01/storage.json#L2926 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L58 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}' Location: Microsoft.Storage/stable/2021-09-01/file.json#L61 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas' Location: Microsoft.Storage/stable/2021-09-01/storage.json#L650 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas' Location: Microsoft.Storage/stable/2021-09-01/storage.json#L695 |
|
The response of operation:'BlobContainers_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L218 |
|
The response of operation:'BlobContainers_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L276 |
|
The response of operation:'BlobContainers_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L323 |
|
The response of operation:'BlobContainers_CreateOrUpdateImmutabilityPolicy' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L501 |
|
The response of operation:'BlobContainers_GetImmutabilityPolicy' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/blob.json#L565 |
|
The response of operation:'FileShares_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/file.json#L235 |
|
The response of operation:'FileShares_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/file.json#L306 |
|
The response of operation:'FileShares_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/file.json#L362 |
|
The response of operation:'Queue_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/queue.json#L159 |
|
The response of operation:'Queue_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/queue.json#L214 |
|
The response of operation:'Queue_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/queue.json#L266 |
|
The response of operation:'Table_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/table.json#L159 |
|
The response of operation:'Table_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/table.json#L214 |
|
The response of operation:'Table_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Storage/stable/2021-09-01/table.json#L269 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L45 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L102 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L139 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L204 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L261 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2021-09-01/blob.json#L313 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 11 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2021-09-01/blob.json compared with base:stable/2021-08-01/blob.json
- current:stable/2021-09-01/blob.json compared with base:preview/2020-08-01-preview/blob.json
- current:stable/2021-09-01/common.json compared with base:stable/2021-08-01/common.json
- current:stable/2021-09-01/common.json compared with base:preview/2020-08-01-preview/common.json
- current:stable/2021-09-01/file.json compared with base:stable/2021-08-01/file.json
- current:stable/2021-09-01/file.json compared with base:preview/2020-08-01-preview/file.json
- current:stable/2021-09-01/privatelinks.json compared with base:stable/2021-08-01/privatelinks.json
- current:stable/2021-09-01/privatelinks.json compared with base:preview/2020-08-01-preview/privatelinks.json
- current:stable/2021-09-01/queue.json compared with base:stable/2021-08-01/queue.json
- current:stable/2021-09-01/queue.json compared with base:preview/2020-08-01-preview/queue.json
- current:stable/2021-09-01/storage.json compared with base:stable/2021-08-01/storage.json
- current:stable/2021-09-01/storage.json compared with base:preview/2020-08-01-preview/storage.json
- current:stable/2021-09-01/table.json compared with base:stable/2021-08-01/table.json
- current:stable/2021-09-01/table.json compared with base:preview/2020-08-01-preview/table.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi @HimanshuChhabra, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 2, 2022
blueww
reviewed
Mar 23, 2022
specification/storage/resource-manager/Microsoft.Storage/stable/2021-09-01/common.json
Outdated
Show resolved
Hide resolved
blueww
reviewed
Mar 23, 2022
specification/storage/resource-manager/Microsoft.Storage/stable/2021-09-01/storage.json
Outdated
Show resolved
Hide resolved
blueww
reviewed
Mar 23, 2022
specification/storage/resource-manager/Microsoft.Storage/stable/2021-09-01/storage.json
Outdated
Show resolved
Hide resolved
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @HimanshuChhabra your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
pilor
reviewed
Mar 23, 2022
specification/storage/resource-manager/Microsoft.Storage/stable/2021-09-01/storage.json
Outdated
Show resolved
Hide resolved
pilor
added
ARMChangesRequested
pilor
added
ARMSignedOff
This was referenced Mar 24, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Mar 24, 2022
This was referenced Mar 24, 2022
visingl
pushed a commit
that referenced
this pull request
Mar 30, 2022
* Full copy from 2021-08-01 to 2021-09-01 without any changes * Updating API version for Service types, Updating readme files * Feature: Premium Access Tier for PBB accounts, with example, prettier and validation check done. * Feature: Add LastTierChangeTime LCM Action support, Added Examples, Ran Prettier and Validation check * Feature: Add LCM BaseBlob daysAfterCreationTime actions with example * Feature : Async Sku Conversion Status Object for Customer controlled Migration and SCGRS operations * Feature: AllowPermanentDelete property to allow deletion for soft deleted versions and snapshotr * Linting S360 - Enum Mismatch, https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A2DB3DB8-3A59-44C9-85C1-7C9C66AED0AD, https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A1CA6F05-42DC-4D72-A0D6-928FB6BEEC54 * S365 Swagger Linting, Blob Invnetory, Add destination container back at policy level with deprecated comment. * Move SignedIdentifiers to Common.json, Add SI to Table, Add Examples, Run prettier check and validation * update the api version for the test * S365: Return CMK version expiration time with example, Return TenantID for UA Identities, Update existing Example * Feature: DnsEndpointType For Account Level PDNS * SpellCheck, Move Location header to 202 response for existing example (CI CD check failure) * Feature: Add ExcludePrefix, IncludeDeleted and Additional Scheams for BlobInventory. * remove asunc location header from example, latest model validation requires it to be removed * Account PDNS Updates Change AzureDnsZone type, Address comment for allowPermanentDelete * update the description and x-ms-clientname for currentCmkVersion * Update the Description for the DnsEndpointType. * Add input parameter to the Table API * Create separate definition for Table Signed Identifiers, Update Tests * Feature: Change daysAfterLastTierChangeTimeGreaterThan To daysAfterLastTierChangeGreaterThan * Add type=object and description for TableAccessPolicy, Update descriptions, Add the Async header back to the example. * Spell correction for file shares * Updating descriptions * Remove tenantId from the UAI * Change Header to Headers for failing check
manumsft
reviewed
Apr 11, 2022
| "sasExpirationPeriod": "1.15:59:59", | ||
| "expirationAction": "Log" | ||
| }, | ||
| "dnsEndpointType": "AzureDnsZoned", |
There was a problem hiding this comment.
@evelyn-ys , i think this needs to be AzureDnsZone. Can you please check and let me know.
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Full copy from 2021-08-01 to 2021-09-01 without any changes * Updating API version for Service types, Updating readme files * Feature: Premium Access Tier for PBB accounts, with example, prettier and validation check done. * Feature: Add LastTierChangeTime LCM Action support, Added Examples, Ran Prettier and Validation check * Feature: Add LCM BaseBlob daysAfterCreationTime actions with example * Feature : Async Sku Conversion Status Object for Customer controlled Migration and SCGRS operations * Feature: AllowPermanentDelete property to allow deletion for soft deleted versions and snapshotr * Linting S360 - Enum Mismatch, https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A2DB3DB8-3A59-44C9-85C1-7C9C66AED0AD, https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A1CA6F05-42DC-4D72-A0D6-928FB6BEEC54 * S365 Swagger Linting, Blob Invnetory, Add destination container back at policy level with deprecated comment. * Move SignedIdentifiers to Common.json, Add SI to Table, Add Examples, Run prettier check and validation * update the api version for the test * S365: Return CMK version expiration time with example, Return TenantID for UA Identities, Update existing Example * Feature: DnsEndpointType For Account Level PDNS * SpellCheck, Move Location header to 202 response for existing example (CI CD check failure) * Feature: Add ExcludePrefix, IncludeDeleted and Additional Scheams for BlobInventory. * remove asunc location header from example, latest model validation requires it to be removed * Account PDNS Updates Change AzureDnsZone type, Address comment for allowPermanentDelete * update the description and x-ms-clientname for currentCmkVersion * Update the Description for the DnsEndpointType. * Add input parameter to the Table API * Create separate definition for Table Signed Identifiers, Update Tests * Feature: Change daysAfterLastTierChangeTimeGreaterThan To daysAfterLastTierChangeGreaterThan * Add type=object and description for TableAccessPolicy, Update descriptions, Add the Async header back to the example. * Spell correction for file shares * Updating descriptions * Remove tenantId from the UAI * Change Header to Headers for failing check
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.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.