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

Tags do not work without description and external docs #149

Closed
knsngr opened this issue Oct 19, 2022 · 1 comment
Closed

Tags do not work without description and external docs #149

knsngr opened this issue Oct 19, 2022 · 1 comment

Comments

@knsngr
Copy link

knsngr commented Oct 19, 2022

Hi,

I tried to make use of the new tags to group some operations, but it does not work.
If I add a tag to a PublishOperation attribute and start the application I get the following message in the UI:

Error: There were errors validating the AsyncAPI document.
undefined./channels/<name>/publish/tags/0/description should be string
undefined./channels/<name>/publish/tags/0/externalDocs should be object

I added the tag like this:
[PublishOperation(typeof(X), "myTag", ...]

This also happens when adding tags directly to the AsyncApiDocument, but you can fix it by providing the missing properties. But this is not possible if you add a tag to an operation as you can only provide a name.

At this point tags are created without description and external docs:
https://github.com/tehmantra/saunter/blob/812a643172392e3866f58caeacfc61d8d96ff4c7/src/Saunter/Generation/DocumentGenerator.cs#L163

Is it somwhow possible to make description and externalDocs not mandatory?

Thank you for your help.

@m-wild
Copy link
Collaborator

m-wild commented Jun 15, 2023

This is live in v0.12.0

@m-wild m-wild closed this as completed Jun 15, 2023
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

No branches or pull requests

2 participants