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(rulesets): add AsyncAPI v3 support #2697

Merged
merged 10 commits into from
Oct 14, 2024

Conversation

jonaslagoni
Copy link
Collaborator

@jonaslagoni jonaslagoni commented Sep 22, 2024

Fixes #2559.

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

Additional context

Does not update the following rules:

  • asyncapi-message-examples
  • asyncapi-message-messageId-uniqueness
  • asyncapi-operation-operationId-uniqueness
  • asyncapi-operation-security
  • asyncapi-schema-default (does technically not work correctly, as it does not check default across all schemas i.e. message payloads)
  • asyncapi-schema-examples (does technically not work correctly, as it does not check default across all schemas i.e. message payloads)
  • asyncapi-payload (require custom function to tune out multi-format schema objects as schemaFormat is no longer part of message)
  • asyncapi-payload-default (require custom function to tune out multi-format schema objects as schemaFormat is no longer part of message)
  • asyncapi-payload-examples(require custom function to tune out multi-format schema objects as schemaFormat is no longer part of message)
  • asyncapi-operation-operationId (No longer relevant)

Limits to rules:

  • asyncapi-3-payload-unsupported-schemaFormat - Does not apply for multi-format schemas

@jonaslagoni jonaslagoni changed the title feat: add AsyncAPI v3 support feat(rulesets): add AsyncAPI v3 support Sep 23, 2024
@jonaslagoni jonaslagoni marked this pull request as ready for review September 23, 2024 11:32
@jonaslagoni jonaslagoni requested review from smoya and a team as code owners September 23, 2024 11:32
@jonaslagoni
Copy link
Collaborator Author

The last CircleCI test are simply timing out, no idea how to fix that.

All ready to be reviewed.

Copy link
Contributor

@frankkilcommins frankkilcommins left a comment

Choose a reason for hiding this comment

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

Looking good so far. Some minor remarks:

  • Formats Package:
    • Bump package version to 1.8.0
    • Update deps in consuming packages: functions, ruleset-bundler, rulesets, and core (devDependencies)
  • Rulesets Package:
    • Bump package version to 1.21.0

@jonaslagoni
Copy link
Collaborator Author

@frankkilcommins are those not automatically bumped on release? 🤔

@jonaslagoni
Copy link
Collaborator Author

Alright, updated dependencies, but I am getting some weird dependency problems in code I have not touched...

Any suggestions?

@frankkilcommins
Copy link
Contributor

@frankkilcommins are those not automatically bumped on release? 🤔

Oh maybe - I've not seen the release job but I manually bumped when adding Arazzo core rulesets. @mnaumanali94 can you confirm.

@mnaumanali94
Copy link
Contributor

@frankkilcommins semantic-release does bump it automatically if the commit messages are done right.

@jonaslagoni
Copy link
Collaborator Author

So I guess I revert the manual version bumping? 🤔

Anything else that needs to happen?

@mnaumanali94
Copy link
Contributor

@jonaslagoni I have fixed the CI - There are some conflicts in docs, so if you can fix those and merge the develop branch, the checks should pass.

So I guess I revert the manual version bumping? 🤔

Yes that should be it.

@jonaslagoni
Copy link
Collaborator Author

@jonaslagoni I have fixed the CI - There are some conflicts in docs, so if you can fix those and merge the develop branch, the checks should pass.

So I guess I revert the manual version bumping? 🤔

Yes that should be it.

All good, looking at it tomorrow most likely ✌️

@jonaslagoni
Copy link
Collaborator Author

All ready ✌️ @mnaumanali94 @frankkilcommins

@frankkilcommins frankkilcommins merged commit 3d69be7 into stoplightio:develop Oct 14, 2024
8 checks passed
@jonaslagoni jonaslagoni deleted the add_asyncapi_v3 branch October 15, 2024 05:18
@msolujic
Copy link

thanks @frankkilcommins
which version of spectral this will be part of?

@frankkilcommins
Copy link
Contributor

@msolujic we hope to include in the next release. We should get that out the door over the next week or so.

cc @mnaumanali94

@dilanka-cacib
Copy link

Hi,

Do you have ETA to release this feature?
I can see you have updated your doc with new v3 rules but I cannot see those rules in @stoplight/spectral-rulesets

Thanks,

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.

Support for AsyncAPI v3.0.0
5 participants