Skip to content
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

[Hub Generated] Review request for Microsoft.Maps/Microsoft.Maps to add version preview/2.0 #17090

Merged
merged 60 commits into from
Dec 23, 2021

Conversation

sanil7777777
Copy link
Contributor

@sanil7777777 sanil7777777 commented Dec 14, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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

Hi, @sanil7777777 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. [email protected]

    @openapi-workflow-bot
    Copy link

    [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

    openapi-pipeline-app bot commented Dec 14, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Feedback/preview/1.0/feedback.json#L227
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1824
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1866
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1889
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1980
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Search/preview/1.0/search.json#L2086
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1106
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1129
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1159
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1186
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Dataset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Dataset/preview/2.0/dataset.json#L207
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Conversion_Convert' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: DwgConversion/preview/2.0/dwgconversion.json#L214
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Tileset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Tileset/preview/2.0/tileset.json#L227
    ⚠️ R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options. Property name: type
    Location: FeatureState/preview/2.0/featurestate.json#L838
    ⚠️ R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options. Property name: type
    Location: Search/preview/1.0/search.json#L3459
    ⚠️ R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options. Property name: geometryType
    Location: WFS/preview/2.0/wfs.json#L898
    ⚠️ R2064 - LROStatusCodesReturnTypeSchema 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_PutStateset', Response code: '200'
    Location: FeatureState/preview/2.0/featurestate.json#L336
    ⚠️ R2064 - LROStatusCodesReturnTypeSchema 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_UpdateStates', Response code: '200'
    Location: FeatureState/preview/2.0/featurestate.json#L476
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 14, 2021

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

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

    Hi @sanil7777777, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @raych1 raych1 merged commit 270ba89 into Azure:main Dec 23, 2021
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    …dd version preview/2.0 (Azure#17090)
    
    * added extra fields to JSON list data response in docs
    
    * added content-type field to request header
    
    * took out content type from header field due to errors; JSON reponse fields for user Data are ready to commit
    
    * added content-type header to userData update docs
    
    * added a change which fixed prettier check
    
    * changed name of enum
    
    * added reference to ContentType
    
    * trying to add contenttype to docs
    
    * adding content type header
    
    * trying to add content type header to userDate update docs
    
    * adding content type header to update docs
    
    * adding example parameter for new content-type request header
    
    * changed xs-parameter-location
    
    * trying to fix invalid type error
    
    * Trying to fix model error
    
    * trying new changes
    
    * Making final changes: added content type header
    
    * getting rid of content type header changes to work on a diff bug
    
    * added corresponding content types for dataFormat in upload preview
    
    * reverting changes due to unforseen model errors
    
    * adding dataFormats that correspond to content-type
    
    * was missing a quote
    
    * changed format of some wording
    
    * adding schema to swagger spec for 400 response for data upload preview
    
    * fixing changes
    
    * reverted changes
    
    * trying to remove body from response examples
    
    * adding schema to 400 response in data upload
    
    * reverting changes again
    
    * adding schema to 400 response in data upload
    
    * removed header from 400 response
    
    * adding schema
    
    * reverting all changes
    
    * trying changes
    
    * reverting again 2.0
    
    * moving responses to directions section
    
    * semantic validation changes
    
    * fixing model val errors
    
    * fixing model val errors
    
    * got rid of model val errors
    
    * fixing prettier check errors
    
    * fixing another prettier check error
    
    * fixed error code response message
    
    * removing required properties
    
    * removing unneeded definitions
    
    * fixed prettier check issues again
    
    * deleted 200 response for data update (LRO)
    
    * got rid of headers
    
    * added header back for download 200
    
    * added 200 response back to data update
    
    * added content type header into user update
    
    * fixing invalid type err
    
    * trying to fix invalid type
    
    * reverting content type header changes
    
    * adding header to 202 response
    
    * adding content type header
    
    * adding required content header type to update api
    
    * reverting cont header changes
    
    * adding clarity for which media type to use
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants