cancel
Showing results for 
Search instead for 
Did you mean: 

OpenAPI 3.x Enumeration Documentation

Highlighted
New Member

OpenAPI 3.x Enumeration Documentation

I am writing a service specification that wraps some legacy software.  The legacy API requires two character codes, and though I have good descriptions of the codes, they don't turn into enumerations very well.  I would like the service specification to continue to support the usage of the two character codes, but I would like to also to document thier meanings.  Is there a way to include this additional meta-data about enumerations in the OpenAPI 3.x specitication?

1 REPLY 1
Moderator

Re: OpenAPI 3.x Enumeration Documentation

Hi @cjduggan,

 

You can add descriptions for enums: https://swagger.io/docs/specification/data-models/enums/ 


Did my reply answer your question? Give Kudos or Accept it as a Solution to help others. ⬇️⬇️⬇️
New Here?
Join us and watch the welcome video:
Announcements