Skip to content

[Azure App Configuration] Update swagger to include LRO header for snapshot create.#22840

Merged
jhendrixMSFT merged 3 commits intoAzure:mainfrom
jimmyca15:user/jimmyca/appConfigurationLro
Mar 2, 2023
Merged

[Azure App Configuration] Update swagger to include LRO header for snapshot create.#22840
jhendrixMSFT merged 3 commits intoAzure:mainfrom
jimmyca15:user/jimmyca/appConfigurationLro

Conversation

@jimmyca15
Copy link
Member

@jimmyca15 jimmyca15 commented Feb 28, 2023

Update swagger to include LRO header for snapshot create.

@jimmyca15 jimmyca15 requested a review from a team as a code owner February 28, 2023 23:31
@jimmyca15 jimmyca15 requested review from JeffreyRichter and johanste and removed request for a team February 28, 2023 23:31
@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Feb 28, 2023

Hi, @jimmyca15 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    appconfiguration.json 2022-11-01-preview(cf3c334) 2022-11-01-preview(main)
    Rule Message
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'status_code' from the old version.
    Old: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L642:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'status_code' from the old version.
    Old: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L766:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'status_code' from the old version.
    New: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1862:7
    Old: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1863:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'status_code' renamed or removed?
    New: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1557:7
    Old: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1552:7
    ❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L839:7
    Old: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L839:7
    ️️✔️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.0.0) new version base version
    package-2022-11-01-preview package-2022-11-01-preview(cf3c334) package-2022-11-01-preview(main)

    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1732
    ❌ XmsParameterLocation The parameter 'ApiVersion' 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.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1798
    ❌ HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L1890
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L12
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L17
    ⚠️ OperationId OperationId for get method on a collection should contain 'List'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L17
    ⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L37
    ⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L52
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L62
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L64
    ⚠️ SchemaTypeAndFormat Schema with type: integer should specify format
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L64
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L84
    ⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L101
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L114
    ⚠️ ErrorResponse Error response should have a schema.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L123
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L123
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L135
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L140
    ⚠️ OperationId OperationId for get method on a collection should contain 'List'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L140
    ⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L166
    ⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L177
    ⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L190
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L200
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L202
    ⚠️ SchemaTypeAndFormat Schema with type: integer should specify format
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L202
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L222
    ⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L245
    ⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L256
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L267
    ⚠️ ErrorResponse Error response should have a schema.
    Location: Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json#L276
    ️️✔️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]
    ️️✔️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.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023 •
    edited
    Loading

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.AppConfiguration https://apiview.dev/Assemblies/Review/8ec43be5ee564a2bb3b9fcd019876497

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane labels Mar 1, 2023
    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Mar 1, 2023

    Hi @jimmyca15, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 1, 2023
    @jimmyca15
    Copy link
    Member Author

    jimmyca15 commented Mar 2, 2023

    @jhendrixMSFT Can you merge this? Not sure if I need to sign-off in some way.

    @jhendrixMSFT jhendrixMSFT merged commit c31a6ff into Azure:main Mar 2, 2023
    @HarshaNalluru HarshaNalluru mentioned this pull request Mar 16, 2023
    Merged
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    @jimmyca15 @aviyerMSFT
    [Azure App Configuration] Update swagger to include LRO header for sn…
    679709b 
    …apshot create. (Azure#22840)

* Update swagger to include LRO header for snapshot create.

* Remove x-ms-long-running-operation-options as they may be unnecessary.

* Remove status_code as it is now covered via LRO status object.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @johanste johanste Awaiting requested review from johanste johanste was automatically assigned from Azure/api-stewardship-board

    Assignees

    @jhendrixMSFT jhendrixMSFT

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    5 participants

    @jimmyca15 @JeffreyRichter @jhendrixMSFT @AzureRestAPISpecReview @mikekistler