Syntex: moving 2022-09-15-preview version from azure-rest-api-specs-pr/RPSaaSMaster to azure-rest-api-specs/main #20959
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
* Initial commit of microsoft.syntex to RPSaaSMaster branch - Dev syntex microsoft.syntex 2021 10 20 preview (Azure#5281) - Aligned resource type names with the guidelines (plural, camelCase) - Updated provider name in URIs to lower case and provider type to plural camelCase - Updated examples to match specification - Updated DocumentProperties with new required fields, added processDocuments request (Azure#5971) - Changed suffix from -preview to -privatepreview (Azure#6047) - Corrected description field (Azure#6059) - Reverted back to -preview from -privatepreview (Azure#6061) * Added Syntex to custom-words.txt * Fixed 'Missing required property: meterId' * Fixed "the 'openapi-subtype' is unset" error * Fixing Lint(RPaaS) errors: - x-ms-long-running-operation - provisioningState * More Lint(RPaaS) errors: - x-ms-long-running-operation-options - provisioningState directly in the properties bag * ModelValidation: fixed position of provisioningState * Fixed OneUnderscoreInOperationId LintDiff errors * Fixing "Resource provider naming must follow the pascal case" errors. * Fixing systemData error * Fixed location of the types.json, which is in common-types * Fixed location of systemData in the DocumentProcessorResource * Another re-positioning of systemData * Started referencing the Resource from common-types * Changed base resource of DocumentProcessorResource from Resource to TrackedResource * Corrected update example by adding location property * correctly placed location property in the update request * Fixed update LintDiff error * Fixed Delete 204 LintDiff error * Fixed XmsIdentifierValidation errors * Fixed operation response * Fixed errors related to x-ms-pageable * Fixed duplicate example Operation IDs * Fixed x-ms-long-running-operation - related error * Added description field to ResponseStatus * Fixed a spelling error * Fixed azure-asyncoperation - related error * fixed prettier errors * Addressed feedback from ARM review board meeting (Azure#6107) * Removed processDocument operation * Removed DocumentProcessorProperties and ProvisioningState * Fixed examples after removing DocumentProperties and ProvisioningState * Removed x-ms-long-running-operation and 201/202 return codes * Revert "Removed DocumentProcessorProperties and ProvisioningState" This reverts commit 2e621471a91c6453a2e9a154604a608dbe059ee4. * Removed processorName property after reverting DocumentProperties back * Simplified ProvisioningState to have only 2 states to reflect non-async resource creation status * Removed depricated status codes from the examples * Made sure that only tags property of the DocumentProcessorResource can be patched. * Added "Canceled" terminal state per Sanjai's feedback.
…ty (Azure#7579) * copied 2021-10-20 to 2022-06-15 * - Added spoTenantAdminUrl property - Updated examples and the spec to make sure spoAdminTenantUrl is patchable. - Fixed prettier errors - copied 2021-10-20 to 2022-06-15 - corrected API version in 2022-06-15 folder - Restored 2021-10-20 version to its original state - made the latest API version a default tag in readme.md - made spoTenantAdminUrl required in the new API (Azure#7586) - Fixed required property for spoTenantAdminUrl (Azure#7588) * Corrected PATCH schema and example (Azure#7601)
* initial copy of 2022-06-15-preview API * changed API version * Updated readme.md to incorporate a new version * Updated resource schema * removed processDocuments operation, associated types and examples * Updated examples to match new schema * Fixed prettier errors
…pecs-pr/RPSaaSMaster to azure-rest-api-specs/main: - 2021-10-20-preview - 2022-06-15-preview Left only 2022-09-15-preview version.
|
Hi, @yurych 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 |
Swagger Validation Report
|
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-09-15-preview | package-2022-09-15-preview(70f6cb4) | default(main) |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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] TrafficValidation: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/70f6cb43c04c24c3696b1b5d0ba7d78bc95f0b9b/specification/syntex/resource-manager/readme.md#tag-package-2022-09-15-preview">syntex/resource-manager/readme.md#package-2022-09-15-preview
| Rule | Message |
|---|---|
| "readme":"syntex/resource-manager/readme.md", "tag":"package-2022-09-15-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌Lint(RPaaS): 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
[RPaaS] An async PUT operation must set ''x-ms-long-running-operation' : true''. Location: Microsoft.Syntex/preview/2022-09-15-preview/syntex.json#L187 |
|
[RPaaS] An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Syntex/preview/2022-09-15-preview/syntex.json#L187 |
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @yurych, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Please note:
In reply to: 1264133884 |
This was referenced Sep 30, 2022
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
...rce-manager/Microsoft.Syntex/preview/2022-09-15-preview/examples/DocumentProcessor_List.json
Outdated
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
specification/syntex/resource-manager/Microsoft.Syntex/preview/2022-09-15-preview/syntex.json
Outdated
Show resolved
Hide resolved
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove In reply to: 1268655073 |
- Added 201 response code for PUT request - Added an example for 201 PUT response
- Changed Id -> ID
- Started using SubscriptionId, ResourceGroupName and ApiVersion parameters from common-types v3
- Fixed casing in resource IDs
- correciton: patched -> updated
- Started referencing ErrorResponse from common-types v3
- Removed namd from x-ms-identifiers
|
Based on the comment above |
This was referenced Oct 7, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Oct 7, 2022
…re-rest-api-specs-pr/RPSaaSMaster to azure-rest-api-specs/main (#2609) Create to sync Azure/azure-rest-api-specs#20959 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/syntex?expand=1)
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
…r/RPSaaSMaster to azure-rest-api-specs/main (Azure#20959) * Initial commit of microsoft.syntex to RPSaaSMaster branch (Azure#6063) * Initial commit of microsoft.syntex to RPSaaSMaster branch - Dev syntex microsoft.syntex 2021 10 20 preview (Azure#5281) - Aligned resource type names with the guidelines (plural, camelCase) - Updated provider name in URIs to lower case and provider type to plural camelCase - Updated examples to match specification - Updated DocumentProperties with new required fields, added processDocuments request (Azure#5971) - Changed suffix from -preview to -privatepreview (Azure#6047) - Corrected description field (Azure#6059) - Reverted back to -preview from -privatepreview (Azure#6061) * Added Syntex to custom-words.txt * Fixed 'Missing required property: meterId' * Fixed "the 'openapi-subtype' is unset" error * Fixing Lint(RPaaS) errors: - x-ms-long-running-operation - provisioningState * More Lint(RPaaS) errors: - x-ms-long-running-operation-options - provisioningState directly in the properties bag * ModelValidation: fixed position of provisioningState * Fixed OneUnderscoreInOperationId LintDiff errors * Fixing "Resource provider naming must follow the pascal case" errors. * Fixing systemData error * Fixed location of the types.json, which is in common-types * Fixed location of systemData in the DocumentProcessorResource * Another re-positioning of systemData * Started referencing the Resource from common-types * Changed base resource of DocumentProcessorResource from Resource to TrackedResource * Corrected update example by adding location property * correctly placed location property in the update request * Fixed update LintDiff error * Fixed Delete 204 LintDiff error * Fixed XmsIdentifierValidation errors * Fixed operation response * Fixed errors related to x-ms-pageable * Fixed duplicate example Operation IDs * Fixed x-ms-long-running-operation - related error * Added description field to ResponseStatus * Fixed a spelling error * Fixed azure-asyncoperation - related error * fixed prettier errors * Addressed feedback from ARM review board meeting (Azure#6107) * Removed processDocument operation * Removed DocumentProcessorProperties and ProvisioningState * Fixed examples after removing DocumentProperties and ProvisioningState * Removed x-ms-long-running-operation and 201/202 return codes * Revert "Removed DocumentProcessorProperties and ProvisioningState" This reverts commit 2e621471a91c6453a2e9a154604a608dbe059ee4. * Removed processorName property after reverting DocumentProperties back * Simplified ProvisioningState to have only 2 states to reflect non-async resource creation status * Removed depricated status codes from the examples * Made sure that only tags property of the DocumentProcessorResource can be patched. * Added "Canceled" terminal state per Sanjai's feedback. * Added a new API version to accommodate a new spoTenantAdminUrl property (Azure#7579) * copied 2021-10-20 to 2022-06-15 * - Added spoTenantAdminUrl property - Updated examples and the spec to make sure spoAdminTenantUrl is patchable. - Fixed prettier errors - copied 2021-10-20 to 2022-06-15 - corrected API version in 2022-06-15 folder - Restored 2021-10-20 version to its original state - made the latest API version a default tag in readme.md - made spoTenantAdminUrl required in the new API (Azure#7586) - Fixed required property for spoTenantAdminUrl (Azure#7588) * Corrected PATCH schema and example (Azure#7601) * New API version: 2022-09-15-preview (Azure#8815) * initial copy of 2022-06-15-preview API * changed API version * Updated readme.md to incorporate a new version * Updated resource schema * removed processDocuments operation, associated types and examples * Updated examples to match new schema * Fixed prettier errors * Removed API versions that we don't want to move from azure-rest-api-specs-pr/RPSaaSMaster to azure-rest-api-specs/main: - 2021-10-20-preview - 2022-06-15-preview Left only 2022-09-15-preview version. * Added "x-ms-parameter-location": "method" to fix XmsParameterLocation LintDiff error. * Tim's feedback: - Expanded SPO achronym in comments - Started referencing common-types v3 instead of v2 - Started referencing OperationListResult from common-types v3, removed local OperationsListResult - Removed systemData from DocumentProcessorResource - Added provisioningState to Create, Get, and List responses - Changed capitalization: microsoft.syntex -> Microsoft.Syntex - Added operation list to the Operations_list.json example * Fixed prettier errors * Tim's feedback: - Added 201 response code for PUT request - Added an example for 201 PUT response * Tim's feedback: - Changed Id -> ID * Tim's feedback: - Started using SubscriptionId, ResourceGroupName and ApiVersion parameters from common-types v3 * Tim's feedback - Fixed casing in resource IDs * Tim's feedback: - correciton: patched -> updated * Tim's feedback: - Started referencing ErrorResponse from common-types v3 * Tim's feedback: - Removed namd from x-ms-identifiers
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.