Remove scope from marketplace registration definitions operations #12397
Conversation
|
Hi, @skayani Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L425:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L503:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.ManagedServices/stable/2019-09-01/managedservices.json#L425:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.ManagedServices/stable/2019-09-01/managedservices.json#L503:5 |
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
|
Hi @skayani, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
NewApiVersionRequired reason: |
|
The 'scope' part of the URI path that was removed is optional for marketplace registration definition operations. Initially I tried replacing the 'scope' parameter with a new 'optionalScope' parameter that was required=false but this lead to semantic validation errors so I believe this is the right approach. Please correct me if I'm wrong. |
| @@ -380,17 +380,14 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions": { | |||
There was a problem hiding this comment.
suggest to have {scopeOptional} as this API supports tenant and subscription level as well.
There was a problem hiding this comment.
agree with removing; as I see for operations API also we have removed it.
|
Hi @skayani we need to go through the breaking change review because this PR is introducing breaking changes. You could find the guidance in a comment by @openapi-workflow-bot |
I've gone ahead and done that, thanks |
|
Hi @ArcturusZhang , I wanted to ask this question directly to you as in case I don't get a response from the Swagger tools team alias. Here it is: I tried looking for this in the docs but couldn't find a similar scenario. For our service we have these Azure resource types called Registration Definitions (RDs). We allow our users to retrieve RDs for a particular scope or for an entire tenant. This means our service allows for the following GET RDs URIs:
Since according to the Swagger docs, we can't have an {optionalScope} parameter (i.e. we cannot have a parameter in the path that is required=false), what is the next best course? Do we specify the above two as two separate Swagger paths (even though they return the same type of result)? Is there a better option? |
JeffreyRichter
added
the
Approved-BreakingChange
skayani
added
the
DoNotMerge
taking the existing examples, we need to have both of these paths in swagger. We have some similar cases in the policy swaggers. It is not exactly the same but quite similar |
|
Hi @skayani, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
removed
BreakingChangeReviewRequired
CI-FixRequiredOnFailure
labels
skayani
removed
the
DoNotMerge
|
@ArcturusZhang Hey, I've gone ahead and added two paths for our marketplaceRegistrationDefinitions endpoints. I initially received breaking changes approval for removing scope. Will the breaking changes approval still apply to this PR? |
…ure#12397) * Remove scope from marketplace registration definitions operations * Swagger fixes * Changed operation ids * Validation fixes * Unique x-ms-example names * Name fix for examples * Removed sub from example responses * Added empty eligibleAuths to 2020-02-01-preview MRD examples
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
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.