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 (apidom-ls): Change error message for type linting rules #2930

Merged
merged 1 commit into from
Jul 11, 2023

Conversation

damian-polewski-sb
Copy link
Contributor

@damian-polewski-sb damian-polewski-sb commented Jul 11, 2023

This PR changes the error messages for type linting rules for OpenAPI 3.0.x, OpenAPI 3.1, AsyncAPI 2.0, and AsyncAPI 2.1-2.6 to include the information about allowed values for the type field.

Description

This PR does the following:

  • Changes error messages for OpenAPI 3.0.x, OpenAPI 3.1, AsyncAPI 2.0, and AsyncAPI 2.1-2.6

Motivation and Context

This change is required to solve this ticket (SWG-8486) found during OpenAPI 3.1 bug bash. It has been decided that it would be better to include information about what are the allowed values for type field.

How Has This Been Tested?

This PR only changes error message text so there are no changes in the package behavior.

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.

Copy link
Member

@char0n char0n left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for contributing!

@char0n char0n merged commit 4504674 into main Jul 11, 2023
7 checks passed
@char0n char0n deleted the ft/change-error-message-for-type-linting-rules branch July 11, 2023 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants