search

datacontract / datacontract-specification

The Data Contract Specification Repository
https://datacontract.com/
MIT License
214 stars 34 forks source link

Add links in info block #30

Closed simonharrer closed 1 month ago

simonharrer commented 6 months ago

Links are useful to specify.

dataContractSpecification: 0.9.2
id: covid_cases
info:
  title: COVID-19 cases
  description: Johns Hopkins University Consolidated data on COVID-19 cases, sourced from Enigma
  version: "0.0.1"
  links:
    blog: https://aws.amazon.com/blogs/big-data/a-public-data-lake-for-analysis-of-covid-19-data/
    data-explorer: https://dj2taa9i652rf.cloudfront.net/
    data: https://covid19-lake.s3.us-east-2.amazonaws.com/enigma-jhu/json/part-00000-adec1cd2-96df-4c6b-a5f2-780f092951ba-c000.json

We should support such links in the spec, so everybody knows a place where to put them. And putting them prominently in the info block seems like a great idea.

jochenchrist commented 4 months ago

TBD: OpenAPI uses externalDocs for links on top level, but it is more specific than just "links".

jochenchrist commented 4 months ago

Links are also relevant for definitions. There they are on top level.

simonharrer commented 1 month ago

Decision:

links and tags on top level.