Skip to content

second batch of documentation #11004

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
Merged
merged 4 commits into from
Oct 16, 2020
Merged

second batch of documentation #11004

merged 4 commits into from
Oct 16, 2020

Conversation

@e337
Copy link
Contributor

@e337 e337 commented Sep 30, 2020 •
edited by jsedlak-microsoft
Loading

This is the second part of importing our existing documentation into azure-rest-api-specs master branch. This documentation is for APIs that are already live and already published.

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

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

  • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 30, 2020 •
edited
Loading

[Staging] Swagger Validation Report

️❌BreakingChange: 84 Errors, 0 Warnings [Detail] [Expand] Only 10 items are listed, please refer to log for more details.
Rule Message
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L1675:9
Old: Mobility/preview/1.0/mobility.json#L1659:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Render/preview/1.0/render.json#L889:9
Old: Render/preview/1.0/render.json#L880:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L253:11
Old: Mobility/preview/1.0/mobility.json#L252:11
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Traffic/preview/1.0/traffic.json#L1098:9
Old: Traffic/preview/1.0/traffic.json#L1081:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L339:9
Old: Mobility/preview/1.0/mobility.json#L337:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L362:11
Old: Mobility/preview/1.0/mobility.json#L360:11
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L370:11
Old: Mobility/preview/1.0/mobility.json#L367:11
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L425:9
Old: Mobility/preview/1.0/mobility.json#L421:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L535:9
Old: Mobility/preview/1.0/mobility.json#L531:9
❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Mobility/preview/1.0/mobility.json#L662:9
Old: Mobility/preview/1.0/mobility.json#L658:9
️️✔️LintDiff [Detail] 
 Validation passes for LintDiff.
️️✔️Avocado [Detail] 
 Validation passes for Avocado.
️️✔️ModelValidation [Detail] 
 Validation passes for ModelValidation.
️️✔️SemanticValidation [Detail] 
 Validation passes for SemanticValidation.
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

azure-pipelines bot commented Sep 30, 2020

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-go - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-java - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-js - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-net - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-python - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 30, 2020 •
edited
Loading

azure-sdk-for-python-track2 - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 1, 2020 •
edited
Loading

azure-resource-manager-schemas - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 1, 2020 •
edited
Loading

Trenton Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@azure-pipelines
Copy link

azure-pipelines bot commented Oct 1, 2020

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Oct 15, 2020

Hi, @e337 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.
  • 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]

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Oct 15, 2020

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Oct 15, 2020

    Azure Pipelines successfully started running 1 pipeline(s).

    lmazuel
    lmazuel approved these changes Oct 16, 2020
    View reviewed changes
    Copy link
    Member

    @lmazuel lmazuel left a comment

    Choose a reason for hiding this comment

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

    Acceptable breaking changes since it's preview

    @lmazuel lmazuel merged commit c563b44 into Azure:master Oct 16, 2020
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @lmazuel lmazuel lmazuel approved these changes

    Assignees

    @lmazuel lmazuel

    Labels

    None yet

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    2 participants

    @e337 @lmazuel