Skip to content

Commit 664cf9d

Browse files
committed
adding the policy JSON schema
1 parent acbf370 commit 664cf9d

2 files changed

Lines changed: 541 additions & 3 deletions

File tree

policy/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The `updated` field in the payload wrapper should be set to the time of publishi
139139

140140
#### Example `policies.json`
141141

142-
```json
142+
```jsonc
143143
{
144144
"version": "0.4.0",
145145
"updated": 1570035222868,
@@ -161,7 +161,7 @@ The optional `end_date` field applies to all policies represented in the file.
161161

162162
#### Example `geographies.json`
163163

164-
```json
164+
```jsonc
165165
{
166166
"version": "0.4.0",
167167
"updated": 1570035222868,
@@ -186,7 +186,7 @@ All response fields must use `lower_case_with_underscores`.
186186

187187
Response bodies must be a `UTF-8` encoded JSON object and must minimally include the MDS `version`, a timestamp indicating the last time the data was `updated`, and a `data` payload:
188188

189-
```json
189+
```jsonc
190190
{
191191
"version": "x.y.z",
192192
"updated": 1570035222868,
@@ -196,6 +196,12 @@ Response bodies must be a `UTF-8` encoded JSON object and must minimally include
196196
}
197197
```
198198

199+
### JSON Schema
200+
201+
The JSON Schema file is available in this repository: [`policy.json`](./policy.json).
202+
203+
Before publishing a new Policy document, the document should be validated against the schema to ensure it has the correct format and fields.
204+
199205
[Top][toc]
200206

201207
### Policy

0 commit comments

Comments
 (0)