readme.md: update schema

This commit is contained in:
Jon 2022-11-16 10:47:46 +00:00
parent 72fa9fc4a5
commit 6c1354e6de

View File

@ -5,25 +5,30 @@ This repo contains backing information for Glowers Radio.
The `songs.json` format **is only intended for use for Glowers Radio**, and is effectively a living standard as a result. **Live data may change drastically without warning** The `songs.json` format **is only intended for use for Glowers Radio**, and is effectively a living standard as a result. **Live data may change drastically without warning**
```yaml ```yaml
required: [ id, sources ] required: [ version, songs]
properties: properties:
id: version: { type: integer }
type: string songs:
tags:
type: array
items: [ { type: string } ]
metadata:
required: [ title, artist ]
properties:
title: { type: string }
artist: { type: string }
sources:
type: array
items: items:
- required: [ type, url ] required: [ id, sources ]
properties: properties:
type: { type: string, format: mimetype } id:
url: { type: string, format: uri } type: string
thumbnail_type: { type: string } tags:
thumbnail_url: { format: uri } type: array
items: [ { type: string } ]
metadata:
required: [ title, artist ]
properties:
title: { type: string }
artist: { type: string }
sources:
type: array
items:
- required: [ type, url ]
properties:
type: { type: string, format: mimetype }
url: { type: string, format: uri }
thumbnail_type: { type: number }
thumbnail_url: { format: uri }
``` ```