Add deprecation banner to Azure Maps Render V1 #26022
Merged
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
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| render.json | 1.0(fd50de3) | 1.0(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.1.6) | new version | base version |
|---|---|---|
| 1.0 | 1.0(fd50de3) | 1.0(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
'file' is not a known format. Location: Render/preview/1.0/render.json#L337 |
|
'file' is not a known format. Location: Render/preview/1.0/render.json#L469 |
|
'file' is not a known format. Location: Render/preview/1.0/render.json#L528 |
|
'file' is not a known format. Location: Render/preview/1.0/render.json#L639 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Render/preview/1.0/render.json#L5 |
|
| A required parameter should not specify a default value. Location: Render/preview/1.0/render.json#L189 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/preview/1.0/render.json#L192 |
|
| Error response should contain a x-ms-error-code header. Location: Render/preview/1.0/render.json#L347 |
|
The error property in the error response schema should be required.Location: Render/preview/1.0/render.json#L347 |
|
Error schema should define code and message properties as required.Location: Render/preview/1.0/render.json#L347 |
|
| A required parameter should not specify a default value. Location: Render/preview/1.0/render.json#L367 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/preview/1.0/render.json#L370 |
|
| Error response should contain a x-ms-error-code header. Location: Render/preview/1.0/render.json#L479 |
|
The error property in the error response schema should be required.Location: Render/preview/1.0/render.json#L479 |
|
Error schema should define code and message properties as required.Location: Render/preview/1.0/render.json#L479 |
|
| A required parameter should not specify a default value. Location: Render/preview/1.0/render.json#L499 |
|
| Error response should contain a x-ms-error-code header. Location: Render/preview/1.0/render.json#L538 |
|
The error property in the error response schema should be required.Location: Render/preview/1.0/render.json#L538 |
|
Error schema should define code and message properties as required.Location: Render/preview/1.0/render.json#L538 |
|
| A required parameter should not specify a default value. Location: Render/preview/1.0/render.json#L558 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/preview/1.0/render.json#L561 |
|
| Error response should contain a x-ms-error-code header. Location: Render/preview/1.0/render.json#L572 |
|
The error property in the error response schema should be required.Location: Render/preview/1.0/render.json#L572 |
|
Error schema should define code and message properties as required.Location: Render/preview/1.0/render.json#L572 |
|
| A required parameter should not specify a default value. Location: Render/preview/1.0/render.json#L592 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/preview/1.0/render.json#L595 |
|
| Error response should contain a x-ms-error-code header. Location: Render/preview/1.0/render.json#L649 |
|
The error property in the error response schema should be required.Location: Render/preview/1.0/render.json#L649 |
|
Error schema should define code and message properties as required.Location: Render/preview/1.0/render.json#L649 |
|
| Based on the response model schema, operation 'Render_GetCopyrightFromBoundingBox' might be pageable. Consider adding the x-ms-pageable extension. Location: Render/preview/1.0/render.json#L656 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
miaxzhitong
requested review from
tg-msft and
MushMal
and removed request for
a team
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
ismael-ms
reviewed
Sep 29, 2023
|
/pr RequestMerge |
miaxzhitong
changed the title
JeffreyRichter
approved these changes
Oct 2, 2023
|
Hi @JeffreyRichter, Thanks for approving this PR. It seems that @tjprescott, the assignee of this PR, is OOF now. Can you help with merging this PR and so that we can caught the batch to go live today's evening / tomorrow's morning? Thanks so much! |
|
@jhendrixMSFT Can you merge or what is the procedure if the assignee is OOF? |
|
Hi @JeffreyRichter, it seems that I can add you as assignee for this PR. Do you think it will be a good workaround for now? Please let me know if you have any concern here. |
|
What do you want me to do with this pr?
…-- Jeffrey
________________________________
From: miaxzhitong ***@***.***>
Sent: Monday, October 2, 2023 5:58:32 PM
To: Azure/azure-rest-api-specs ***@***.***>
Cc: Jeffrey Richter ***@***.***>; Mention ***@***.***>
Subject: Re: [Azure/azure-rest-api-specs] Add deprecation banner to Azure Maps Render V1 (PR #26022)
Hi @JeffreyRichter<https://github.com/JeffreyRichter>, it seems that I can add you as assignee for this PR. Do you think it will be a good workaround for now? Please let me know if you have any concern here.
—
Reply to this email directly, view it on GitHub<#26022 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AARLJP52PF4QVBWTIOJ5JLDX5NPLRAVCNFSM6AAAAAA5LZHOUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBTHE4TMNZRGE>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Can you help to merge it so that this PR can catch the go-live batch tomorrow? Thanks so much! |
|
I cannot merge. The assignee merges.
…-- Jeffrey
________________________________
From: miaxzhitong ***@***.***>
Sent: Monday, October 2, 2023 8:32:27 PM
To: Azure/azure-rest-api-specs ***@***.***>
Cc: Jeffrey Richter ***@***.***>; Mention ***@***.***>
Subject: Re: [Azure/azure-rest-api-specs] Add deprecation banner to Azure Maps Render V1 (PR #26022)
What do you want me to do with this pr?
…
-- Jeffrey
________________________________ From: miaxzhitong @.> Sent: Monday, October 2, 2023 5:58:32 PM To: Azure/azure-rest-api-specs @.> Cc: Jeffrey Richter @.>; Mention @.> Subject: Re: [Azure/azure-rest-api-specs] Add deprecation banner to Azure Maps Render V1 (PR #26022<#26022>) Hi @JeffreyRichter<https://github.com/JeffreyRichter>https://github.com/JeffreyRichter, it seems that I can add you as assignee for this PR. Do you think it will be a good workaround for now? Please let me know if you have any concern here. — Reply to this email directly, view it on GitHub<#26022 (comment)<#26022 (comment)>>, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AARLJP52PF4QVBWTIOJ5JLDX5NPLRAVCNFSM6AAAAAA5LZHOUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBTHE4TMNZRGE. You are receiving this because you were mentioned.Message ID: @.***>
Can you help to merge it so that this PR can catch the go-live batch tomorrow? Thanks so much!
—
Reply to this email directly, view it on GitHub<#26022 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AARLJP5RJMI73ULVT7S5ZXDX5OBMXAVCNFSM6AAAAAA5LZHOUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBUGEYDSMRYGI>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
* add render V1 deprecaton banner to render doc * try for adding summary * add summary to all other child pages * remove retirement banner from top overview description * fix Render V1 and V2 link * bug fix --------- Co-authored-by: Zhitong Xie <[email protected]>
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links