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

Added new API version 2022-03-01 to the Mobile Network service #18234

Merged
merged 34 commits into from
Mar 21, 2022

Conversation

satravi
Copy link
Contributor

@satravi satravi commented Mar 14, 2022

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.

satravi and others added 28 commits February 9, 2022 16:31
…only the API version 2022-01-01-preview in Public
…pi into satravi/mobilenetwork-rest-api-specs
@openapi-workflow-bot
Copy link

Hi, @satravi 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-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 14, 2022
    @satravi
    Copy link
    Contributor Author

    satravi commented Mar 15, 2022

    This PR is not ready for review by ARM .. .Please note that the step 3 in the checklist is not fulfilled:

    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.

    Specifically , if you are adding a new api version then you must add the previous version as the first commit in the new folder , so that we are able to diff the changes between the versions. I have added "ARMChangesRequested" Tag , please remove the tag once you have fixed this issue.

    @raosuhas, Yes we have followed the manual process for new API version - https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version

    Also the diff between the previous version 2022-01-01 and new version 2022-03-01 can be found in - a180e7b

    @satravi satravi removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 15, 2022
    @raosuhas
    Copy link

    This is incorrect , you need to update the new folder with the older api verison not the other way round I do not have any way to track latest changes made after the first update now.

    From the link you pasted :
    Please note that it is time-consuming to review the file line by line for every api-version. When you are creating the swagger specification for the new api-version, please copy the swagger specification from the previous version into the new api-versioned folder and commit it. After that overwrite it with the changes for the new api-version. This makes it easy for us to review the changes.

    Can you please fix and let me know again by removing the tag ?


    In reply to: 1067575578

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 16, 2022
    @satravi
    Copy link
    Contributor Author

    satravi commented Mar 16, 2022

    This is incorrect , you need to update the new folder with the older api verison not the other way round I do not have any way to track latest changes made after the first update now.

    From the link you pasted : Please note that it is time-consuming to review the file line by line for every api-version. When you are creating the swagger specification for the new api-version, please copy the swagger specification from the previous version into the new api-versioned folder and commit it. After that overwrite it with the changes for the new api-version. This makes it easy for us to review the changes.

    Can you please fix and let me know again by removing the tag ?

    In reply to: 1067575578

    @raosuhas ,

    • We have reverted the Mobile Network API version 2022-03-01-preview
    • Added a new Mobile Network API version 2022-03-01-preview with previous version specs and examples
    • Updated the README files to refer the latest version
    • Updated the API version 2022-03-01-preview specs and examples with the latest changes - 439e59d

    @satravi satravi removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 16, 2022
    @satravi
    Copy link
    Contributor Author

    satravi commented Mar 17, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @rainbowFi
    Copy link

    @raosuhas As mentioned in comment above, this new API version went through ARM review in PR 6496 when we merged it to RPSaaSMaster. Is there some way we can mark this so that you don't spend time doing a full review of something that has already been fully reviewed by the ARM review board?

    @raosuhas raosuhas added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 18, 2022
    @satravi
    Copy link
    Contributor Author

    satravi commented Mar 20, 2022

    Thank you @raosuhas.
    @raych1 Could you please help us on merging this PR?

    @apalanichamy1981
    Copy link

    Approved

    Copy link

    @apalanichamy1981 apalanichamy1981 left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approved

    @raych1 raych1 merged commit 1624606 into main Mar 21, 2022
    @satravi satravi deleted the satravi/mobilenetwork-rest-api-specs branch March 21, 2022 05:43
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    …#18234)
    
    * Mobile Network REST API Specification
    
    * Removed API versions 2020-06-01-preview and 2021-04-01-preview. Have only the API version 2022-01-01-preview in Public
    
    * Addressed Swagger Avocado and Swagger SpellCheck Errors
    
    * Addressed Parameters Order Errors
    
    * Merge azure-rest-api-specs-pr branch ssivathas/mobilenetwork-public-api into satravi/mobilenetwork-rest-api-specs
    
    * Removed Unreferenced JSON Files
    
    * Added support for Static IP Addressing to PMN
    
    * Addressed Swagger PrettierCheck Errors
    
    * Addressed Swagger ModelValidation Errors
    
    * change go config to track 2
    
    * Updated the API versions in SDK README files
    
    * Update readme.python.md
    
    * Update readme.md
    
    * Updated ActivationState to ConfigurationState
    
    * Addressed XmsIdentifierValidation Errors
    
    * Addressed DescriptionAndTitleMissing Errors
    
    * Generic name for N2 and N3 Interface attributes to support 4G Networks
    
    * Generic name for N6 Interface attribute to support 4G Networks
    
    * Generic name for N6 Interface attribute to support 4G Networks
    
    * Updated the Mobile Network REST specification and examples
    
    * Removed the read-only field activationState
    
    * Added 2022-03-01 version
    
    * Updated 2022-03-01 version in the README files
    
    * Removed the duplicate custom-words
    
    * Revert "Mobile Network API version 2022-03-01"
    
    * Revert custom-words
    
    * Added Mobile Network API version 2022-03-01-preview
    
    * Updated Mobile Network API version 2022-03-01-preview specs and examples
    
    Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>
    Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go-V2 CI-BreakingChange-JavaScript
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants