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.

Sign up for GitHub

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

Jump to bottom

synapse web activity update: Disable Cert Validation property. #18294

Merged
merged 6 commits into from
Mar 22, 2022
Merged

synapse web activity update: Disable Cert Validation property. #18294

merged 6 commits into from
Mar 22, 2022

Conversation

kalyanrk61
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 language 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 are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

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

@kalyanrk61 kalyanrk61 requested a review from a team as a code owner March 16, 2022 19:03
@kalyanrk61 kalyanrk61 requested review from tg-msft and bexxx and removed request for a team March 16, 2022 19:03
@ghost ghost added the Synapses label Mar 16, 2022
@leni-msft
Copy link
Contributor

/azp run

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 17, 2022 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ 1045 - AddedOptionalProperty The new version has a new optional property 'disableCertValidation' that was not found in the old version.
New: preview/2021-06-01-preview/entityTypes/Pipeline.json#L5972:7
Old: preview/2021-06-01-preview/entityTypes/Pipeline.json#L5972:7
️️✔️LintDiff succeeded [Detail] [Expand] 
Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
Validation passes for SDKTrack2Validation

️️✔️PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 17, 2022 •
edited
Loading

Swagger pipeline restarted successfully, please wait for status update in this comment.

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-workflow-bot
Copy link

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

@leni-msft leni-msft self-assigned this Mar 17, 2022
@leni-msft
Copy link
Contributor

approved bc since this is to sync #17588 which's already approved

@leni-msft leni-msft added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 22, 2022
@leni-msft leni-msft merged commit 274ce07 into Azure:main Mar 22, 2022
FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
@kalyanrk61 @FredericHeem
synapse web activity update: Disable Cert Validation property. (Azure…
6151689 
…#18294)

* Add pipeline policy and ElapsedTime Policy

* adding missing objects

* fix schema validation

* fix prettier issues

* add disable cert validation in webactivity

Co-authored-by: Kalyan C Kesireddy <kalyanke@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leni-msft leni-msft leni-msft approved these changes

@tg-msft tg-msft Awaiting requested review from tg-msft tg-msft was automatically assigned from Azure/api-stewardship-board

@bexxx bexxx Awaiting requested review from bexxx bexxx was automatically assigned from Azure/api-stewardship-board

Assignees

@leni-msft leni-msft

Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Synapses
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kalyanrk61 @leni-msft