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.

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

Quota API extension model for Quota RP (New RP providing Capacity RP's quota APIs as ARM extension) #13623

Merged
merged 198 commits into from
Jun 18, 2021
Merged

Quota API extension model for Quota RP (New RP providing Capacity RP's quota APIs as ARM extension) #13623

merged 198 commits into from
Jun 18, 2021

Conversation

rahuls-microsoft
Copy link
Member

@rahuls-microsoft rahuls-microsoft commented Mar 25, 2021

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.

  1. What's the purpose of the update?
    • [ x] new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • [ x] SDK of .NET (need service team to ensure code readiness)
    • [ x] SDK of Python
    • SDK of Java
    • [x ] SDK of Js
    • [ x] SDK of Go
    • [ x] PowerShell
    • [ x] CLI
    • [ x] Terraform
    • No, no need to refresh 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

  • 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.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • 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 Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

rahuls-microsoft and others added 30 commits June 4, 2020 15:42
…pportTicketAction.

2. Removing state=enabledForPreview.
3. Updating Example.
…20-10-01-preview/reservations.json, which matches the previous SDK release.

2. Documentation changes.
…ONE quota request, so changing quotas to quota.
Copy link
Contributor

@j5lim j5lim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved from ARM side.

@j5lim j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Jun 11, 2021
@rahuls-microsoft
Copy link
Member Author

rahuls-microsoft commented Jun 11, 2021

Hi SDK team,
When we merge can the swagger?
Please let me know, if anything else is required from myside?
Thanks.

@rahuls-microsoft
Copy link
Member Author

Please Let's know, how we can get the sdks and share with private preview users.

@rahuls-microsoft
Copy link
Member Author

@qiaozha Please let me know, if Anything is needed from myside to merge the swagger to master?
We need swagger merged to publish the ARM manifest.
Thanks.

@rahuls-microsoft
Copy link
Member Author

@jianyexi When can we merge the PR?
We have to proceed with SDK and PLR team to create the SDKs.
Please prioritize the merging, as we are blocked on this step. The ARM team has approved the swagger.
Please let me know, if anything else is remaining from our side?
Thanks.

@jianyexi jianyexi merged commit a6302e8 into Azure:master Jun 18, 2021
asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
…s quota APIs as ARM extension) (Azure#13623)

* 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction.
2. Removing state=enabledForPreview.
3. Updating Example.

* Updating Provider name in example.

* Capacity RP Quota APIs for GA

* Adding preview version to stable dir as base files.

* Files from preview version, which will be removed.

* Updating to GA Version.

* 1. Updated reservation version tag to - Microsoft.Capacity/preview/2020-10-01-preview/reservations.json, which matches the previous SDK release.
2. Documentation changes.

* Documentation updates for put and patch request, which includes only ONE quota request, so changing quotas to quota.

* Update documenation for put.

* Doc update.

* Adding -preview tag for GO sdk.

* Updating Go settings for output folder to be -preview.

* Adding preview subdir for GO package.

* Adding preview subdir to Go sdk path.

* Removing tag - tag: package-2020-10-25-preview

* introduce a new tag to keep the go sdk package unchanged

* Revert "introduce a new tag to keep the go sdk package unchanged"

This reverts commit 8f58d34.

* Adding Azure CLI readme configuration.

* Updating the ReadMe configurations.

* Updating readme.md

* Removing duplicate cli: tag.

* Fixing build issues.

* Removing Parameter alias.

* cli config changes.

* Updating the package name to reservation.

* Updates - removin .az.md.

* Updating Example names to be unique for Get PUT

* Adding operations and python-sdk-output-folder.

* Updates.

* Removing unused file.

* Revert "Removing unused file."

This reverts commit 4f763bd.

* Revert "Revert "Removing unused file.""

This reverts commit 60c520e.

* Add reference to python readme.md file.

* Adding python readme file.

* Adding Operations for test-scenario

* Adding split

* Disabling few operation, which is not needed.

* Removing split for Operation

* Disabling the reservation Operations.

* Disable reservation operations.

* Revert "Disable reservation operations."

This reverts commit d98cbcb.

* Adding client-subscription-bound: false

* Adding Quota Extension Model APIs and examples.

* Updating Batch Example.

* Updatng Quota Dimensions model.

* Model Updates.

* Updated examples and backup.

* Updating examples to flat file structure.

* Updating data model for quotaMetaData.

* Removing backup files.

* Updating quota,json.

* Fixing examples.

* Fixing enum definition.

* Addind systemData to response.

* Updated atch example.

* Remove blank line.

* Fixing path for types.json

* Running prettier

* Removing systemData.

* Updating readonly falg.

* Changing API version to preview-2021-03-15 to address INCONSISTENT_API_VERSION.

* Updating RP name to Quota

* Updating API version to 2021-03-15-preview

* Adding other SDKs build configuration

* Updating name to Quota.

* Updating API version - 2021-03-15-preview to 2021-03-15.
To address INCONSISTENT_API_VERSION

* Updating and adding version to stable and preview.

* Updates to config.

* Adding Ruby to config.

* Config Updates.

* Update

* Update.

* Adding supression.
Fix it later as needed.

* Updating for warnings.

* Prettier check fix.

* Updating build settings.

* Temp fix for permission issue. Pointing to existing reservations dir.
Change it back to -
  output-folder: $(csharp-sdks-folder)/quota/Microsoft.Azure.Management.Quota/src/Generated

* fixing readme.md.

* Removing conflict with reservation.

* setting -preview to default.

* remove -preview tag.

* Spliting variable path APIs and fixed path APIS.

* Spliting the extension and non extension APIs.

* Prettier fix.

* Fixing examples.

* Running prettier.

* Adding definion to duplicate file.

* Adding definitios.

* Reference to new file.

* pdating to stable version.

* Removing preview version files.

* Removing Preview version from readme.md.

* Removing preview version.

* Removing Preview version.

* Updating Batch Sample.

* Adding rescourceQuery and resourceQueryUri to quota dimensions.

* Removing resourceQueryUri.

* Remove quotaMetadata API and examples.

* Add update for metadata API and preview version.

* Adding Preview version API.

* Preview version.

* Updating preview version.

* Updating Preview version.

* Adding resourceUsagesApiTemplate to get resource usages.

* Adding resourceUsagesApiTemplate.

* run Prettier.

* Adding resourceUsagesApiTemplate to stable version.

* Updating example.

* Moving resourceUsagesApiTemplate at resourceType level.

* Prettier check.

* Updating examples.

* Adding Preview version config.

* Copying from master

* Move ResourceQuery at ResourceType level.

* Updating documentation.

* Updating field name to - isQuotaRequestPermitted.
Updating examples to include field - isQuotaRequestPermitted.
Updating build version and directives.

* Changing field name to isQuotaApplicable

* Removing .vscode files.

* Adding isOptional Field for resourceUsagesQuery

* Fixing formatting.

* Adding "resourceUsagesQuery" optional field to example.

* Fixing formatting.

* Ficing formatting.

* Adding new fields for resource query and making it extendable.

* Removing "isOptional": field.

* Updating stable schema.

* Updating examples.

* Fixing examples.

* Updating examples.

* Updating examples to include full resource path in id field.

* Running prettier to fix the formatting.

* Fixing readme files.

* Updating readme.md files.

* Undo changes for Package-lock.json.

* Undo changes to Package.json.

* Documentation update for Quota APIs.

* Removing mdash&;. It didn't like that tag in docs.

* 1. Using common types for ApiVersionParameter.
2. Removing "resourceUsagesApiTemplate" field.
3. Updating examples with full url.

* Removing ref - ApiVersionParameter, as it causing build error.

* Using {scope} to define path.

* Adding scope parameter definition.

* Update API definitions to include {scope} in put and patch.
Updated RP metadata example.

* Updating examples with Azure resource graph query.

* Fixing {scope} path.

* Adding - "x-ms-parameter-location": "method" for scope parameter.

* Adding missing subscriptions/ element to examples.

* Fixing CLI readme.md

* ReadMe.cli.md update.

* Adding Id field in quotaLimits.

* Updating name to match SKU name.

* changed serviceLimitsRequests to quotaLimitsRequests to match the operations.

* Update put/patch responses to 202.

* Updating response code to 202.

* Removing the nested Properties from the put response.

* Apply nested properties, as Model validation failed.

* Revert "Apply nested properties, as Model validation failed."

This reverts commit 88e6f87.

* Revert "Removing the nested Properties from the put response."

This reverts commit c54a20b.

* Updating the Model and patch sample to validate the suggested changes.

* Updating example responses for put and patch

* Running prettier

* Adding "type" : "object" to the schema

* Adding headers for Async operation.

* Fix the location uri.

* Updating Put and Patch APIs examples with async headers.

* Updating Put response to 201 and updating examples.

* 1. Adding type to the Get responses.
2. Include the original request body in response.

* 1. Return Put/Patch response same as the original request body .
2. Updated schema and examples.

* Removing readonly property unit.

* 1. Put id, name, type with all other properties.

* Fxing examples.

* Fixing ML example

* Moving id, name, type to top level. Fixing examples.

* Fixing - Top level properties should be one of name, type, id.

* Fixing Get API examples.

* Updating operations api response.

* Updating the examples and model.

* Fixing id values in put,patch examples.

* Fixing Azure CLI md file.

* Adding top level name property.
Fixing examples.
Removing unused models.

* Removing  "x-ms-azure-resource": true

* Adding top level name property to put and patch examples.

* Fixinf Put response to 202.

* Removing test-scenario from reame.cli.md

* Fixing GO build settings.

Co-authored-by: Arcturus Zhang <dapzhang@microsoft.com>
mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
…s quota APIs as ARM extension) (Azure#13623)

* 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction.
2. Removing state=enabledForPreview.
3. Updating Example.

* Updating Provider name in example.

* Capacity RP Quota APIs for GA

* Adding preview version to stable dir as base files.

* Files from preview version, which will be removed.

* Updating to GA Version.

* 1. Updated reservation version tag to - Microsoft.Capacity/preview/2020-10-01-preview/reservations.json, which matches the previous SDK release.
2. Documentation changes.

* Documentation updates for put and patch request, which includes only ONE quota request, so changing quotas to quota.

* Update documenation for put.

* Doc update.

* Adding -preview tag for GO sdk.

* Updating Go settings for output folder to be -preview.

* Adding preview subdir for GO package.

* Adding preview subdir to Go sdk path.

* Removing tag - tag: package-2020-10-25-preview

* introduce a new tag to keep the go sdk package unchanged

* Revert "introduce a new tag to keep the go sdk package unchanged"

This reverts commit 8f58d34.

* Adding Azure CLI readme configuration.

* Updating the ReadMe configurations.

* Updating readme.md

* Removing duplicate cli: tag.

* Fixing build issues.

* Removing Parameter alias.

* cli config changes.

* Updating the package name to reservation.

* Updates - removin .az.md.

* Updating Example names to be unique for Get PUT

* Adding operations and python-sdk-output-folder.

* Updates.

* Removing unused file.

* Revert "Removing unused file."

This reverts commit 4f763bd.

* Revert "Revert "Removing unused file.""

This reverts commit 60c520e.

* Add reference to python readme.md file.

* Adding python readme file.

* Adding Operations for test-scenario

* Adding split

* Disabling few operation, which is not needed.

* Removing split for Operation

* Disabling the reservation Operations.

* Disable reservation operations.

* Revert "Disable reservation operations."

This reverts commit d98cbcb.

* Adding client-subscription-bound: false

* Adding Quota Extension Model APIs and examples.

* Updating Batch Example.

* Updatng Quota Dimensions model.

* Model Updates.

* Updated examples and backup.

* Updating examples to flat file structure.

* Updating data model for quotaMetaData.

* Removing backup files.

* Updating quota,json.

* Fixing examples.

* Fixing enum definition.

* Addind systemData to response.

* Updated atch example.

* Remove blank line.

* Fixing path for types.json

* Running prettier

* Removing systemData.

* Updating readonly falg.

* Changing API version to preview-2021-03-15 to address INCONSISTENT_API_VERSION.

* Updating RP name to Quota

* Updating API version to 2021-03-15-preview

* Adding other SDKs build configuration

* Updating name to Quota.

* Updating API version - 2021-03-15-preview to 2021-03-15.
To address INCONSISTENT_API_VERSION

* Updating and adding version to stable and preview.

* Updates to config.

* Adding Ruby to config.

* Config Updates.

* Update

* Update.

* Adding supression.
Fix it later as needed.

* Updating for warnings.

* Prettier check fix.

* Updating build settings.

* Temp fix for permission issue. Pointing to existing reservations dir.
Change it back to -
  output-folder: $(csharp-sdks-folder)/quota/Microsoft.Azure.Management.Quota/src/Generated

* fixing readme.md.

* Removing conflict with reservation.

* setting -preview to default.

* remove -preview tag.

* Spliting variable path APIs and fixed path APIS.

* Spliting the extension and non extension APIs.

* Prettier fix.

* Fixing examples.

* Running prettier.

* Adding definion to duplicate file.

* Adding definitios.

* Reference to new file.

* pdating to stable version.

* Removing preview version files.

* Removing Preview version from readme.md.

* Removing preview version.

* Removing Preview version.

* Updating Batch Sample.

* Adding rescourceQuery and resourceQueryUri to quota dimensions.

* Removing resourceQueryUri.

* Remove quotaMetadata API and examples.

* Add update for metadata API and preview version.

* Adding Preview version API.

* Preview version.

* Updating preview version.

* Updating Preview version.

* Adding resourceUsagesApiTemplate to get resource usages.

* Adding resourceUsagesApiTemplate.

* run Prettier.

* Adding resourceUsagesApiTemplate to stable version.

* Updating example.

* Moving resourceUsagesApiTemplate at resourceType level.

* Prettier check.

* Updating examples.

* Adding Preview version config.

* Copying from master

* Move ResourceQuery at ResourceType level.

* Updating documentation.

* Updating field name to - isQuotaRequestPermitted.
Updating examples to include field - isQuotaRequestPermitted.
Updating build version and directives.

* Changing field name to isQuotaApplicable

* Removing .vscode files.

* Adding isOptional Field for resourceUsagesQuery

* Fixing formatting.

* Adding "resourceUsagesQuery" optional field to example.

* Fixing formatting.

* Ficing formatting.

* Adding new fields for resource query and making it extendable.

* Removing "isOptional": field.

* Updating stable schema.

* Updating examples.

* Fixing examples.

* Updating examples.

* Updating examples to include full resource path in id field.

* Running prettier to fix the formatting.

* Fixing readme files.

* Updating readme.md files.

* Undo changes for Package-lock.json.

* Undo changes to Package.json.

* Documentation update for Quota APIs.

* Removing mdash&;. It didn't like that tag in docs.

* 1. Using common types for ApiVersionParameter.
2. Removing "resourceUsagesApiTemplate" field.
3. Updating examples with full url.

* Removing ref - ApiVersionParameter, as it causing build error.

* Using {scope} to define path.

* Adding scope parameter definition.

* Update API definitions to include {scope} in put and patch.
Updated RP metadata example.

* Updating examples with Azure resource graph query.

* Fixing {scope} path.

* Adding - "x-ms-parameter-location": "method" for scope parameter.

* Adding missing subscriptions/ element to examples.

* Fixing CLI readme.md

* ReadMe.cli.md update.

* Adding Id field in quotaLimits.

* Updating name to match SKU name.

* changed serviceLimitsRequests to quotaLimitsRequests to match the operations.

* Update put/patch responses to 202.

* Updating response code to 202.

* Removing the nested Properties from the put response.

* Apply nested properties, as Model validation failed.

* Revert "Apply nested properties, as Model validation failed."

This reverts commit 88e6f87.

* Revert "Removing the nested Properties from the put response."

This reverts commit c54a20b.

* Updating the Model and patch sample to validate the suggested changes.

* Updating example responses for put and patch

* Running prettier

* Adding "type" : "object" to the schema

* Adding headers for Async operation.

* Fix the location uri.

* Updating Put and Patch APIs examples with async headers.

* Updating Put response to 201 and updating examples.

* 1. Adding type to the Get responses.
2. Include the original request body in response.

* 1. Return Put/Patch response same as the original request body .
2. Updated schema and examples.

* Removing readonly property unit.

* 1. Put id, name, type with all other properties.

* Fxing examples.

* Fixing ML example

* Moving id, name, type to top level. Fixing examples.

* Fixing - Top level properties should be one of name, type, id.

* Fixing Get API examples.

* Updating operations api response.

* Updating the examples and model.

* Fixing id values in put,patch examples.

* Fixing Azure CLI md file.

* Adding top level name property.
Fixing examples.
Removing unused models.

* Removing  "x-ms-azure-resource": true

* Adding top level name property to put and patch examples.

* Fixinf Put response to 202.

* Removing test-scenario from reame.cli.md

* Fixing GO build settings.

Co-authored-by: Arcturus Zhang <dapzhang@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants