Ask a Question

Allow yaml to define enum with different name and value

UncleMoose
Regular Visitor

Allow yaml to define enum with different name and value

A common practice is to use enum to define coded persistence values such as:

 

Status:

   type: string

   enum:

   - name: ABANDONED

     value: A

  - name: ISSUED

    value: I

 

However this generates a JSON object as the value 

ABANDONED_A("{name: ABANDONED, value: A}")

 

Is this not possible with OAS3?

3 REPLIES 3
HKosova
Moderator

Re: Allow yaml to define enum with different name and value


Is this not possible with OAS3?


OpenAPI 3.0 does not have a way to annotate individual enum values, but this is possible in OpenAPI 3.1 using oneOf + const (once tooling support is available):

Status:
  oneOf:
    - title: ABANDONED
      const: A
    - title: ISSUED
      const: I

 


Helen Kosova
SmartBear Documentation Team Lead
________________________
Did my reply answer your question? Give Kudos or Accept it as a Solution to help others. ⬇️⬇️⬇️
gtludwig
Visitor

Re: Allow yaml to define enum with different name and value

I am trying to implement this as well in my open API specification, but IntelliJ is marking "const" as a prohibited property.

nmrao
Community Hero

Re: Allow yaml to define enum with different name and value

That could be intellij's limitation.


Regards,
Rao.
cancel
Showing results for 
Search instead for 
Did you mean: