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

feat(rulesets): add message traits array path to asyncapi headers schema type object rule #2460

Merged
merged 3 commits into from
Apr 25, 2023
Merged

feat(rulesets): add message traits array path to asyncapi headers schema type object rule #2460

merged 3 commits into from
Apr 25, 2023

Conversation

CalemRoelofsSB
Copy link
Contributor

Recreation of #2402 to fix issues around commitlint

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

Additional context

Currently, the asyncapi-headers-schema-type-object will not trigger when the headers object is defined explicitly in the message.traits array.
For example:

...
channels:
  'users/{userId}/loggedIn':
    publish:
      message:
        traits:
          - headers
              type: integer

The new path added in this PR will match on that array and perform the assertion on the type field of any object in that array that has a top level key of headers.

@CalemRoelofsSB
Copy link
Contributor Author

ping @P0lip

@P0lip
Copy link
Contributor

P0lip commented Apr 25, 2023

Looks good to me, although I'd wait for an approval from our AsyncAPI colleagues as they're the most familiar with it :)

jonaslagoni
jonaslagoni approved these changes Apr 25, 2023
View reviewed changes
Copy link
Collaborator

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@CalemRoelofsSB
Copy link
Contributor Author

@P0lip @jonaslagoni thank you for the review folks! Unfortunately, I don't have permissions to merge this branch into develop so if one of you could oblige, that would be most appreciated :)

@P0lip P0lip merged commit 9ceabca into stoplightio:develop Apr 25, 2023
8 checks passed
stoplight-bot pushed a commit that referenced this pull request Apr 25, 2023
@StoplightSupport
chore(release): 1.16.0 [skip ci]
66f7690 
# [@stoplight/spectral-rulesets-v1.16.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-rulesets-v1.15.1...@stoplight/spectral-rulesets-v1.16.0) (2023-04-25)

### Features

* **rulesets:** add traits array path to headers rule ([#2460](#2460)) ([9ceabca](9ceabca))
@stoplight-bot
Copy link
Collaborator

🎉 This PR is included in version @stoplight/spectral-rulesets-v1.16.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@CalemRoelofsSB CalemRoelofsSB deleted the feat/rulesets/add-path-to-asyncapi-headers-schema-type-object branch April 26, 2023 08:04
stoplight-bot pushed a commit that referenced this pull request May 23, 2023
@StoplightSupport
chore(release): 6.7.0 [skip ci]
8709461 
# [6.7.0](v6.6.0...v6.7.0) (2023-05-23)

### Bug Fixes

* **core:** improve deep ruleset inheritance ([#2326](#2326)) ([378b4b8](378b4b8))
* **core:** more accurate ruleset error paths ([66b3ca7](66b3ca7))
* **core:** reset path in fn context ([#2389](#2389)) ([3d47ec4](3d47ec4))
* **ref-resolver:** bump @stoplight/json-ref-resolver from ~3.1.4 to ~3.1.5 ([#3635](https://github.com/stoplightio/spectral/issues/3635)) ([215ae93](215ae93))
* **ruleset-bundler:** defaults should be last one ([#2403](#2403)) ([8780cfa](8780cfa))
* **ruleset-bundler:** remove extraneous 'external dependency' warnings ([#2475](#2475)) ([e791534](e791534))
* **ruleset-migrator:** avoid positive lookbehinds ([#2349](#2349)) ([455c324](455c324))
* **ruleset-migrator:** transform functions under overrides ([#2459](#2459)) ([45e817f](45e817f))
* **ruleset-migrator:** use module for require.resolve ([#2405](#2405)) ([d7c0fa4](d7c0fa4))
* **rulesets:** avoid false errors from ajv ([#2408](#2408)) ([92dab78](92dab78))
* **rulesets:** length.min said "must not be longer than" ([#2355](#2355)) ([df3b6f9](df3b6f9))

### Features

* **core:** relax formats validation ([#2151](#2151)) ([de16b4c](de16b4c))
* **core:** support end-user extensions in the rule definitions ([#2345](#2345)) ([365fced](365fced))
* **core:** support x- extensions in the ruleset ([#2440](#2440)) ([964151e](964151e))
* **formats:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([b8e51b4](b8e51b4))
* **formatters:** move formatters to a separate package ([#2468](#2468)) ([664e259](664e259))
* **rulesets:** add traits array path to headers rule ([#2460](#2460)) ([9ceabca](9ceabca))
* **rulesets:** support AsyncAPI 2.6.0 ([#2391](#2391)) ([94a7801](94a7801))
@stoplight-bot
Copy link
Collaborator

🎉 This PR is included in version 6.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@stoplight-bot
Copy link
Collaborator

🎉 This PR is included in version 1.9.4 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@stoplight-bot
Copy link
Collaborator

🎉 This PR is included in version 1.18.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P0lip P0lip P0lip approved these changes

@jonaslagoni jonaslagoni jonaslagoni approved these changes

@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu

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

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@CalemRoelofsSB @P0lip @stoplight-bot @jonaslagoni