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

Inconsistency between Message.examples and MessageTrait.examples #604

Closed
char0n opened this issue Aug 4, 2021 · 4 comments
Closed

Inconsistency between Message.examples and MessageTrait.examples #604

char0n opened this issue Aug 4, 2021 · 4 comments
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) stale

Comments

@char0n
Copy link
Collaborator

char0n commented Aug 4, 2021

Message.examples description

An array of key/value pairs where keys MUST be either headers and/or payload. Values MUST contain examples that validate against the headers or payload fields, respectively. Example MAY also have the name and summary additional keys to provide respectively a machine-friendly name and a short summary of what the example is about.

Message.trait description

An array with examples of valid message objects.

I propose we unify these description and use Message.examples description in Message.trait description.

If agreed I can issue a PR.

@char0n char0n added the 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) label Aug 4, 2021
@magicmatatjahu
Copy link
Member

@char0n Good catch! Message Traits examples should have this same shape as Message.examples. PR will be more than welcome :)

@char0n
Copy link
Collaborator Author

char0n commented Aug 10, 2021

PR issued #608

@github-actions
Copy link

github-actions bot commented Dec 9, 2021

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Dec 9, 2021
@char0n
Copy link
Collaborator Author

char0n commented Dec 10, 2021

PR #608 has been accepted and merged and became part of 2.2.0.

@char0n char0n closed this as completed Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) stale
Projects
None yet
Development

No branches or pull requests

2 participants