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

User/altom/arr docs improvement #12920

Merged

Conversation

AleksandarTomicMs2
Copy link
Member

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: Updating swagger file to produce better documentation. Only updated descriptions, operation IDs, and added enum value descriptions (no changes to the API were made).
  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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  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
    • 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, @AleksandarTomicMs2 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 9, 2021

    Swagger Validation Report

    ️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]

    Rule Message
    1008 - ModifiedOperationId The operation id has been changed from 'CreateConversion' to 'RemoteRendering_CreateConversion'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L22:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L22:7
    1008 - ModifiedOperationId The operation id has been changed from 'GetConversion' to 'RemoteRendering_GetConversion'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L157:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L158:7
    1008 - ModifiedOperationId The operation id has been changed from 'ListConversions' to 'RemoteRendering_ListConversions'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L264:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L265:7
    1008 - ModifiedOperationId The operation id has been changed from 'CreateSession' to 'RemoteRendering_CreateSession'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L358:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L359:7
    1008 - ModifiedOperationId The operation id has been changed from 'GetSession' to 'RemoteRendering_GetSession'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L487:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L488:7
    1008 - ModifiedOperationId The operation id has been changed from 'UpdateSession' to 'RemoteRendering_UpdateSession'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L582:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L583:7
    1008 - ModifiedOperationId The operation id has been changed from 'StopSession' to 'RemoteRendering_StopSession'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L704:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L705:7
    1008 - ModifiedOperationId The operation id has been changed from 'ListSessions' to 'RemoteRendering_ListSessions'. This will impact generated code.
    New: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L804:7
    Old: Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json#L805:7
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"mixedreality/data-plane/readme.md",
    "tag":"package-2021-01-01-preview",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 9, 2021

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

    @openapi-workflow-bot
    Copy link

    Hi @AleksandarTomicMs2, 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.

    @AleksandarTomicMs2
    Copy link
    Member Author

    The API is in preview, and SDK dev is in progress, no SDK based on this api-version is released yet. We'd want to get this in ASAP since SDK dev would like to be based on this version, and is near completion.

    @tjprescott
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @tjprescott
    Copy link
    Member

    @lmazuel can you merge this PR? It makes "breaking changes" to an unreleased preview.

    @lmazuel lmazuel merged commit 92aa780 into Azure:master Feb 10, 2021
    ghost pushed a commit to Azure/azure-sdk-for-net that referenced this pull request Feb 12, 2021
    …classes more mockable (#18694)
    
    This PR regenerated the SDK based on minor API changes (Azure/azure-rest-api-specs#12920) and makes the classes more mockable.
    
    # All SDK Contribution checklist:
    
    This checklist is used to make sure that common guidelines for a pull request are followed.
    - [ ] **Please open PR in `Draft` mode if it is:**
    	- Work in progress or not intended to be merged.
    	- Encountering multiple pipeline failures and working on fixes.
    - [x] If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
    - [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md).**
    - [x] **The pull request does not introduce [breaking changes](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md).**
    
    ### [General Guidelines and Best Practices](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#general-guidelines)
    - [x] Title of the pull request is clear and informative.
    - [x] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).
    
    ### [Testing Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#testing-guidelines)
    - [x] Pull request includes test coverage for the included changes.
    
    ### [SDK Generation Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#sdk-generation-guidelines)
    - [] The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
    - [ ] The `*.csproj` and `AssemblyInfo.cs` files have been updated with the new version of the SDK. Please double check nuget.org current release version.
    
    ## Additional management plane SDK specific contribution checklist: 
    Note: Only applies to `Microsoft.Azure.Management.[RP]` or `Azure.ResourceManager.[RP]`
     
    - [ ] Include updated [management metadata](https://github.com/Azure/azure-sdk-for-net/tree/master/eng/mgmt/mgmtmetadata).
    - [ ] Update AzureRP.props to add/remove version info to maintain up to date API versions.
    
    ### Management plane SDK Troubleshooting
    - If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add `new service` label and/or contact assigned reviewer.
    - If the check fails at the `Verify Code Generation` step, please ensure:
    	- Do not modify any code in generated folders.
    	- Do not selectively include/remove generated files in the PR.
    	- Do use `generate.ps1/cmd` to generate this PR instead of calling `autorest` directly.
    	Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version,
    
    ### Old outstanding PR cleanup
     Please note:
    	If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Updating descriptions
    
    Updating enum names
    
    Updating STS description
    
    * Fixing tags and operation IDs
    
    * Tags update v2
    
    * Further documentation improvements
    
    * Addressing PR comments
    
    * Further description improvements
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants