We propose this change to enable the possibility of adding multiple links to external documentation for each product component that supports the externalDocs attribute. Defining the type of externalDocs property as an array is also better aligned with its plural name.
Change the type of externalDocs attribute to an array of External Resource Object
Champion: @andrea-gioia
Summary
Change the type of
externalDocs
attribute from External Resource Object to [External Resource Object]Motivation
We propose this change to enable the possibility of adding multiple links to external documentation for each product component that supports the externalDocs attribute. Defining the type of
externalDocs
property as an array is also better aligned with its plural name.Design and examples
example
Alternatives
There are no valid alternatives
Decision
The TSC decieded to adopt this change
Consequences
All components that use the externalDocs attribute MUST be updated properly
References
No references available