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

EventGrid (2020-06-10 and 2020-10-15-preview): Swagger Correctness --- Fix swagger for setting readonly for privateEndpointConnections for topic, domain properties #13397

Merged
merged 32 commits into from
Mar 15, 2021

Conversation

ahamad-MS
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

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.
    No service side deployment needed. This is existing code/deployment.

  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    As soon as possible to get green on S360

  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.

@openapi-workflow-bot
Copy link

Hi @ahamad-MS, 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.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 15, 2021
@ahamad-MS
Copy link
Contributor Author

Thank you @JeffreyRichter for the approval.
@njuCZ Can you please help merge it?

Thanks

@njuCZ njuCZ merged commit d0f0c3d into Azure:master Mar 15, 2021
This was referenced Mar 16, 2021
MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
…- Fix swagger for setting readonly for privateEndpointConnections for topic, domain properties (Azure#13397)

* fix example

* Fix multiple linter and swagger correctness/completeness issues for latest preview and stable api version

* Fix format

* fix examples

* fix validation model errors

* fix validation model errors

* fix example

* remove default

* revert 2020-06 changes

* fix eventgrid swagger file with multiple linter and correctness fixes

* fix 2020-06-01 stable swagger

* fix 2020-06-01 stable swagger -- part 2

* fix format

* fix prettier check

* additional format fix

* fix examples and wrong response code

* fix validator

* fix validator

* fix remaining swagger correctness issues

* fix end of file

* fix lintter

* Add readonly tag for privateEndpointConnections for both domain and topic properties

* Fix sku default value

* fix prettier

Co-authored-by: Ashraf Hamad <ahamad@ntdev.microsoft.com>
@ahamad-MS ahamad-MS deleted the master branch June 12, 2021 00:14
@ahamad-MS ahamad-MS restored the master branch June 12, 2021 00:18
mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
…- Fix swagger for setting readonly for privateEndpointConnections for topic, domain properties (Azure#13397)

* fix example

* Fix multiple linter and swagger correctness/completeness issues for latest preview and stable api version

* Fix format

* fix examples

* fix validation model errors

* fix validation model errors

* fix example

* remove default

* revert 2020-06 changes

* fix eventgrid swagger file with multiple linter and correctness fixes

* fix 2020-06-01 stable swagger

* fix 2020-06-01 stable swagger -- part 2

* fix format

* fix prettier check

* additional format fix

* fix examples and wrong response code

* fix validator

* fix validator

* fix remaining swagger correctness issues

* fix end of file

* fix lintter

* Add readonly tag for privateEndpointConnections for both domain and topic properties

* Fix sku default value

* fix prettier

Co-authored-by: Ashraf Hamad <ahamad@ntdev.microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go FixS360
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants