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

Created common type v4 where changed string to uuid

Open abatishchev opened this issue 3 years ago • 17 comments

What has been changed:

  1. Update the subscription parameter to use format “uuid”
  2. Update the Id property to use format “arm-id”
  3. Update the Tenant property to use format “uuid”
  4. Update the PrincipalId property use format “uuid”

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
    • [x] 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 language SDKs and CLIs that must be refreshed after the swagger is published.
    • [x] SDK of .NET (need service team to ensure code readiness)
    • [x] SDK of Python
    • [x] SDK of Java
    • [x] SDK of Js
    • [x] SDK of Go
    • [x] PowerShell
    • [x] CLI
    • [x] 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: :warning:

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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • [ ] 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.

abatishchev avatar Jul 25 '22 18:07 abatishchev

Hi, @abatishchev 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: 10 Errors, 0 Warnings failed [Detail]
    Rule Message
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L205:9
    Old: common-types/resource-management/v3/types.json#L204:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L211:9
    Old: common-types/resource-management/v3/types.json#L209:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L14:9
    Old: common-types/resource-management/v3/types.json#L14:9
    BreakingChangeToolException "details":""errno":-21,
    "syscall":"read",
    "code":"EISDIR""
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

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

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

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Jul 28 '22 01:07 azure-pipelines[bot]

    Hi, @abatishchev. 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 14 '22 16:08 ghost

    hi @raych1 and @jianyexi,

    Since @JeffreyRichter and @m-nash don't have objections, can you please re-review the PR? Thanks!!

    abatishchev avatar Aug 31 '22 00:08 abatishchev

    @jianyexi, @raych1, @akning-ms ping, please

    abatishchev avatar Sep 09 '22 00:09 abatishchev

    Could you update the v3 reference to v4 in the other swaggers under https://github.com/Azure/azure-rest-api-specs/tree/0f31358af120f2f43a67e904f11df553fe51d0a7/specification/common-types/resource-management/v4, or it will cause the breaking change conflict

    jianyexi avatar Sep 09 '22 05:09 jianyexi

    @jianyexi sorry, can you please clarify what should I do?

    abatishchev avatar Sep 13 '22 00:09 abatishchev

    @abatishchev I mean the reference should be replaced with v4/types.json https://github.com/Azure/azure-rest-api-specs/blob/0f31358af120f2f43a67e904f11df553fe51d0a7/specification/common-types/resource-management/v4/privatelinks.json#L122

    jianyexi avatar Sep 13 '22 03:09 jianyexi

    @jianyexi ah, got it. Done!

    abatishchev avatar Sep 13 '22 17:09 abatishchev

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

    Hi, @abatishchev. 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 Oct 02 '22 16:10 ghost

    @jianyexi ping on this PR, please.

    abatishchev avatar Oct 11 '22 19:10 abatishchev

    @jianyexi ping on this PR, please.

    abatishchev avatar Oct 18 '22 16:10 abatishchev

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @akning-ms please re-review.

    abatishchev avatar Oct 25 '22 16:10 abatishchev