Skip to content

[Schema Registry] Update swagger#16738

Merged
lmazuel merged 9 commits intoAzure:mainfrom
deyaaeldeen:schemaregistry/remove-415
Nov 12, 2021
Merged

[Schema Registry] Update swagger#16738
lmazuel merged 9 commits intoAzure:mainfrom
deyaaeldeen:schemaregistry/remove-415

Conversation

@deyaaeldeen
Copy link
Copy Markdown
Member

@deyaaeldeen deyaaeldeen commented Nov 10, 2021 •
edited
Loading

Right now, 415 response does not have a schema and is not marked as an error, so this PR removes it.

Add a schema to 415 responses and mark them as errors.

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

  • 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.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-workflow-bot
Copy link
Copy Markdown

openapi-workflow-bot bot commented Nov 10, 2021

Hi, @deyaaeldeen 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app bot commented Nov 10, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L163:9
    Old: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L171:11
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L216:9
    Old: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L230:11
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L315:9
    Old: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L325:11
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SchemaGroupsModel'. Consider using the plural form of 'SchemaGroups' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.EventHub/stable/2021-10/schemaregistry.json#L41
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ INVALID_CONTENT_TYPE Invalid Content-Type (application/json). These are supported: application/json; serialization=Avro
    ❌ INVALID_TYPE Expected type file but found type string
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️🔄CredScan inProgress [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    openapi-workflow-bot bot commented Nov 10, 2021

    [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.

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app bot commented Nov 10, 2021 •
    edited
    Loading

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

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    openapi-workflow-bot bot commented Nov 10, 2021

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    openapi-workflow-bot bot commented Nov 10, 2021

    Hi @deyaaeldeen, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    @deyaaeldeen deyaaeldeen changed the title [Schema Registry] Remove 415 response [Schema Registry] Add a schema to 415 responses Nov 10, 2021
    @deyaaeldeen deyaaeldeen mentioned this pull request Nov 10, 2021
    Merged
    @deyaaeldeen
    Copy link
    Copy Markdown
    Member Author

    deyaaeldeen commented Nov 10, 2021

    @JoshLove-msft JS works with the current change, see Azure/azure-sdk-for-js#18629

    @conniey conniey mentioned this pull request Nov 11, 2021
    Merged
    6 tasks
    @openapi-workflow-bot
    Copy link
    Copy Markdown

    openapi-workflow-bot bot commented Nov 12, 2021

    Hi @deyaaeldeen, 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.

    @deyaaeldeen deyaaeldeen changed the title [Schema Registry] Add a schema to 415 responses [Schema Registry] Update swagger Nov 12, 2021
    @deyaaeldeen deyaaeldeen mentioned this pull request Nov 12, 2021
    Merged
    nickghardwick
    nickghardwick approved these changes Nov 12, 2021
    View reviewed changes
    Copy link
    Copy Markdown
    Contributor

    @nickghardwick nickghardwick left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Changes will be made on service side to reflect this update.

    @deyaaeldeen
    Copy link
    Copy Markdown
    Member Author

    deyaaeldeen commented Nov 12, 2021

    @lmazuel this change has been discussed with the service team and we would like to merge it.

    @lmazuel lmazuel merged commit c268c73 into Azure:main Nov 12, 2021
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @deyaaeldeen @Leiwang3SQL
    [Schema Registry] Update swagger (Azure#16738)
    0bb1339 
    * [Schema Registry] Remove 415 response

* add 415 back with a schema

* address feedback

* no need to update the default case

* add x-ms-error-code headers back because the guidelines require them

* update the patterns

* factor schema name parameter into one definition

* add an example for 415

* update examples
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @lmazuel lmazuel lmazuel approved these changes

    @JoshLove-msft JoshLove-msft JoshLove-msft approved these changes

    @hmlam hmlam Awaiting requested review from hmlam hmlam is a code owner

    @conniey conniey Awaiting requested review from conniey conniey is a code owner

    @yunhaoling yunhaoling Awaiting requested review from yunhaoling

    @swathipil swathipil Awaiting requested review from swathipil swathipil is a code owner

    +1 more reviewer

    @nickghardwick nickghardwick nickghardwick approved these changes

    Reviewers whose approvals may not affect merge requirements

    Assignees

    @lmazuel lmazuel

    @anuchandy anuchandy

    Labels

    CI-FixRequiredOnFailure

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    5 participants

    @deyaaeldeen @lmazuel @nickghardwick @JoshLove-msft @anuchandy