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

Fixing swagger correctness items #16751

Closed
wants to merge 313 commits into from
Closed

Fixing swagger correctness items #16751

wants to merge 313 commits into from

Conversation

pratimaupadhyay02
Copy link
Contributor

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
    • 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 langauge SDKs and CLIs that must be refreshed after the 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 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: ⚠️

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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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.

Alancere and others added 30 commits October 9, 2021 14:28
* add resourcemanager and add repo for go track2

* add resourcemanager

* fix other
#16131)

* Elaborate description and exampleson capacity mode

* PR fixes

* Revert changes for 2017 version
* add operation step

* fix schema

* restore OpTest

* add cleanUpSteps & remove type

* use draft-07 schema

* refine propertyNames

* add description

* remove merge

* fix copy/move

* use property name

* variable type

* restore plain style

* define Example and file reference in v1.1

* remove raw Example support

* fix

* rename to API scenario

* restore entry

* fix ref
* Initial commit for 2021-06-01 and  2021-06-01-preview

Initial commit for 2021-06-01 and  2021-06-01-preview

* new version update

* review comments changes.

review comments changes.
* copy existin api-version

* update api-version ref

* new feature
…s fix and other changes (#15962)

* new api changes (#1)

* new api changes

* referer url change

* EdgeOrder 2020-12-01-preview Swagger changes (#5)

* readme changes

* Swagger refresh and update examples

* Change examples as per oav validations

* Minor swagger modifications

* Minor spacing adjustments

* Set ModelAsString to true for enums and modify examples

* Fix swagger lint validation error

* Modify readme and examples

* Modify readme.go.md

* Update swagger

* Minor prettier fix

* Change python package version in readme

* Fix spell check error

* chanegs to enable forward and reverse shipping details in get order item call using odata filter

* Swagger correctness fix with other changes (#25)

* Swagger correctness fix with other changes

* Return api field additions

* Change expand description for listOrderItem calls

Co-authored-by: Vaishnavi Janardhan <vjanardhan@microsoft.com>

* Fix semantic validation error in doubleEncryptionStatus (#30)

* Mark parameters of shipping details as readonly (#35)

* Additional properties swagger correctness fix (#43)

Co-authored-by: sashanm <54701252+sashanm@users.noreply.github.com>
Co-authored-by: t-vjanardhan <77781522+t-vjanardhan@users.noreply.github.com>
Co-authored-by: Nidhi Jain <nidhij@microsoft.com>
Co-authored-by: nija-dev <67132984+nija-dev@users.noreply.github.com>
Co-authored-by: Vaishnavi Janardhan <vjanardhan@microsoft.com>
…preview/1.1.0 (#16182)

* Adds base for updating VideoAnalyzer.Edge from version preview/1.0.0 to version 1.1.0

* Updates readme

* Updates API version in new specs and examples

* Update AVA Edge Swagger to 1.1 release

* fix a linter issue.

* fix spelling mistakes

* update the api version

* update swagger with new changes
* Swagger for Form Recognizer 2021-09-30-preview.

* Fix styling issues.

* Fix styling.

* Remove yml version.
* Creator v1 Deprecated - Delete Swagger Docs

Creator v1 Deprecated as of Sept 6 2021 - Delete Swagger Docs

* Creator v1 Deprecated - Delete Swagger Docs

Creator v1 Deprecated as of Sept 6 2021 - Delete Swagger Docs
… version stable/2021-09-01 (#16247)

* Adds base for updating Microsoft.ContainerInstance from version stable/2021-07-01 to version 2021-09-01

* Updates readme

* Updates API version in new specs and examples

* Adding zones property to resource

* Add zones property to relavent examples

* Running prettier on modified examples

* Adding x-ms-secret to password in responses

* Changing parameters to use common types

* Reverting changes since they introduced validation errors

* Prettier check
Co-authored-by: Amit Elran <amelran@microsoft.com>
…rations (#15999)

* Adds base for updating Microsoft.KubernetesConfiguration from version stable/2021-03-01 to version 2021-10-01-preview

* Updates readme

* Updates API version in new specs and examples

* Reference common definitions

* Add fluxConfiguration to initial commit

* Update readmes to new version

* Add 409 conflict to scc

* Update example api-versions

* Add path example

* Run prettier

* Update dependsOn object body

* Update readmes with 2021-09-01

* Change to lastSourceSyncedCommitID

* Change to 2021-11-01-previe
* Initial commit for comparison with previous release

* Add new swagger 2021-08-01-preview and examples
* Swagger changes for Dataflow flowlets

* Fix reference errors

* Fix Lint checks

* Separate changes for ADF and Synapse

* Address Review Comment
* Swagger changes for Synapse flowlets

* Add Flowlet to custom words

* Address comments
* Remove value attribute from certificate object

* Fix prettier errors
…d. (#16311)

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.

* Adding required property to some of the parameters we initially missed.
* Added new service versions for storage

* working on readmes

* update
…021-10-06-preview (PublicPreview) (#16301)

* Copy from 2021-07-08-privatepreview api from private repo

* Promote 2021-07-08-privatepreview to 2021-10-06-preview

* add expiresin custom word for linter fix

* fix sdk generation failures
* add batch tag 10/14

* fix
…nerated] (#16057)

* Rename with `x-ms-client-name`

* Add extensible enum for timezone accept language

* Rename operationId to have better method meaning

Add x-ms-client-name for better explaining

* Updated description for HasZone1970Location property

* Removed Enum in model class name

* Better naming for TimeTransitions

* Updated x-ms-examples to be more friendly

* Update Descriptions

* Update method name

* Update coordinates with collectionFormat csv

* Modified sunrise, sunset type

* Update wording for hasZone1970Location description

* Use LatLongPair as reference

* Modify exists definitions

1. Combined definitions with same structures into TimezoneResult, TimezoneId, ReferenceTime.

* Update Examples to fix Model Validation

* Rename to Timezone to be consistent

* Update description for hasZone1970Location

* Minor updates for name, type

* Modified property to uppercase to match exmaples

* Changed back to using RepresentativePoint

Co-authored-by: Alex Tsao <ttsao@microsoft.com>
This was referenced Nov 22, 2021
@pratimaupadhyay02
Copy link
Contributor Author

Closing this PR as changes were merged in another PR #16865

@pratimaupadhyay02 pratimaupadhyay02 deleted the recoveryServices-backup-October-release branch November 30, 2021 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.