reorg json-feed files; add readmes for json-feed extensions

This commit is contained in:
2022-11-23 13:02:13 -08:00
parent 7150219ca5
commit 3b9a2c86b1
6 changed files with 79 additions and 4 deletions

View File

@@ -0,0 +1,36 @@
# JSON Feed Event Extension
This extension adds a new, optional `_event` field on each Item in a JSON Feed document, to contain additional metadata fields pertaining to events.
##
## Example
```jsonc
{
"version": "https://jsonfeed.org/version/1.1",
// ...
"items": [
{
// ...
// The presence of the `_event` field implies that this Item in the Feed
// represents an event, and it contains additional event-related metadata
"_event": {
// Points to the v1.json file here
"$schema": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/events/v1.json",
// Points to this readme doc
"about": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/events/readme.md",
// The start and end time for the event
"start": "2022-11-20T18:00:00.000-08:00",
"end": "2022-11-20T23:00:00.000-08:00"
}
}
]
}
```

View File

@@ -0,0 +1,23 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/events/v1.json",
"type": "object",
"description": "Contains additional Item metadata for Items that represent events",
"properties": {
"about": {
"type": "string",
"format": "uri",
"description": "URI pointing to more information about this \"_event\" extension"
},
"start": {
"type": "string",
"format": "date-time",
"description": "The date and time that the event starts"
},
"end": {
"type": "string",
"format": "date-time",
"description": "The date and time that the event ends"
}
}
}

View File

@@ -0,0 +1,17 @@
$schema: http://json-schema.org/draft-07/schema
$id: https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/events/v1.json
type: object
description: Contains additional Item metadata for Items that represent events
properties:
about:
type: string
format: uri
description: URI pointing to more information about this "_event" extension
start:
type: string
format: date-time
description: The date and time that the event starts
end:
type: string
format: date-time
description: The date and time that the event ends