interface-license/interface-license-v2-schema.json at main · api-commons/interface-license · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "InterfaceLicense",
  "description": "This is the JSON Schema for defining validating version 2.0 of the API Commons interface licenses.",
  "properties": {
    "apis": {
      "type": "array",
      "description": "A listing of APIs that are covered by the interface license.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "A plain language name for the API."
          },
          "description": {
            "type": "string",
            "description": "A plain language description for the API."
          },
          "image": {
            "type": "string",
            "description": "A relevant image representation for the API."
          },
          "tags": {
            "type": "array",
            "description": "Keywords that are applied to the API.",
            "items": {
              "type": "string"
            }
          },
          "licenses": {
            "type": "array",
            "description": "A set of license to apply to an API.",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the license."
                },
                "license": {
                  "type": "string",
                  "description": "The license being applied to the API."
                },
                "attribution": {
                  "type": "string",
                  "description": "The attribution for the license type."
                },
                "url": {
                  "type": "string",
                  "description": "The URL reference where the license will"
                }
              },
              "required": [
                "type",
                "license",
                "attribution",
                "url"
              ]
            }
          },
          "definitions": {
            "type": "array",
            "description": "Machine-readable definitions that define the API.",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of definition being referenced."
                },
                "url": {
                  "type": "string",
                  "description": "A URL for the definition of the API."
                }
              },
              "required": [
                "type",
                "url"
              ]
            }
          }
        },
        "required": [
          "name",
          "description",
          "image",
          "tags",
          "licenses",
          "definitions"
        ]
      }
    },
    "tags": {
      "type": "array",
      "description": "Relevant words that describe this API licensing.",
      "items": {
        "type": "string"
      }
    },
    "updated": {
      "type": "string",
      "description": "The timestamp that applies to when license is updated."
    }
  },
  "required": [
    "apis",
    "tags",
    "updated"
  ]
}