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.

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

chore: Add prettier overrides for other JSON files #12604

Merged
merged 1 commit into from
Feb 5, 2021
Merged

chore: Add prettier overrides for other JSON files #12604

merged 1 commit into from
Feb 5, 2021

Conversation

nschonni
Copy link
Contributor

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

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, @nschonni 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 Jan 25, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    ️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 1/c93b354fd9c14905bb574a8834c4d69b/documentation/sdkautomation
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: work/1/c93b354fd9c14905bb574a8834c4d69b/documentation
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2021 •
    edited
    Loading

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

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 25, 2021
    @ghost
    Copy link

    ghost commented Jan 25, 2021

    Thank you for your contribution nschonni! We will review the pull request and get back to you soon.

    @openapi-workflow-bot
    Copy link

    Hi @nschonni, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    @nschonni
    Copy link
    Contributor Author

    @ruowan this looks like another Avocado false positive

    @ruowan
    Copy link
    Member

    ruowan commented Jan 27, 2021

    I approved the false alarm. The false alarm will be fixed.

    @nschonni
    Copy link
    Contributor Author

    Thanks @ruowan!
    I'll wait and see if @shahabhijeet or @akning-ms have any concerns now that it's green

    PhoenixHe-NV
    PhoenixHe-NV reviewed Feb 2, 2021
    View reviewed changes
    .prettierrc.json
    "printWidth": 20
    }
    },
    {
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Why do we need to update this?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    The custom prettier-swagger-plugin doesn't process the regular JSON files with comments. This tells prettier to use the regular JSON parser, but the same width for the other files in the repo

    @akning-ms akning-ms assigned PhoenixHe-NV and unassigned akning-ms Feb 3, 2021
    @PhoenixHe-NV PhoenixHe-NV merged commit 25bcc4c into Azure:master Feb 5, 2021
    @nschonni nschonni deleted the prettier-json-overrides branch February 5, 2021 05:52
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @nschonni @mkarmark
    chore: Add prettier overrides for other JSON files (Azure#12604)
    46cacec
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @PhoenixHe-NV PhoenixHe-NV PhoenixHe-NV approved these changes

    @shahabhijeet shahabhijeet Awaiting requested review from shahabhijeet shahabhijeet is a code owner

    Assignees

    @PhoenixHe-NV PhoenixHe-NV

    Labels
    Approved-Avocado customer-reported Issues that are reported by GitHub users external to the Azure organization.
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @nschonni @ruowan @PhoenixHe-NV @akning-ms