Skip to content

Conversation

@rickysun93
Copy link
Owner

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?
    • 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.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • 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.

sureleo and others added 30 commits September 15, 2021 13:35
* Adding 202 for deletion call

* Adding headers to suppress warnings
* add endpoint to webpubsub swaggers

* have endpoint not include connection string in swagger

* Update webpubsub.json

* Update webpubsub.json

Co-authored-by: Laurent Mazuel <[email protected]>
…stable/2018-03-01 (#15749)

* Change example to auto mitigate true

* Remove not equals from supported operators

* add some more auto mitigate true to examples
…ble/2020-12-01 (#15674)

* Fixing swagger correctness issues

* reverting the newly added status code

* prettier formatting

* adding custom words

* s360 issue fix

* Fixing model validation error

Co-authored-by: Praveenkumar Ravikumar <[email protected]>
* add new version 2021-09-01-preview for signalr

* fix style

* remove webpubsub

* fix breaking change
* move legacy file to a new folder

* remove unused example files

* address validation errors
…ResourceProperties and VmwareVMProperties (#15936)

* BaseResourceProperties class

Introducing BaseResourceProperties in data source and data source set

* Introducing VmwareVMProperties

Introducing VmwareVMProperties

* Update dataprotection.json

Updating the version

* Update dataprotection.json

Fixing lintdiff error

* Update readme.md

fixing readme.md

* Update readme.md

Adding input file in readme.md

* Examples update

Updating example with version and resource properties

* Update readme.md

Reverting input file change
* Add GET all methods for resource group and subscription

* Fix Linter Validation issue

* Fix Swagger Correctness S360 items

* Fix swagger validation comments

* Fix model validaiton

* Fix Lint errors

* Fix model validation for examples

Co-authored-by: Aashish Rajaram Salokhe <[email protected]>
* Added missing Cluster APIs to 2021-01-01-preview

* added cluster API in 2021-06-01-preview

* updated lint errors

* update 1

* added listbysubscription

* fixed ModelValidation

Co-authored-by: v-ajnava <[email protected]>
… Generated] (#16030)

* Geolocation: Use user-friendly key and filename for x-ms-examples

* Geolocation: Use client name ipAddress for parameter ip

* Common: Set TextFormat/ResponseFormat default to json

* All: Remove operationId prefix for swagger except Creator

* Geolocation: Rename method GetIPToLocationPreview to GetLocation

* All: Rename [Service]ApiVersion to ApiVersion

* Common: Use client name mapsClientId for x-ms-client-id

* Remove -Preview suffix

* Common: Remove x-ms-parameterized-host/schemes/cosumes

* Common: TextFormat->ResponseFormat, ResponseFormat->JsonFormat

* Common: Model GeojsonObject as a closed enum

* Common: Reset JsonFormat/ResponseFormat modelAsString=true

* Common: Rename mapsClientId as clientId
* Add blockchain to latest profile

* Add additional types

* Update operationId field in Swagger, update ListOperations Example

* Revert commit

* prettier fix

Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: Aditi <[email protected]>
* Swagger changes for retention policy properties

Changes:
* Updated examples and swagger json for sql database

* Swagger changes for retention policy properties

Changes:
* Updated examples and swagger json for sql database

* addressed comment to fix ref

* fixed model validation

Co-authored-by: Haris Mahmood Ansari <[email protected]>
* add TDE V5 tag and remove it from sql.core.legacy.json

* Revert "add TDE V5 tag and remove it from sql.core.legacy.json"

This reverts commit 78c2844.

* initial

Co-authored-by: Yueren Wang <[email protected]>
Added viewDefinition as required property
* Update description of trigger options

* Update specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

Co-authored-by: Heath Stewart <[email protected]>

* Update specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

Co-authored-by: Heath Stewart <[email protected]>

* Update keys.json

Co-authored-by: Heath Stewart <[email protected]>
* add collection property

* add examples

* update scan examples

Co-authored-by: Parv Saxena <[email protected]>
* Update purviewcatalog.json

* Update purviewcatalog.json

* delete

* add
* initial commit for purview metadata policies

* fixed paths and added fields

* fixed issues and added examples for purview metadatapolicy

* fixed example file name for purview metadatapolicy

* fixed words

* fixed model issue

* removed readonly property from example

* removed readonly proprties from body

* fixed response status codes

* fixed prettier issue

* updated metadata roles API for Purview Metadata policy service

* spellcheck and prettier fix

* removed skiptoken, count and added autorest extension

* sdk changes

* fixed not foundbug

* removed collection path

* removed unreferenced file

* fixed error code

Co-authored-by: Kshitiz Vijayvargiya <[email protected]>
* Add blockchain to latest profile

* Add additional types

* Supported api for AKS and ACR

Revert "Add additional types"

This reverts commit 7b46097.

Revert "Add blockchain to latest profile"

This reverts commit 1bcc20d.

Adding supported apis for ACR and AKS

Revert "Add blockchain to latest profile"

This reverts commit 1bcc20d.

Adding supported apis for ACR and AKS

Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: Bhuvaneswari Santharam <[email protected]>
…preview/2021-06-01-preview (#16042)

* Added exportable attribute and release policy to CP Swagger doc

* Specify type as object for ReleasePolicy

* Address code review comments

* Add suppression code for camelCase

* Prettier check
…9 01 (#15593)

* Add blockchain to latest profile

* Add additional types

* Adds base for updating Microsoft.KubernetesConfiguration from version common/2021-05-01-preview to version 2021-09-01

* Updates readme

* Updates API version in new specs and examples

* Extension GA - apiversion 2021-09-01

* Move definitions.json to the correct folder

* Add Patch example

* Prettier fix

* Patch response fix

* Avocado fixes

* Additional fixes

* Fixes for Model and Semantic validations

* Additional fixes

* Fix patch example

* Prettier fix for definitions.json

* Readme.md spacing fix

* Add AKSIdentity object

* Prettier and Lint Diff fixes

* Change Patch response to 202, per review

* Update Patch response body to adhere to API guidance

* Added Suppression for Patch 202 response

* Fix linter issues

* Fix linter issues

* Fix Linter and Model validation errors

* Fix ModelValidation and Prettier issues

* Move suppression to the GA version

* Move suppression to global

* Move suppression back to the GA version

* Update suppression

* Fix errors from SDK generation

* Prettier fix

* Remove definitions.json and move the defs. into extensions.json

* Remove azure-validator

Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: nanthi <nanthi@NANTHI01>
* [Synaspe] Sync changes from DataFactory

* update

* update

* update

* update
* Metadata-Microsoft-Security-Insights-Metadata-API-Update

* newcommit

* Metadata-Swagger-Update-SVG

* Metadata-Update-Svg-Patch

* Metadata-Swagger-Update

* Updating-Example-Files

* Update date to date-time

* change-datetime-to-date

* Remove-SVG-3

* Metadata-Swagger-Update

* Category-to-Categories

* Update-publish-date-in-examples

* Update-publish-date-in-examples

Co-authored-by: Rishabh Tyagi <[email protected]>
alexgoldschmidt and others added 29 commits October 22, 2021 11:18
…16384)

* Add Microsoft.ResourceConnector [Appliance] 2021-10-31-preview API

* Run prettier on violation files

* Add SCVMM to custom-words.txt

* Fix validation issues

* Fix prettier issue with AppliancesListClusterUserCredential.json

* Add multi API section for go readme and update namespace for python readme

* Update Example files to be more accurate

* Add None to Managed Identity typ in parity with other Azure Arc Resources

* Add default value as AKSEdge for distro

* Adding type object for ApplianceListResult

* Update Identity to use SystemAssignedServiceIdentity from common-types v3 managedidentity.json

* Reverting to using custom Identity

* Update readme.md

* Update readme.python.md

Co-authored-by: Anirban Thakur <[email protected]>
Co-authored-by: Yiming Lei <[email protected]>
* Create Sample Directory Structure for Swagger

* Delete Sample Directory Structure for Swagger

* Create Sample Directory Structure for Swagger

* Update Getting started with OpenAPI specifications.md

* Delete Sample Directory Structure for Swagger

will reuse this wiki https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure, instead of creating a new one.

* Update Getting started with OpenAPI specifications.md

reuse this wiki for sample directory https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure
…6433)

* Rename 'whitelist'

* add missing 'Group' in renamed file

* add mdeOnboarding API - 2021-10-01-preview

* fix json format

* fix PR issues

* add List operation

* change to plural, set default resource type name

* mismatch between GET and LIST examples

* made descriptions clearer, removed unused parameter

* defined explicit parameters

* delete unused schema

Co-authored-by: Erel Hansav <[email protected]>
…stable/2021-10-14 (#16417)

* Adds base for updating Microsoft.Insights from version preview/2020-06-02-preview to version 2021-10-14

* Updates readme

* Updates API version in new specs and examples

* Fixing a relative path

* Pascal casing for the resource provider name

* Attempt at fixing R4018
* swagger fix

* 2016 patch

Co-authored-by: Jimmy Xie <[email protected]>
…on preview/2021-09-01-preview (#16468)

* Add dump API

* add new line at the end of line

* change cases

* typo

* response

* add api for start/stop azure spring cloud instance

* fix lint error

Co-authored-by: Yinglue Zhang <[email protected]>
Co-authored-by: caiqing <[email protected]>
Co-authored-by: YinglueZhang-MS <[email protected]>
* Kusto: Swagger readonly cosmetics changes

* supress

* prettier

* fix 2017-09-07-privatepreview examples

* fix 2018-09-07-preview model

* 1

* 1
…entSnapshot data types (#16489)

* Add SubAssessment event source type and add more automations examples

* Change Location isReadOnlu to false

* Test

* Add new read/write location and add new type TrackedResourceLocation

* Minor

* minor

* prettier fixes

* Change variable name to TrackedResourceLocation

* Change type name TrackedResourceLocation to AzureTrackedResourceLocation

* Update automations example

* Add SecureScores & SecureScoreControls as new supported datatypes in Automations resource

* [ASC.Automations] add new data type RegulatoryComplianceAssessment

* Add Secure Scores and Regulatory Compliance snapshot data types

* Changes

* minor fix

* syntax fixes

* [Microsoft.Security/Automations] Add AssessmentsSnapshot & SubAssessmentSnapshot data types

* minor

* minor

* minor

* minor
…y-2021-07-01' (#16435)

* Adds base for updating Microsoft.Security from version preview/2021-05-01-preview to version 2021-07-01

* Updates readme

* Updates API version in new specs and examples

* Adding securityConnectors private API

* Update the readme.md

* adding custom word

* Update Security Connector model in examples

* Update main security connectors model with new organizational data properties, update examples as well.

* added new offerings

* fix pathing

* fix offering name in all examples

* add docs for patch endpoint

* add system data resource

* Remove duplication

* Resolve tools issues

* Change bool to boolean

* Fix model validation errors

* Fix lint error

* CR fixes. Move systemData to root of object. Export identity type to definition

* remove extra bracket

* fix bracketing and pathing

* lint fixes

* fix camel case for linting

* Fix systemData examples

Co-authored-by: Sapir Elmakayes <[email protected]>
Co-authored-by: Sapir Elmakayes <[email protected]>
…n preview/1.0 (#16128)

* Modified method GetTrafficFlowSegment to remove the Result type and return the data type directly

* Revert "Modified method GetTrafficFlowSegment to remove the Result type and return the data type directly"

This reverts commit 46bc557.

* Flattening and renaming of several components within Traffic Segment Flow

* Flattened the client for Traffic Incident Detail

* More changes in flattening, now for TrafficIncident and Detail

* More changes in flattening, now for TrafficIncident and Detail

* More feedback addressed

* prettier fixes

* Clarified doc string

* Added start and end time for Traffic incident

* Added friendly names for x-ms-examples

* Fixed avocado bugs, added query parameter as number array

* Added collectionFormat to all comma separated parameters

* Small changes to improve codegen

* Prettier fixes

* Fixed all comments from latest PR review

Co-authored-by: Daniel Rocha <[email protected]>
* saving progress

* fixing typos

* fixing typos

* fixing typo

* running prettier

* small comment change

* minor fixes

* minor fix

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* saving progress

* moving shortcodes files to its own folder

* saving progress

* adding basic readme file

* Changing message details to support adding examples for contenttypes, adding estimatedRampUpTime and directionality

* adding format for urls, emails and phone numbers

* renames on different fields

* adding back helpMessage and optOutMessage

* removing tel format
* fix missing accesslevel field in requestResponse

* fix another s360 issue

* fix fields in example files as well

* update custom words
…n stable/2021-10-15 (#15733)

* Adds base for updating Microsoft.DocumentDB from version stable/2021-06-15 to version 2021-09-15

* Updates readme

* Updates API version in new specs and examples

* Add support for fetching continuous backup information for latest restorable timestamp.

* Adding locations API and backupRedundancy

* Fixing ref

* Add 10-15 Preview along with ClientEncryptionKey management changes

* Renaming 2021-09-15 api version to 2021-10-15

* Fixing some more renames

* fix validation checks

* add clientencryptionkeys to custom-words

* initial commit

* Swagger specifiations

* readme file updated

* Review comments addressed

* Added TotalThroughputLimit property to Database Create and Update

* Rebased and added type to capacity

* Added changes to preview folder as well

* Added changes to missing files

* initial checkin of base version

* Adding examples; /deallocate and /start api in swagger

* update readme.md file

* Removing 2021-10-15-preview changes

* managed cassandra swagger changes for GA

* Fixing linter issues

* minor description fixes

* adding missing example

* add stable and preview swagger

* revert to Thu Sep 9 2021 change

* fix linter errors in swagger

* fix validation errors

* validation fixes

* remove fetchNodeStatus from stable

* remove unused example file, fix validation error

* Fixing the spell check and formatting issues

* remove /repair api, make /command async

* remove unreferrenced example json

* remove pageable link from /status api

* remove backups api, add cassandraAuditLoggingEnabled property

* add cassandraAuditLoggingEnabled property

* make /status api async, minor fixes

* remove async tag to /status

* remove connectivity property, add Ldap as preview

* remove unreferenced example files

* use guid in subid for examples

* add backupStorageCustomerKeyUri property

* fix api response code

* remove ldap

* Changing operationId for locations API

* review comments

Co-authored-by: REDMOND\amisi <[email protected]>
Co-authored-by: Anuj Toshniwal <[email protected]>
Co-authored-by: Abhijit Karanjkar <[email protected]>
Co-authored-by: Praful Johari <[email protected]>
Co-authored-by: visunda <[email protected]>
Co-authored-by: Vivek Sundararajan <[email protected]>
Co-authored-by: vivek-microsoft <[email protected]>
* init

* remove

* Add 2021-10-01

* Minor update
…fields and new controller path. (#16463)

* Initially cut, cloned from know existing GA bits (IE \specification\monitor\resource-manager\Microsoft.Insights\stable\2015-04-01)

* rev API version, add new controller API path, and update JSON showing newly added predictiveAutoscalePolicy field
* Fix LimitObject polymorphism

* move properties out of allOf

* add type to LimitObject

* value is required

* Updating Operations Tag to QuotaOperations.

* Update quota.json

Updating Summary field for operations.

Co-authored-by: Rahul Singh <[email protected]>
* resloving s360 itme

* added prettier-fix changes

Co-authored-by: Gaurav Bang <[email protected]>
…preview/2021-07-01-preview (#16549)

* Adds base for updating Microsoft.Security from version preview/2021-07-01-preview to version 2021-07-02-preview

* Updates readme

* Updates API version in new specs and examples

* Fix account id to account ids

* Minor

* Minor

Co-authored-by: Sapir Elmakayes <[email protected]>
…dd version preview/2.0 (#16487)

* added extra fields to JSON list data response in docs

* added content-type field to request header

* took out content type from header field due to errors; JSON reponse fields for user Data are ready to commit
…dd version preview/1.0 (#16446)

* Remove mobility

* Remove mobility

* Remove mobility

* Remove mobility reference

* Trigger another pipeline?

* Remove more mobility
…16283)

* First set of changes for Search API

* More changes to address review

* More changes to address review

* More changes to address review

* Reset searchAlongRoute name

* Fixed roadUse

* Fixed OAV error

* Minor fixes

* Fixed fuzzy search errors from review

* Changes in Reverse Search Address mode

* More changes from the review

* Checkpoint commit

* Fixed floating point numbers, dataSources field

* Modified boundingBox to avoid causing model validation failure

* Fixed more examples

* Fixed more broken examples

* Fixed more examples

* Fixed more examples

* Prettier fixes

* Re-add street and buildingNumber

* Revert client body flattening, add names for x-ms-enum

* Removed locale-specific URLs

* More changes to address review

* More changes to address review

* Minor fixes

* More changes from the review

* Fixed floating point numbers, dataSources field

* Fixed final issues for review

* Modified boundingBox to avoid causing model validation failure

* Prettier fixes

* Revert client body flattening, add names for x-ms-enum

* Reflect operationId changes in Readme.typescript

* Keep operations in TypeScript to be consistent for all languages

* Update sdk generation to track2

* Prettier fix

* Revert "Update sdk generation to track2"

This reverts commit 5ede489e84a1820c06f7c26f70bf1bc9c2a3ec86.

* Remove .net sdk generation since it is not used

* Added prefix to Operation Id.

* Fixed couple of operationIds

* Renamed PolygonResponse

* Address PR comments

* More changes due to PR Review

* Testing new batch naming

* Fixed bug in searchInsideGeometry

* Testing new batch naming

* Fixed batch naming that didn't work well.

* Renamed searchInsideGeometryBody to geometry

* Finished all PR review comments, added changes to Common and Route

Co-authored-by: Daniel Rocha <[email protected]>
Co-authored-by: alankashiwa <[email protected]>
* making numberType on ShortCode model object extensible enum

* Revert "making numberType on ShortCode model object extensible enum"

This reverts commit 5051e3e.

Reverting change since it should have been done on feature branch

* adding extensible enum metadata to short code numbertype
* Add blockchain to latest profile

* Add additional types

* address review comments
https://apiview.dev/Assemblies/Review/99ceeedf3dc84cc2b6652c6eba9b2431

* model validation, prettier fixes

* rollback accidental legacy doc changes

* resolve parameter name clashing for Description

* remove the need for ExtendedGeoJsonFeatureCollection to define a descriminator by explicitly bypassing GeoJsonFeatureCollection

* alias and tileset at 1.0 is not in main

* leverage common's PositionLongitude/LatitudeAbbreviated for search BiasLat/Lng

* address @tjprescott comments

* Revert "leverage common's PositionLongitude/LatitudeAbbreviated for search BiasLat/Lng"

This reverts commit 928b59e.

* clarift GeofenceGeometry distance units in descriptions

* remove remaining x-ms-client-flatten

* renamed OutputOntology enum model name

* rename StyleRuleType to RuleType to fix name collision

* better StyleRule enum naming

Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: Taras Vozniuk <[email protected]>
Co-authored-by: Taras Vozniuk <[email protected]>
@rickysun93 rickysun93 merged commit bfa2434 into rickysun93:master Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment