Skip to content

ACSS, PHP & AMSv2 public preview - version 1#19179

Closed
gargankit-microsoft wants to merge 43 commits intomainfrom
ACSS_PHP_AMSv2_PublicPreview_Version1
Closed

ACSS, PHP & AMSv2 public preview - version 1#19179
gargankit-microsoft wants to merge 43 commits intomainfrom
ACSS_PHP_AMSv2_PublicPreview_Version1

Conversation

@gargankit-microsoft
Copy link
Contributor

@gargankit-microsoft gargankit-microsoft commented May 23, 2022

Please follow the link to find more details on the swagger existing in azure-rest-api-specs-pr : private repo swagger. That has already been reviewed by respective teams and is in private preview.

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. June-July Timeframe
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. As early as possible to support further rollouts and SDK Generation
  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

Existing request for SDKs: https://github.com/Azure/sdk-release-request/projects/1164

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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

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

@openapi-workflow-bot
Copy link

Hi, @gargankit-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 23, 2022

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

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 23, 2022
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 23, 2022

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

    @openapi-workflow-bot
    Copy link

    Hi, @gargankit-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @gargankit-microsoft gargankit-microsoft changed the title Acss php am sv2 public preview version1 ACSS, PHP & AMSv2 public preview - version 1 May 23, 2022
    @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.

    @gargankit-microsoft
    Copy link
    Contributor Author

    policy check is failing due to

    The term whitelist was used in file 'custom-words.txt' and may not be appropriate to ship in all contexts. When industry naming conventions or consistency make replacement of the term impractical, leave the term unchanged. When used to describe a list of people or things that have received approval or are considered to be in good favor, replace with "allow list". More specific terms such as "approved list" or "safe recipients list" can be used where appropriate.

    Seems unrelated to our changes, as the flagged term is already there. The flag count of three seems to be related to three existing words in file

    whitelisted
    Whitelisting
    Whitelistings

    @gargankit-microsoft
    Copy link
    Contributor Author

    .NET SDK is failing for some time now for multiple PRs, hence our check is failing for that as well. this is unrelated to change and is caused due to script permissions, which is not in our control.
    We are already in touch with owner of .NET SDK to get it generated offline.

    @gargankit-microsoft gargankit-microsoft marked this pull request as ready for review May 23, 2022 09:03
    @gargankit-microsoft gargankit-microsoft removed the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label May 23, 2022
    vutran01 and others added 3 commits May 26, 2022 12:56
    * initial expected changes
    
    * remove additionalProperties from etag
    
    * rename property name
    Co-authored-by: Kayla Seager <kaseager@microsoft.com>
    @gargankit-microsoft
    Copy link
    Contributor Author

    moved to #19232 as this was having issues in running checks

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview CI-BreakingChange-Go-V2 DoNotMerge <valid label in PR review process> use to hold merge after approval WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.