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): OpenAPI 3.1.0 lint rules for components object #2118

Merged
merged 1 commit into from
Oct 10, 2022

Conversation

tim-lai
Copy link
Contributor

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

Description

compared to OpenAPI 3.0.x rules, add allowedFields-3-1, PathItems, and update codes.ts

Motivation and Context

Ref: #2063

How Has This Been Tested?

local pass/fail scenarios.

fixture:

pass:

components:
  pathItems:
    /apath:

fail

components:
  pathItems:
    apath

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 tim-lai merged commit 975e12e into main Oct 10, 2022
@tim-lai tim-lai deleted the feat/oas31-lint-components branch October 10, 2022 21:02
@tim-lai tim-lai added enhancement New feature or request OpenAPI 3.1 ApiDOM labels Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant