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

deviceprovisioningservices: updating the Swagger Tags to match the Operation ID Prefix #20106

Merged
merged 1 commit into from
Aug 8, 2022
Merged

deviceprovisioningservices: updating the Swagger Tags to match the Operation ID Prefix #20106

merged 1 commit into from
Aug 8, 2022

Conversation

tombuildsstuff
Copy link
Contributor

This means that when grouped these are grouped by Type (Certificate, IotDpsResource) rather than by HTTP Methdod (GET/PUT/PATCH etc).

Before this change these are output as:

Screenshot 2022-08-04 at 07 37 47

With this commit, these are now grouped into:

  • dpscertificate
  • iotdpsresource

@tombuildsstuff
deviceprovisioningservices: updating the Swagger Tags to match the Op…
7833e20 
…eration ID Prefix

This means that when grouped these are grouped by Type (Certificate, IotDpsResource) rather than by GET/PUT/PATCH etc which is less useful.
@openapi-workflow-bot
Copy link

Hi, @tombuildsstuff 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 Aug 4, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    iotdps.json 2022-02-05(7833e20) 2022-02-05(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⌛CredScan pending [Detail]
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-02 package-2022-02(7833e20) package-2022-02(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L64
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L135
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L208
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L349
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L400
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L471
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L596
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L650
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L687
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L737
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L809
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L860
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L994
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1141
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1187
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1238
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1299
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1342
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1389
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1433
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1480
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1541
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1610
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L529
    ❌ R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Devices/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L40
    ❌ R4019 - GetCollectionResponseSchema The response in the GET collection operation 'IotDpsResourceListPrivateEndpointConnections' does not match the response definition in the individual GET operation 'IotDpsResourceGetPrivateEndpointConnection' .
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L1399
    ❌ R4032 - MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L593
    ❌ R4035 - PrivateEndpointResourceSchemaValidation The private endpoint model 'PrivateEndpointConnectionsList' schema does not conform to the common type definition.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L2063
    ❌ R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L2202
    ❌ R4037 - MissingTypeObject The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Devices/stable/2022-02-05/iotdps.json#L2238
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/7833e204c68f0d32ddd2a341a171f5a35cda6f1a/specification/deviceprovisioningservices/resource-manager/readme.md#tag-package-2022-02">deviceprovisioningservices/resource-manager/readme.md#package-2022-02
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"deviceprovisioningservices/resource-manager/readme.md",
    "tag":"package-2022-02",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ⚠️ SecurityDefinedSpecAndConfig "readme":"deviceprovisioningservices/resource-manager/readme.md",
    "tag":"package-2022-02",
    "details":"OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used."
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 4, 2022 •
    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-go - armdeviceprovisioningservices - 1.0.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-iothubprovisioningservices - 1.1.0
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs]Release - Generate from f840c84. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/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] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f840c84. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.16.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.16.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.16.0` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-iothubprovisioningservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added model ErrorMessage
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f840c84. 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] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
cmderr	[generate.py] [ForkJoinPool-1-worker-5] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
cmderr	[generate.py] [ForkJoinPool-1-worker-1] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
cmderr	[generate.py] [ForkJoinPool-1-worker-7] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
cmderr	[generate.py] [ForkJoinPool-1-worker-7] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
    • ️✔️azure-resourcemanager-deviceprovisioningservices [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f840c84. SDK Automation 14.0.0 
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armdeviceprovisioningservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f840c84. SDK Automation 14.0.0 
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-deviceprovisioningservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ProvisioningServiceDescription
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f840c84. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
    • ️✔️deviceprovisioningservices [View full logs] 
    ️❌ azure-powershell failed [Detail]
    • ❌Failed [Logs]Release - Generate from f840c84. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ❌Az.deviceprovisioningservices [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 4, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-iothubprovisioningservices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Java azure-resourcemanager-deviceprovisioningservices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    JavaScript @azure/arm-deviceprovisioningservices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Aug 4, 2022
    @ghost
    Copy link

    ghost commented Aug 4, 2022

    Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.

    @tombuildsstuff tombuildsstuff mentioned this pull request Aug 4, 2022
    Merged
    @azure-sdk azure-sdk mentioned this pull request Aug 4, 2022
    Closed
    @tombuildsstuff tombuildsstuff mentioned this pull request Aug 4, 2022
    Closed
    This was referenced Aug 4, 2022
    Closed
    Closed
    Closed
    Closed
    @live1206 live1206 merged commit f840c84 into Azure:main Aug 8, 2022
    This was referenced Aug 8, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    @tombuildsstuff tombuildsstuff deleted the f/fixing-dps-swagger-ids branch August 8, 2022 04:43
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @live1206 live1206 live1206 approved these changes

    Assignees

    @live1206 live1206

    Labels
    customer-reported Issues that are reported by GitHub users external to the Azure organization. resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @tombuildsstuff @live1206