opendatamesh-initiative / odm-specification-dpdescriptor

The Data Product Descriptor Specification (DPDS) Repository
https://dpds.opendatamesh.org/
Apache License 2.0
67 stars 2 forks source link

Change the type of `externalDocs` attribute to an array of `External Resource Object` #65

Open andrea-gioia opened 4 months ago

andrea-gioia commented 4 months ago

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

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

andrea-gioia commented 4 months ago

RFC document: externaldocs-type.md