We need the mediaType attribute to referentiating external resources with an encoding different from the one of the root entity of the descriptor file
Design and examples
Field Name
Type
Description
description
string
A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object type does not allow a description field, then this field has no effect.
mediaType
string
The media type of the referenced resource. It must conform to media type format, according to RFC6838.
$ref
string:uri-reference
REQUIRED. The reference identifier. This MUST be in the form of a URI.
Alternatives
Add mediaType attribute to Reference Object and at the same time remove External Reference Object. Reference Object can then be used to resolve all the references, internal end external as well.
Decision
We decided to add mediaType attribute to Reference Object and keep External Reference Object to differentiate clearly internal references that should be evaluated by external tools from external references that can be ignored.
Add
mediaTypeattribute toReference ObjectChampion: @andrea-gioia
Summary
Add
mediaTypeattribute toReference ObjectMotivation
We need the
mediaTypeattribute to referentiating external resources with an encoding different from the one of the root entity of the descriptor fileDesign and examples
stringdescriptionfield, then this field has no effect.stringstring:uri-referenceAlternatives
Add
mediaTypeattribute toReference Objectand at the same time removeExternal Reference Object.Reference Objectcan then be used to resolve all the references, internal end external as well.Decision
We decided to add
mediaTypeattribute toReference Objectand keepExternal Reference Objectto differentiate clearly internal references that should be evaluated by external tools from external references that can be ignored.Consequences
NA
References
NA