Schema resource added in REST API Spec for api-version 2021-04-01-preview #15667
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
…021-01-01-preview to version 2021-04-01-preview
* Added support for GraphQL API type * Added missing enum value for GraphQL APIs.
Co-authored-by: Alan Feng <alanfeng@microsoft.com>
* outbound dependency * fix resource
* Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id
* system-data * fix spec * remove unreferenced file
* HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>
Fixing changes in SchemaContract.
|
Hi, @shinjiDev 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. vsswagger@microsoft.com |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The child tracked resource, 'schemas' with immediate parent 'ApiContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/definitions.json#L4999 |
|
| The child tracked resource, 'schemas' with immediate parent 'ApiManagementServiceResource', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/definitions.json#L5071 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ApiManagementHeadApi Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimschema.json#L103 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response of operation:'SignInSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L123 |
|
The response of operation:'SignUpSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L315 |
|
The response of operation:'DelegationSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L507 |
|
The response of operation:'SignInSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L218 |
|
The response of operation:'SignUpSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L410 |
|
The response of operation:'DelegationSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalsettings.json#L602 |
|
The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimdeployment.json#L37 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'RegionContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L85 |
|
The schema 'RegionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L103 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json#L55 |
️️✔️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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️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
- apimanagement/resource-manager/readme.md#package-2021-08
- apimanagement/resource-manager/readme.md#package-preview-2021-04
- apimanagement/resource-manager/readme.md#package-preview-2021-01
- apimanagement/resource-manager/readme.md#package-2020-12
- apimanagement/resource-manager/readme.md#package-preview-2020-06
- apimanagement/resource-manager/readme.md#package-2019-12
- apimanagement/resource-manager/readme.md#package-preview-2019-12
- apimanagement/resource-manager/readme.md#package-2019-01
- apimanagement/resource-manager/readme.md#package-2018-06-preview
- apimanagement/resource-manager/readme.md#package-2018-01
- apimanagement/resource-manager/readme.md#package-2017-03
- apimanagement/resource-manager/readme.md#package-2016-10
- apimanagement/resource-manager/readme.md#package-2016-07
️️✔️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).
ghost
added
the
customer-reported
Swagger Generation Artifacts
|
|
Thank you for your contribution shinjiDev! We will review the pull request and get back to you soon. |
|
Hi, @shinjiDev your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi @shinjiDev, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @shinjiDev, Your PR has some issues. Please fix the CI sequentially by following the order of
|
PR description updated. |
added 3 commits
November 9, 2021 12:31
openapi-pipeline-app
bot
added
BreakingChangeReviewRequired
CI-BreakingChange-Python
and removed
NewApiVersionRequired
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
ArcturusZhang
added
the
Approved-SdkBreakingChange-Go
This was referenced Nov 10, 2021
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
…view (Azure#15667) * Adds base for updating Microsoft.ApiManagement from version preview/2021-01-01-preview to version 2021-04-01-preview * Updates readme * Updates API version in new specs and examples * Added support for GraphQL API type (Azure#14851) * Added support for GraphQL API type * Added missing enum value for GraphQL APIs. * add schema definition fix from 2021-01-01-preview (Azure#14883) Co-authored-by: Alan Feng <alanfeng@microsoft.com> * Vanguard: Get Outbound Network Dependency (Azure#14900) * outbound dependency * fix resource * Update backup/restore API for managed identities (Azure#14973) * Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id * SystemData implemenation on API Management Control Plane (Azure#14899) * system-data * fix spec * remove unreferenced file * APIM - Network Watcher Connectivity Check integration specs (Azure#15056) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Parameter examples added (Azure#14836) * platformversion (Azure#15114) * fix update service (Azure#15478) * HttpConnect example (Azure#15493) * HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Rename from SchemaContract to ApiSchemaContract * apimschema.json added to last apim preview version * Completing specification for Schema resource. Fixing changes in SchemaContract. * Value field added to Schema resource specification. * path fixed. Renamed from ApiSchema to Schema. Adding suppression rule to readme.md Custom word added for spellcheck * Fixing PR observations. * Added properties of difference API spec format for "SchemaDocumentProperties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix * [APIM]Add private endpoint connection APIs (Azure#15115) * Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * Merge main * Modifications to Schema definition to add "description" field. Updating examples of Schema. * Fixing apimanagement.json * Prettier applied in files * Fixing PR comments * fixing x-ms-long-running-operation. * x-ms-long-running-operation : true in apischema. * Removing "Resource" type from apimanagement.json * Apimschema.json updated to point to types.json for ErrorResponse. * undoing change of responseBody * Updating ErrorResponse. * Fixing definitions merge. Co-authored-by: Samir Solanki <samirsolanki@outlook.com> Co-authored-by: Alexander Zaslonov <zaslonov.alexander@gmail.com> Co-authored-by: DreamlessA <DreamlessA@users.noreply.github.com> Co-authored-by: Alan Feng <alanfeng@microsoft.com> Co-authored-by: Jatin Sanghvi <20547963+JatinSanghvi@users.noreply.github.com> Co-authored-by: Nicolás Barrera <nicolasbarrera@outlook.com> Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> Co-authored-by: VitaliyKurokhtin <vitaliik@microsoft.com> Co-authored-by: Christian Palomares <cpalomar@microsoft.com> Co-authored-by: RupengLiu <rliu1211@terpmail.umd.edu> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
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:
December 2021
December 2021
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.