Ask a Question

ref contextualisation

SOLVED
victorherraiz
New Contributor

ref contextualisation

Is there any way to contextualise a $ref?

When we want to use a ref to define a property, we are not able to define any other attributes but $ref. It could be interesting to allow to include a description just for the property.

 

For example, if we define an "Amount" (currency + decimal) and we use it in several places, we could want to explain the meaning of this specific property (e.g. currentBalance, overdraft...)

 

Is there any way to do this without creating a new schema just for one property?

 

1 REPLY 1
victorherraiz
New Contributor

Reading the 3.1.0 specs it seems that it is already included: https://spec.openapis.org/oas/v3.1.0#reference-object, Summary and Description are know defined as well as $ref, not just $ref as in 3.0.0

 

 

cancel
Showing results for 
Search instead for 
Did you mean: