Updating response objects of Provider level APIs (Pure Proxy RTs) #23650
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
|
Hi, @poshett 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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| elastic.json | 2023-02-01-preview(afcef51) | 2023-02-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-02-01-preview | package-2023-02-01-preview(afcef51) | package-2023-02-01-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2015 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2449 |
||
| Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2454 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2466 |
|
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2474 |
| The summary and description values should not be same. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1424 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1544 |
|
| Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1758 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1806 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L1873 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2051 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2055 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2059 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2110 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2213 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Elastic/preview/2023-02-01-preview/elastic.json#L2386 |
️️✔️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.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @poshett, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Apr 20, 2023
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @poshett, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
AzureRestAPISpecReview
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
@poshett - Please fill in the correct checkboxes in the first comment so we can get a quick overview of what's going on with this PR and make sure you've understood the relevant linked docs. |
|
PR has breaking changes that have not been approved yet. |
sjanamma
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
sjanamma
reviewed
Apr 24, 2023
...ification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/elastic.json
Show resolved
Hide resolved
mikekistler
reviewed
Apr 24, 2023
Comment on lines
+2011
to
+2029
| "ElasticVersionListFormat": { | ||
| "description": "Elastic Version List Format", | ||
| "type": "object", | ||
| "properties": { | ||
| "properties": { | ||
| "$ref": "#/definitions/ElasticVersionListProperties" | ||
| } | ||
| } | ||
| }, | ||
| "ElasticVersionListProperties": { | ||
| "description": "Elastic Version Properties", | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "description": "Available elastic version of the given region", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, |
There was a problem hiding this comment.
Can you explain what all this extra structure is needed? From what I can see, the information content of each list item is exactly the same -- a version string. Why is it necessary to bury that two levels deep in an object?
There was a problem hiding this comment.
Hey, for list/get apis rpaas has suggested to use value and nextLink where value is an array of objects where in to define any parameter or property other than id, name and type needs to be inside properties object otherwise rpaas throws an invalid response payload error. I did tried that in the previous pr but it created issues.
Here is the link to the doc: https://armwiki.azurewebsites.net/rpaas/rpaasextensionapi.html#listcollection-get:~:text=forwarded%20to%20ARM.-,Response%20Body,-The%20whole%20payload
mikekistler
added
the
Approved-BreakingChange
sjanamma
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
tadelesh
added
the
Approved-SdkBreakingChange-Go
zedy-wj
approved these changes
Apr 25, 2023
msyyc
approved these changes
Apr 25, 2023
|
|
This was referenced Apr 25, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…ure#23650) * Updating UserApiKeyResponse and ElasticVersionsListResponse for properties * Updating UserApiKeyResponse * Updating ElasticVersionsListResponse * Fixing PrettierCheck * Fixing PrettierCheck from ElasticVersionsListResponseProperties * Adding x-ms-pageable in elasticVersions * Adding nextLink in ElasticVersionsListResponse * Removing nextLink from ElasticVersionsListResponseProperties * updated response for elasticVersions API * prettier fix * prettier fix elasticversions_list * Added description to ElasticVersionsListResponse * added description to all objects --------- Co-authored-by: Rhea Hooda <[email protected]>
11 tasks
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.