template/json-schema/schema.json at main · stac-extensions/template · 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stac-extensions.github.io/template/v0.1.0/schema.json#",
  "title": "Template Extension",
  "description": "STAC Template Extension for STAC Catalogs, STAC Collections and STAC Items.",
  "type": "object",
  "required": [
    "stac_extensions",
    "type"
  ],
  "properties": {
    "stac_extensions": {
      "type": "array",
      "contains": {
        "const": "https://stac-extensions.github.io/template/v0.1.0/schema.json"
      }
    },
    "type": {
      "$comment": "List the allowed STAC object types here, any of: Catalog, Collection, Feature (for Items)",
      "type": "string",
      "enum": [
        "Catalog",
        "Collection",
        "Feature"
      ]
    },
    "assets": {
      "$comment": "This validates the fields in Item Assets, but does not require them.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/fieldsAndBands"
      }
    },
    "links": {
      "$comment": "This validates the fields in links, remove this if not applicable.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/fields"
      }
    },
    "assetTemplates": {
      "$comment": "This validates the fields in asset templates, remove this if not applicable.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/fieldsAndBands"
      }
    },
    "linkTemplates": {
      "$comment": "This validates the fields in link templates, remove this if not applicable.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/fields"
      }
    }
  },
  "oneOf": [
    {
      "$comment": "This validates the fields in the item properties, remove this if not applicable.",
      "type": "object",
      "required": ["type", "properties"],
      "properties": {
        "type": {
          "const": "Feature"
        },
        "properties": {
          "$ref": "#/definitions/fieldsAndBands"
        }
      }
    },
    {
      "$comment": "This is the schema for top-level fields and item assets in STAC Collections, remove this fully or in parts if not applicable.",
      "type": "object",
      "required": ["type"],
      "properties": {
        "type": {
          "const": "Collection"
        },
        "summaries": {
          "$ref": "#/definitions/summaries"
        },
        "item_assets": {
          "$comment": "This validates the fields in item assets, remove this if not applicable.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/fieldsAndBands"
          }
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/fieldsAndBands"
        }
      ]
    },
    {
      "$comment": "This is the schema for top-level fields in STAC Catalogs, remove this fully or in parts if not applicable.",
      "type": "object",
      "required": ["type"],
      "properties": {
        "type": {
          "const": "Catalog"
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/fields"
        }
      ]
    }
  ],
  "definitions": {
    "template:new_field": {
      "type": "string"
    },
    "template:xyz": {
      "type": "object",
      "required": [
        "x",
        "y",
        "z"
      ],
      "properties": {
        "x": {
          "type": "number"
        },
        "y": {
          "type": "number"
        },
        "z": {
          "type": "number"
        }
      }
    },
    "template:another_one": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "fields": {
      "$comment": "Add your new fields here. Don't require them here as they would be required in all places where we reference the fields as possibly allowed.",
      "type": "object",
      "properties": {
        "template:new_field": {
          "$ref": "#/definitions/template:new_field"
        },
        "template:xyz": {
          "$ref": "#/definitions/template:xyz"
        },
        "template:another_one": {
          "$ref": "#/definitions/template:another_one"
        }
      },
      "patternProperties": {
        "^(?!template:)": {
          "$comment": "Above, change `template` to the prefix of this extension"
        }
      },
      "additionalProperties": false
    },
    "fieldsAndBands": {
      "allOf": [
        {
          "$ref": "#/definitions/fields"
        },
        {
          "properties": {
            "bands": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/fields"
              }
            }
          }
        }
      ]
    },
    "summaries": {
      "$comment": "These are examples summaries that allows lists, ranges and JSON schemas, depending on how it makes sense for the individual data types of the fields. Validation only works for lists and ranges. JSON Schema (type: object) can always be provided for fields, but the corresponding schema for lists (type: array and items) and ranges (properties) should only be provided if it actually makes sense.",
      "type": "object",
      "properties": {
        "template:new_field": {
          "type": ["array", "object"],
          "items": {
            "$ref": "#/definitions/template:new_field"
          },
          "properties": {
            "minimum": {
              "$ref": "#/definitions/template:new_field"
            },
            "maximum": {
              "$ref": "#/definitions/template:new_field"
            }
          }
        },
        "template:xyz": {
          "type": ["array", "object"],
          "items": {
            "$ref": "#/definitions/template:xyz"
          }
        },
        "template:another_one": {
          "type": ["array", "object"],
          "items": {
            "$ref": "#/definitions/template:another_one"
          }
        }
      },
      "patternProperties": {
        "^(?!template:)": {
          "$comment": "Above, change `template` to the prefix of this extension"
        }
      },
      "additionalProperties": false
    }
  }
}