Skip to content

RFC-65 : Change the type of externalDocs #65

Open
@andrea-gioia

Description

@andrea-gioia

Change the type of externalDocs

Champion: @andrea-gioia

Summary

Change the type of externalDocs attribute to an array of External Resource Object.

This modification must be done for each occurrence of the attribute externalDocs

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

as-is

Field Name Type Description
... ... ...
externalDocs External Resource Object Additional external documentation.

to-be

Field Name Type Description
... ... ...
externalDocs [External Resource Object] Additional external documentation.

example

"externalDocs":[
   {
      "description": "Find more info here...",
      "mediaType": "text/html",
      "$href": "https://example1.com"
   }, {
      "description": "... and  here",
      "mediaType": "text/html",
      "$href": "https://example2.com"
}]

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

Metadata

Metadata

Assignees

Type

No type

Projects

Status

No status

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions