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.

Sign up for GitHub

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

Jump to bottom

[Hub Generated] Review request for Common to add version preview/1.0 #16626

Merged
merged 2 commits into from
Nov 12, 2021
Merged

[Hub Generated] Review request for Common to add version preview/1.0 #16626

merged 2 commits into from
Nov 12, 2021

Conversation

stack111
Copy link
Contributor

@stack111 stack111 commented Nov 1, 2021 •
edited
Loading

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, @stack111 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 Nov 1, 2021 •
    edited
    Loading

    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:

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

    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
    ❌ 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
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Creator/preview/2.0/wfs.json#L661
    ⚠️ 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
    ⚠️ 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
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' 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: Creator/preview/2.0/alias.json#L98
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' 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: Creator/preview/2.0/alias.json#L135
    ️️✔️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 Nov 1, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-creator - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-elevation - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-geolocation - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-render - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-route - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-search - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-timezone - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-traffic - first release
    ️✔️azure-sdk-for-python-track2 - track2_azure-maps-weather - first release
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5d66051. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-11-12 20:23:31 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs]Release - Generate from 5d66051. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
warn		specification/maps/data-plane/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk
warn		specification/maps/data-plane/Search/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Creator/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] FATAL: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'GeoJsonObjectType' and different values: Point,MultiPoint,LineString,MultiLineString,Polygon,MultiPolygon,GeometryCollection,Feature,FeatureCollection vs. FeatureCollection
cmderr	[Autorest]    at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/ObjectBuilder.cs:line 150
cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 217
cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 48
cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 133
cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 348
cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 66
cmderr	[Autorest]    at AutoRest.Modeler.Program.<ProcessInternal>d__2.MoveNext() in /opt/vsts/work/1/s/src/Program.cs:line 60
cmderr	[Autorest] --- End of stack trace from previous location where exception was thrown ---
cmderr	[Autorest]    at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
cmderr	[Autorest]    at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
cmderr	[Autorest]    at NewPlugin.<Process>d__15.MoveNext()
cmderr	[Autorest] FATAL: csharp/imodeler1 - FAILED
cmderr	[Autorest] FATAL: Error: Plugin imodeler1 reported failure.
cmderr	[Autorest]   Error: Plugin imodeler1 reported failure.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/DEM/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Geolocation/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Render/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Route/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Timezone/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Traffic/readme.md
warn	Skip command for failed context: autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Weather/readme.md
warn	Skip package processing as generation is failed
    Posted by Swagger Pipeline | How to fix these errors?

    @stack111 stack111 requested a review from ambientlight November 1, 2021 21:04
    @stack111
    Copy link
    Contributor Author

    stack111 commented Nov 1, 2021

    @ambientlight https://review.docs.microsoft.com/en-us/rest/api/documentation-preview/render-v2/get-map-tile?view=azure-rest-preview&branch=result_9de8bbaf-f729-4a73-b49c-ff58d1fac561#security

    Do you know if the name of the security definition entry must be the name of the header or can I rename Authorization -> SAS Token and it would be more appropriate or if the convenience layer will handle this?
    image

    @stack111 stack111 marked this pull request as ready for review November 2, 2021 16:53
    @ambientlight
    Copy link
    Member

    Do you know if the name of the security definition entry must be the name of the header or can I rename Authorization -> SAS Token and it would be more appropriate or if the convenience layer will handle this?

    @stack111: You can rename the SasToken name to a desirable one, since SasToken is a non-standard securityDefinition, it won't be validated and thus far will be ignored altogether: https://github.com/Azure/autorest/blob/b4b157b02050d590f0dc1e589e7947e5c1fed52b/packages/extensions/modelerfour/src/modeler/security-processor.ts#L160

    This was referenced Nov 4, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @stack111 stack111 requested a review from ambientlight November 8, 2021 18:02
    @stack111
    Copy link
    Contributor Author

    @jhendrixMSFT let me know if you have any additional feedback for this PR.

    @jhendrixMSFT jhendrixMSFT merged commit 5d66051 into Azure:main Nov 12, 2021
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Nov 12, 2021
    Closed
    This was referenced Nov 12, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @stack111 stack111 deleted the dev-maps-security-definition branch December 20, 2021 00:57
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @LeiWang3
    [Hub Generated] Review request for Common to add version preview/1.0 (A…
    2f62662 
    …zure#16626)

* corrects security definitions and adds SAS

* pr feedback
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ambientlight ambientlight ambientlight approved these changes

    @jhendrixMSFT jhendrixMSFT jhendrixMSFT approved these changes

    Assignees

    @jhendrixMSFT jhendrixMSFT

    Labels
    FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @stack111 @ambientlight @jhendrixMSFT