search

asyncapi / html-template

HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.
63 stars 56 forks source link

[FEATURE REQUEST] enum names #27

Closed derberg closed 3 years ago

derberg commented 4 years ago

@p3root commented on Mon Aug 26 2019

Is your feature request related to a problem? Please describe. image Enumermations which are serialized as integer have no meaning to the user of the api.

Can't it be tackled using specification extensions? Like in the open api spec.

Describe the solution you'd like OpenApi example: { "openapi": "3.0.0", "info": { "title": "Swagger specification", "version": "1.0.0" }, "components": { "schemas": { "EnumDemo": { "type": "integer", "description": "", "x-enumNames": [ "Value0", "Value1", "Value2", "Value3", "Value4" ], "enum": [ 0, 1, 2, 3, 4 ] } } } }

Additional context Otherwise enums are pretty useless :/

@fmvilas commented on Mon Aug 26 2019

I'm confused. What you described is already possible. Or do you mean having support for it in the HTML documentation generator?

@p3root commented on Mon Aug 26 2019

hey!

yep. But also in the markdown generator as well.

@fmvilas commented on Mon Aug 26 2019

Awesome! I'm moving it to the generator repo. The asyncapi repo is only for the spec and organizational issues.

@p3root commented on Mon Aug 26 2019

I didn't found it in the asyncapi spec either. Anyway would be great if this feature will be implemented :)

@fmvilas commented on Mon Aug 26 2019

What you described is a specification extension. They're the same as in OpenAPI.

@p3root commented on Mon Aug 26 2019

Alright. Thanks @fmvilas :)

@github-actions[bot] commented on Thu Mar 12 2020

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

derberg commented 3 years ago

I have no idea really what has to be done here

fmvilas commented 3 years ago

I don't think we have to do anything here. At least not for now.

github-actions[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

derberg commented 3 years ago

@p3root are you still interested with this issue? would be great to get some more details

p3root commented 3 years ago

No. Don't need it anymore! You can close the issue!

Cheers

derberg commented 3 years ago

🙇