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

Published 20 hours ago • verified publisher icon Azure

Added swagger for Nexus identity service

Open ashishranjan2011 opened this issue 1 year ago • 18 comments

ARM (Control Plane) API Specification Update Pull Request

Tip: overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you, you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested is removed from your PR. This should cause the label WaitForARMFeedback to be added. [2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • [x] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix swagger quality issues in S360.
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [x] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the Swagger-Suppression-Process to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

ashishranjan2011 avatar Dec 20 '23 11:12 ashishranjan2011

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR is in purview of ARM review (label: ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app[bot] avatar Dec 20 '23 11:12 openapi-pipeline-app[bot]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️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.
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-06-15 package-2023-06-15(c373806) default(main)
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

openapi-pipeline-app[bot] avatar Dec 20 '23 11:12 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=408243&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

Posted by Swagger Pipeline | How to fix these errors?

openapi-pipeline-app[bot] avatar Dec 20 '23 11:12 openapi-pipeline-app[bot]

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.NexusIdentity https://apiview.dev/Assemblies/Review/c5d19e18594b41789b9a3fa08e0f4e6d?revisionId=f2df677b2e804f399f9a2531367600eb
TypeSpec NexusIdentity.IdentityController.Management https://apiview.dev/Assemblies/Review/1e31a6918f0743529153d02c47d9955a?revisionId=427d6f9f6ace4e09836c7bade9d69953
TypeSpec NexusIdentity.IdentitySet.Management https://apiview.dev/Assemblies/Review/1e31a6918f0743529153d02c47d9955a?revisionId=427d6f9f6ace4e09836c7bade9d69953

openapi-pipeline-app[bot] avatar Dec 20 '23 11:12 openapi-pipeline-app[bot]

Hi @ashishranjan2011! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

openapi-workflow-bot[bot] avatar Dec 20 '23 11:12 openapi-workflow-bot[bot]

Hi, @ashishranjan2011, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR
    • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    openapi-workflow-bot[bot] avatar Dec 20 '23 11:12 openapi-workflow-bot[bot]

    Hi @ashishranjan2011 This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

    openapi-workflow-bot[bot] avatar Dec 20 '23 11:12 openapi-workflow-bot[bot]

    /azp run typespec requirement

    mikeharder avatar Jan 11 '24 07:01 mikeharder

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Jan 11 '24 07:01 azure-pipelines[bot]

    Please fix lint errors

    Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.NexusIdentity/stable/2023-06-15/identityController.json#L341

    and comment on whether ProvisioningState readonly linter error is accurate, if so, fix it.

    TimLovellSmith avatar Jan 18 '24 21:01 TimLovellSmith

    I don't think the provisioningState error is accurate, in fact.

    TimLovellSmith avatar Jan 18 '24 21:01 TimLovellSmith

    /azp run

    TimLovellSmith avatar Jan 18 '24 21:01 TimLovellSmith

    Azure Pipelines successfully started running 4 pipeline(s).

    azure-pipelines[bot] avatar Jan 18 '24 21:01 azure-pipelines[bot]

    Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    This will notify the reviewer to have another look.
    If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
    Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

    openapi-workflow-bot[bot] avatar Jan 18 '24 21:01 openapi-workflow-bot[bot]

    /azp run

    ashishranjan2011 avatar Jan 21 '24 17:01 ashishranjan2011

    Commenter does not have sufficient privileges for PR 27147 in repo Azure/azure-rest-api-specs

    azure-pipelines[bot] avatar Jan 21 '24 17:01 azure-pipelines[bot]

    Hi @ashishranjan2011 This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

    Has this point already been addressed ? Is this RP onboarded to rpaas or does it have an exception ? If its already onboarded to rpaas is there a spec in the private repo ?

    raosuhas avatar Jan 22 '24 20:01 raosuhas

    Are you directly creating a stable version without any preview versions ?

    raosuhas avatar Jan 22 '24 20:01 raosuhas

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

    microsoft-github-policy-service[bot] avatar Feb 12 '24 01:02 microsoft-github-policy-service[bot]