Microsoft.HanaOnAzure swagger: Update spec to add missing fields #14879
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
Add HanaSID array to StorageProfile properties
|
Hi, @lagalbra 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 new version has a new read-only property 'isDataAction' in response that was not found in the old version. New: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L823:7 Old: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L790:7 |
|
The new version has a new property 'hanaSids' in response that was not found in the old version. New: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L740:7 Old: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L714:7 |
|
The new version has a new optional property 'hanaSids' that was not found in the old version. New: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L740:7 Old: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L714:7 |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L833 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L922 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L490 |
|
The schema 'HanaInstancesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L522 |
|
The schema 'HanaInstance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L538 |
|
The schema 'HanaInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L553 |
|
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L623 |
|
The schema 'Disk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L693 |
|
The schema 'StorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L739 |
|
The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L762 |
|
The schema 'NetworkProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json#L783 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"hanaonazure/resource-manager/readme.md",
"tag":"package-2017-11",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hanaonazure/resource-manager/readme.md",
"tag":"package-2017-11",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"hanaonazure/resource-manager/readme.md",
"tag":"package-2017-11",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
This was referenced Jun 17, 2021
This was referenced Jun 17, 2021
|
@raych1 I see the "NewApiVersionRequired" tag was added, but as noted in the PR description, the changes in this PR are limited to fixing S360 issues - let me know if this is an issue with getting this PR merged. |
|
@jianyexi I see the "NewApiVersionRequired" tag was added, but as noted in the PR description, the changes in this PR are limited to fixing S360 issues - let me know if this is an issue with getting this PR merged. |
|
Hi @lagalbra, 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. |
|
@jianyexi Have created intake: https://msazure.visualstudio.com/One/_workitems/edit/10205315 Business justification: This change is to resolve an S360 alert on a preview API: https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/9843576 Will attend office hours next week to review this intake. Let me know if there's anything else I can do to expedite this PR. |
Follow the action on #14879 (comment) , and clarify that you are fixing S360 issue in the intake. |
JeffreyRichter
added
the
Approved-BreakingChange
|
@jianyexi FYI I attended office hours today, and confirmed with Jeffrey that this change can be approved as it is addressing an S360 |
could you fix the LintDiff violation ? It will not introduce breaking change . |
This was referenced Jul 1, 2021
Done; LintDiff check is now green. |
jianyexi
approved these changes
Jul 5, 2021
This was referenced Jul 5, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…re#14879) * Microsoft.HanaOnAzure swagger: Update spec with missing fields from RP Add HanaSID array to StorageProfile properties * Update ListOperations API to include isDataAction field * Add examples for HanaSID field * correct bool to boolean * Fix LintDiff error introduced by this PR
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
Please ensure to add changelog with this PR by answering the following questions.
- N/A
- N/A
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.