search

Azure / azure-openapi-validator

Azure Open API Validator
MIT License
47 stars 46 forks source link

Include RPCGuidelineCode to the linter output #648

Closed AkhilaIlla closed 8 months ago

AkhilaIlla commented 8 months ago

The major goal of the PR is to include RPC guideline code (EG: RPC-Async-V1-11) to the linter output.

The different ways to achieve this are as follows:

  1. Maintain a mapping of linter rule names to RPC guideline code & append it to the result from spectral/linter output (Implemented in this PR)
  1. Add the RPC guideline code to the ruleset definition and delete the field before sending over the request to spectral & later append to the result (similar to how isStagingOnly is implemented)
  2. Add logic to get to the linter rule .md doc. As it already includes the RPC guideline code, it can be appended to the result.

Please take a look at the implementation & different approaches

konrad-jamrozik commented 8 months ago

My PR into this PR:

konrad-jamrozik commented 8 months ago

@AkhilaIlla are the package versions correct? That is: are the versions in package.json files pointing to a new package version, yet to be published to the feed? And do the relevant projects depend on the right packages?

https://github.com/Azure/azure-openapi-validator/blob/main/CONTRIBUTING.md#deploy-to-prod-lintdiff

Can you comment here with a link to the newest currently published version of the packages you intend to publish, and let me know what will be the version of the newly published packages, with changes from this PR? Just double checking if we share the understanding of the process. #Resolved

AkhilaIlla commented 8 months ago

Updated, the versions. For some reason I thought it would just be a regular merge changes & then sometime later we'd have the prod deployment

In reply to: 1915597607

konrad-jamrozik commented 8 months ago

Related bug triggered by deployment of this PR: