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

feat(ls): provide OpenAPI 3.1.0 lint rules for Security Scheme object #2192

Merged
merged 4 commits into from
Oct 27, 2022

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Oct 25, 2022

Description

  • lint rules for OpenAPI 3.1.0 Security Scheme Object
  • completion rules for OpenAPI 3.1.0 Security Scheme Object
  • add targetSpecs for OAS3.0.x /openapi/security-scheme/lint/type--equals-3-0.ts

Motivation and Context

Ref: #2061
Ref: #2062

How Has This Been Tested?

Screenshots (if appropriate):

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai
Copy link
Contributor Author

tim-lai commented Oct 25, 2022

@char0n I'm not seeing the difference between the OAS3.0 and OAS3.1 specs of why there needs to be separate openapi/security-scheme/lint/allowed-fields-3-0.ts and openapi/security-scheme/lint/allowed-fields-3-1.ts. So they both currently exist in this PR. I also don't see the reference to $ref, but see that it was added as part of the Reference Object update.

@tim-lai tim-lai requested a review from char0n October 25, 2022 21:26
@char0n
Copy link
Member

char0n commented Oct 26, 2022

@char0n I'm not seeing the difference between the OAS3.0 and OAS3.1 specs of why there needs to be separate openapi/security-scheme/lint/allowed-fields-3-0.ts and openapi/security-scheme/lint/allowed-fields-3-1.ts. So they both currently exist in this PR. I also don't see the reference to $ref, but see that it was added as part of the Reference Object update.

You can find the answer here: d476aef#r87246050

@tim-lai
Copy link
Contributor Author

tim-lai commented Oct 26, 2022

You can find the answer here

Interesting read, a lot of backstory going back quite a ways there. 😄

@tim-lai tim-lai merged commit 50baf52 into main Oct 27, 2022
@tim-lai tim-lai deleted the feat/oas31-lint-security-scheme branch October 27, 2022 16:13
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.

2 participants