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

Add new api-version 2023-01-01 #22962

Merged
merged 2 commits into from
Mar 8, 2023
Merged

Add new api-version 2023-01-01 #22962

merged 2 commits into from
Mar 8, 2023

Conversation

naveedaz
Copy link
Contributor

@naveedaz naveedaz commented Mar 7, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @naveedaz 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 7, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    AppServiceCertificateOrders.json 2023-01-01(aaf02d7) 2022-09-01(main)
    CertificateOrdersDiagnostics.json 2023-01-01(aaf02d7) 2022-09-01(main)
    CertificateRegistrationProvider.json 2023-01-01(aaf02d7) 2022-09-01(main)
    DomainRegistrationProvider.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Domains.json 2023-01-01(aaf02d7) 2022-09-01(main)
    TopLevelDomains.json 2023-01-01(aaf02d7) 2022-09-01(main)
    AppServiceEnvironments.json 2023-01-01(aaf02d7) 2022-09-01(main)
    AppServicePlans.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Certificates.json 2023-01-01(aaf02d7) 2022-09-01(main)
    CommonDefinitions.json 2023-01-01(aaf02d7) 2022-09-01(main)
    ContainerApps.json 2023-01-01(aaf02d7) 2022-09-01(main)
    ContainerAppsRevisions.json 2023-01-01(aaf02d7) 2022-09-01(main)
    DeletedWebApps.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Diagnostics.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Global.json 2023-01-01(aaf02d7) 2022-09-01(main)
    KubeEnvironments.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Provider.json 2023-01-01(aaf02d7) 2022-09-01(main)
    Recommendations.json 2023-01-01(aaf02d7) 2022-09-01(main)
    ResourceHealthMetadata.json 2023-01-01(aaf02d7) 2022-09-01(main)
    ResourceProvider.json 2023-01-01(aaf02d7) 2022-09-01(main)
    StaticSites.json 2023-01-01(aaf02d7) 2022-09-01(main)
    WebApps.json 2023-01-01(aaf02d7) 2022-09-01(main)
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 7, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 7, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/appservice/armappservice https://apiview.dev/Assemblies/Review/6632c28cd94a4665a40a48af167d3685
    Java azure-resourcemanager-appservice-generated https://apiview.dev/Assemblies/Review/5f9cfac4f0574e97aaa5a37f5638db29
    JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/4c6a08b850954371aaa63128caa26546

    @ghost ghost added the Web Apps label Mar 7, 2023
    @openapi-workflow-bot
    Copy link

    Hi @naveedaz, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @naveedaz, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @openapi-workflow-bot
    Copy link

    Hi, @naveedaz your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @naveedaz
    Copy link
    Contributor Author

    naveedaz commented Mar 7, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @weidongxu-microsoft weidongxu-microsoft merged commit d7cb3a0 into Azure:release-web-2023-01-01 Mar 8, 2023
    naveedaz added a commit that referenced this pull request Nov 10, 2023
    * Add new api-version 2023-01-01 (#22962)
    
    * Add new api-version 2023-01-01
    
    * Change default package api-version
    
    * Updated workflowstate to be a reference (#23084)
    
    * Fix OneDeploy request and response bodies (#23224)
    
    * Fix OneDeploy request and response bodies
    
    * Fixing typo
    
    * Add Container Apps Environment Id in checknameavailability API (#24102)
    
    Co-authored-by: Vishal Gupta <[email protected]>
    
    * Add minTlsCipherSuite property (#24198)
    
    * Add minTlsCipherSuite property
    
    * Move to SiteConfig
    
    ---------
    
    Co-authored-by: Chris Rosenblatt <[email protected]>
    
    * Dapr configuration for a site (#24606)
    
    * Dapr configuration for a site
    
    * removed dapr older definition
    
    * adding back old dapr definition
    
    * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition
    
    * to initiate checks as re-run
    
    * fixed prettier check fail
    
    ---------
    
    Co-authored-by: Sushmitha Vangala <[email protected]>
    
    * Fix for JS SDK check failure for Dapr Config (#25493)
    
    * Dapr configuration for a site
    
    * removed dapr older definition
    
    * adding back old dapr definition
    
    * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition
    
    * to initiate checks as re-run
    
    * fixed prettier check fail
    
    * JS Sdk check fail fix
    
    ---------
    
    Co-authored-by: Sushmitha Vangala <[email protected]>
    
    * Release web 2023 01 01 (#25157)
    
    * Adding locations/usages endpoint and example
    
    * Revert "Adding locations/usages endpoint and example"
    
    This reverts commit 4a11107.
    
    * Adding back usages changes with up to date branch
    
    * Updates based on verification tools
    
    * Fixing spacing, adding missing comma
    
    * ran prettier-fix for formatting
    
    * Update for new QMS requirements with ZR
    
    * Using prettier to fix linter error
    
    * Adding ZR endpoint
    
    * Fixing duplicate operationId
    
    * QMS Usages
    
    * Validation changes
    
    * Updating schema
    
    * Updating for collection
    
    * fixing pr comments
    
    * Resolving comments
    
    * Updating description
    
    * Resolving comments
    
    ---------
    
    Co-authored-by: Rohini Sharma <[email protected]>
    
    * Release web 2023 01 01 (#25629)
    
    * Adding locations/usages endpoint and example
    
    * Revert "Adding locations/usages endpoint and example"
    
    This reverts commit 4a11107.
    
    * Adding back usages changes with up to date branch
    
    * Updates based on verification tools
    
    * Fixing spacing, adding missing comma
    
    * ran prettier-fix for formatting
    
    * Update for new QMS requirements with ZR
    
    * Using prettier to fix linter error
    
    * Adding ZR endpoint
    
    * Fixing duplicate operationId
    
    * QMS Usages
    
    * Validation changes
    
    * Updating schema
    
    * Updating for collection
    
    * fixing pr comments
    
    * Resolving comments
    
    * Updating description
    
    * Resolving comments
    
    * Removing quota type parameter
    
    ---------
    
    Co-authored-by: Rohini Sharma <[email protected]>
    
    * Adding workload profile & resource config to Site (#25868)
    
    * Adding workload profile & resource config to Site
    
    * prettier fix
    
    * cosmetic fix
    
    * updating examples
    
    * prettier fix
    
    * Fix Python SDK failure for Dapr log level config (#26198)
    
    * Rename log level enum for dapr
    
    * Fix Python SDK failure for Dapr log level config
    
    * Rename log level num for dapr (#26374)
    
    * Rename log level num for dapr
    
    * Rename log level num for dapr
    
    * initial change to add ase regions (#26333)
    
    * initial change to add ase regions
    
    * addressing comments
    
    * nit adding example as suggested
    
    * formatting code
    
    * add custom word
    
    * prettier everything
    
    * prettier everything
    
    * Revert "Fix OneDeploy request and response bodies (#23224)" (#26580)
    
    This reverts commit 7dfc303.
    
    ---------
    
    Co-authored-by: Alex Karcher <[email protected]>
    Co-authored-by: dannysongg <[email protected]>
    Co-authored-by: Vishal Gupta <[email protected]>
    Co-authored-by: Vishal Gupta <[email protected]>
    Co-authored-by: Chris Rosenblatt <[email protected]>
    Co-authored-by: Chris Rosenblatt <[email protected]>
    Co-authored-by: SushmithaVReddy <[email protected]>
    Co-authored-by: Sushmitha Vangala <[email protected]>
    Co-authored-by: rohinisharma <[email protected]>
    Co-authored-by: Rohini Sharma <[email protected]>
    Co-authored-by: mukundnigam <[email protected]>
    Co-authored-by: Kirstyn Amperiadis <[email protected]>
    Co-authored-by: Haochi <[email protected]>
    zman-ms pushed a commit that referenced this pull request Jan 10, 2024
    * Add new api-version 2023-01-01 (#22962)
    
    * Add new api-version 2023-01-01
    
    * Change default package api-version
    
    * Updated workflowstate to be a reference (#23084)
    
    * Fix OneDeploy request and response bodies (#23224)
    
    * Fix OneDeploy request and response bodies
    
    * Fixing typo
    
    * Add Container Apps Environment Id in checknameavailability API (#24102)
    
    Co-authored-by: Vishal Gupta <[email protected]>
    
    * Add minTlsCipherSuite property (#24198)
    
    * Add minTlsCipherSuite property
    
    * Move to SiteConfig
    
    ---------
    
    Co-authored-by: Chris Rosenblatt <[email protected]>
    
    * Dapr configuration for a site (#24606)
    
    * Dapr configuration for a site
    
    * removed dapr older definition
    
    * adding back old dapr definition
    
    * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition
    
    * to initiate checks as re-run
    
    * fixed prettier check fail
    
    ---------
    
    Co-authored-by: Sushmitha Vangala <[email protected]>
    
    * Fix for JS SDK check failure for Dapr Config (#25493)
    
    * Dapr configuration for a site
    
    * removed dapr older definition
    
    * adding back old dapr definition
    
    * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition
    
    * to initiate checks as re-run
    
    * fixed prettier check fail
    
    * JS Sdk check fail fix
    
    ---------
    
    Co-authored-by: Sushmitha Vangala <[email protected]>
    
    * Release web 2023 01 01 (#25157)
    
    * Adding locations/usages endpoint and example
    
    * Revert "Adding locations/usages endpoint and example"
    
    This reverts commit 4a11107.
    
    * Adding back usages changes with up to date branch
    
    * Updates based on verification tools
    
    * Fixing spacing, adding missing comma
    
    * ran prettier-fix for formatting
    
    * Update for new QMS requirements with ZR
    
    * Using prettier to fix linter error
    
    * Adding ZR endpoint
    
    * Fixing duplicate operationId
    
    * QMS Usages
    
    * Validation changes
    
    * Updating schema
    
    * Updating for collection
    
    * fixing pr comments
    
    * Resolving comments
    
    * Updating description
    
    * Resolving comments
    
    ---------
    
    Co-authored-by: Rohini Sharma <[email protected]>
    
    * Release web 2023 01 01 (#25629)
    
    * Adding locations/usages endpoint and example
    
    * Revert "Adding locations/usages endpoint and example"
    
    This reverts commit 4a11107.
    
    * Adding back usages changes with up to date branch
    
    * Updates based on verification tools
    
    * Fixing spacing, adding missing comma
    
    * ran prettier-fix for formatting
    
    * Update for new QMS requirements with ZR
    
    * Using prettier to fix linter error
    
    * Adding ZR endpoint
    
    * Fixing duplicate operationId
    
    * QMS Usages
    
    * Validation changes
    
    * Updating schema
    
    * Updating for collection
    
    * fixing pr comments
    
    * Resolving comments
    
    * Updating description
    
    * Resolving comments
    
    * Removing quota type parameter
    
    ---------
    
    Co-authored-by: Rohini Sharma <[email protected]>
    
    * Adding workload profile & resource config to Site (#25868)
    
    * Adding workload profile & resource config to Site
    
    * prettier fix
    
    * cosmetic fix
    
    * updating examples
    
    * prettier fix
    
    * Fix Python SDK failure for Dapr log level config (#26198)
    
    * Rename log level enum for dapr
    
    * Fix Python SDK failure for Dapr log level config
    
    * Rename log level num for dapr (#26374)
    
    * Rename log level num for dapr
    
    * Rename log level num for dapr
    
    * initial change to add ase regions (#26333)
    
    * initial change to add ase regions
    
    * addressing comments
    
    * nit adding example as suggested
    
    * formatting code
    
    * add custom word
    
    * prettier everything
    
    * prettier everything
    
    * Revert "Fix OneDeploy request and response bodies (#23224)" (#26580)
    
    This reverts commit 7dfc303.
    
    ---------
    
    Co-authored-by: Alex Karcher <[email protected]>
    Co-authored-by: dannysongg <[email protected]>
    Co-authored-by: Vishal Gupta <[email protected]>
    Co-authored-by: Vishal Gupta <[email protected]>
    Co-authored-by: Chris Rosenblatt <[email protected]>
    Co-authored-by: Chris Rosenblatt <[email protected]>
    Co-authored-by: SushmithaVReddy <[email protected]>
    Co-authored-by: Sushmitha Vangala <[email protected]>
    Co-authored-by: rohinisharma <[email protected]>
    Co-authored-by: Rohini Sharma <[email protected]>
    Co-authored-by: mukundnigam <[email protected]>
    Co-authored-by: Kirstyn Amperiadis <[email protected]>
    Co-authored-by: Haochi <[email protected]>
    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.

    3 participants