azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[Hub Generated] Review request for Microsoft.Devices to add version preview/2021-11-01-preview

Open dgaulton opened this issue 3 years ago • 6 comments

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

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

  • Link to engagement record issue:

Is this review for (select one):

  • [x] a private preview
  • [ ] a public preview
  • [ ] GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.

  • Design Document:
  • Previous Open API Doc:
  • Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

dgaulton avatar Aug 01 '22 17:08 dgaulton

Hi, @dgaulton 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 1 Errors, 0 Warnings failed [Detail] The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/a3bb29ac84a140dce71bde4c38f59e421ac02018/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/service.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json",
    "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.37/common/temp/node_modules/.pnpm/@[email protected]/node_modules/autorest/dist/app.js --v2 --input-file=specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/service.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/queryTrustBundles.json' not found\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/service.json:1449:12 ($.paths["/trustBundles/query"].post["x-ms-examples"]["Query the trust bundles in a DPS instance"]["$ref"])\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: [OperationAbortedException] Er"
    ️⌛CredScan pending [Detail]
    ️❌LintDiff: 3 Errors, 0 Warnings failed [Detail] The following errors/warnings are introduced by current PR:
    Rule Message
    AutoRest exception "location":"specification/deviceprovisioningservices/data-plane/readme.md",
    "tag":"package-service-preview-2021-11",
    "details":"Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/queryTrustBundles.json' not found"
    AutoRest exception "location":"specification/deviceprovisioningservices/data-plane/readme.md",
    "tag":"package-service-preview-2021-11",
    "details":"swagger-document/loader - FAILED"
    AutoRest exception "location":"specification/deviceprovisioningservices/data-plane/readme.md",
    "tag":"package-service-preview-2021-11",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    ️❌Avocado: 23 Errors, 0 Warnings failed [Detail]
    Rule Message
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/CertificateAuthority/getCertificateAuthority.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/CertificateAuthority/getCertificateAuthority.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/CertificateAuthority/createOrUpdateCertificateAuthority.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/CertificateAuthority/createOrUpdateCertificateAuthority.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/CertificateAuthority/deleteCertificateAuthority.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/CertificateAuthority/deleteCertificateAuthority.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/getIndividualEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/getIndividualEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/createOrUpdateIndividualEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/createOrUpdateIndividualEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/deleteIndividualEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/deleteIndividualEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/getGroupEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/getGroupEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/createOrUpdateGroupEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/createOrUpdateGroupEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/deleteGroupEnrollment.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/deleteGroupEnrollment.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/RegistrationState/getIndividualEnrollmentRegistrationState.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/RegistrationState/getIndividualEnrollmentRegistrationState.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/RegistrationState/deleteRegistrationState.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/RegistrationState/deleteRegistrationState.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/TrustBundle/getTrustBundle.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/getTrustBundle.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/TrustBundle/createOrUpdateTrustBundle.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/createOrUpdateTrustBundle.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/TrustBundle/deleteTrustBundle.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/deleteTrustBundle.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/CertificateAuthority/queryCertificateAuthorities.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/CertificateAuthority/queryCertificateAuthorities.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/queryIndividualEnrollments.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/queryIndividualEnrollments.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/getIndividualEnrollmentAttestation.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/getIndividualEnrollmentAttestation.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/IndividualEnrollment/bulkIndividualEnrollmentOperations.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/IndividualEnrollment/bulkIndividualEnrollmentOperations.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/queryGroupEnrollments.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/queryGroupEnrollments.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/getGroupEnrollmentAttestation.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/getGroupEnrollmentAttestation.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/GroupEnrollment/bulkGroupEnrollmentOperations.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/GroupEnrollment/bulkGroupEnrollmentOperations.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/RegistrationState/getGroupEnrollmentRegistrationStates.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/RegistrationState/getGroupEnrollmentRegistrationStates.json"})
    JSON_PARSE The file is not a valid JSON file.
    json: [examples/service/TrustBundle/queryTrustBundles.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"","message":"unexpected end of file, token: , line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/deviceprovisioningservices/data-plane/Microsoft.Devices/preview/2021-11-01-preview/examples/service/TrustBundle/queryTrustBundles.json"})
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    JSON_PARSING_ERROR Json parsing error: unexpected end of file
    Url: examples/service/CertificateAuthority/getCertificateAuthority.json#L1:1
    ️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    JSON_PARSING_ERROR Json parsing error: unexpected end of file
    JsonUrl: examples/service/CertificateAuthority/getCertificateAuthority.json#L1:1
    ️⌛PoliCheck pending [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/a3bb29ac84a140dce71bde4c38f59e421ac02018/specification/deviceprovisioningservices/data-plane/readme.md#tag-package-service-preview-2021-11">deviceprovisioningservices/data-plane/readme.md#package-service-preview-2021-11
    ️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    HowToFix Code style issues found
    path: Microsoft.Devices/preview/2021-11-01-preview/service.json
    ️️✔️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?

    Swagger Generation Artifacts

    ️⌛ApiDocPreview pending [Detail]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

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

    Hi, @dgaulton. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    ghost avatar Aug 21 '22 16:08 ghost

    Hi, @dgaulton. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    ghost avatar Sep 05 '22 05:09 ghost