-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Swagger correctness fix: add location property to RedisPatchSchedule … #17699
Swagger correctness fix: add location property to RedisPatchSchedule … #17699
Conversation
Hi, @koderjoker 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 |
Swagger Validation Report
|
Rule | Message |
---|---|
1045 - AddedOptionalProperty |
The new version has a new optional property 'location' that was not found in the old version. New: Microsoft.Cache/stable/2020-12-01/redis.json#L2423:7 Old: Microsoft.Cache/stable/2020-12-01/redis.json#L2423:7 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.1 )
- Linted configuring files (Based on target branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.1 )
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2020-12-01/redis.json#L68 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Redis_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L172 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Redis_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L236 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Redis_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L345 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'FirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L828 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'FirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L899 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PatchSchedules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1067 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PatchSchedules_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1208 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'LinkedServer_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1273 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'LinkedServer_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1399 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1562 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Put' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1613 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2320 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L37 |
R4037 - MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1781 |
R4037 - MissingTypeObject |
The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1821 |
R4037 - MissingTypeObject |
The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1943 |
R4037 - MissingTypeObject |
The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1975 |
R4037 - MissingTypeObject |
The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1990 |
R4037 - MissingTypeObject |
The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2070 |
R4037 - MissingTypeObject |
The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2106 |
R4037 - MissingTypeObject |
The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2123 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2138 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2164 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2181 |
R4037 - MissingTypeObject |
The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2198 |
R4037 - MissingTypeObject |
The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2223 |
R4037 - MissingTypeObject |
The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2261 |
R4037 - MissingTypeObject |
The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2278 |
R4037 - MissingTypeObject |
The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L2298 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️❌
ModelValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
XMS_EXAMPLE_NOTFOUND_ERROR |
x-ms-example not found in Operations_List. Url: Microsoft.Cache/stable/2020-12-01/redis.json#L38:14 |
️️✔️
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
️️✔️
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).
[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 Generation Artifacts
|
NewApiVersionRequired reason: |
Hi @koderjoker, Your PR has some issues. Please fix the CI sequentially by following the order of
|
…and update response examples
e85ea3e
to
ed429fc
Compare
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@msyyc just like #17687, the section for which required checks for Model Validation are failing aren't part of the changes in my PR. The same issue occurred in a previous PR as well #17447, but in that case it wasn't marked as required. Could you please ignore the failing required check 'Swagger ModelValidation' and merge in my pull request? We've got the breaking change label and need to urgently merge in this change to meet the deadline for swagger issues. This failing check could be resolved later in another PR. |
…and update response examples (Azure#17699) Co-authored-by: Kanchan Joshi <kanchanjoshi@microsoft.com>
…and update response examples
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:
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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.