minimal/docs
3
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
James Brumond 2022-11-23 13:02:13 -08:00
parent 7150219ca5
commit 3b9a2c86b1
Signed by: james
GPG Key ID: 24BA25B8B303B023
6 changed files with 79 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
json-schema/json-feed/extensions/events/readme.md Normal file
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"
}
}
]
}
```

2
json-schema/json-feed-extensions/events/v1.json → json-schema/json-feed/extensions/events/v1.json
View File

@ -1,6 +1,6 @@
{
"$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",
"$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": {

2
json-schema/json-feed-extensions/events/v1.yaml → json-schema/json-feed/extensions/events/v1.yaml
View File

@ -1,5 +1,5 @@
$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
$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:

39
json-schema/json-feed/extensions/rsvps/readme.md Normal file
View File

@ -0,0 +1,39 @@
# JSON Feed RSVP Extension
This extension adds a new, optional `_rsvp` 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": [
{
// ...
// An RSVP entry MUST contain an `external_url` pointing to the event
// the RSVP is in response to
"external_url": "https://example.com/example-event-document",
// The presence of the `_rsvp` field implies that this Item in the Feed
// represents an event, and it contains additional event-related metadata
"_rsvp": {
// Points to the v1.json file here
"$schema": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/rsvps/v1.json",
// Points to this readme doc
"about": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/rsvps/readme.md",
// The type of RSVP response, one of "invite", "yes", "no", "maybe", or "interested"
"rsvp": "yes"
}
}
]
}
```

2
json-schema/json-feed-extensions/rsvps/v1.json → json-schema/json-feed/extensions/rsvps/v1.json
View File

@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed-extensions/rsvps/v1.json",
"$id": "https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/rsvps/v1.json",
"type": "object",
"description": "Contains additional Item metadata for Items that represent RSVPs to events",
"properties": {

2
json-schema/json-feed-extensions/rsvps/v1.yaml → json-schema/json-feed/extensions/rsvps/v1.yaml
View File

@ -1,5 +1,5 @@
$schema: http://json-schema.org/draft-07/schema
$id: https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed-extensions/rsvps/v1.json
$id: https://gitea.jbrumond.me/minimal/docs/raw/branch/master/json-schema/json-feed/extensions/rsvps/v1.json
type: object
description: Contains additional Item metadata for Items that represent RSVPs to events
properties: