diff --git a/json-schema/json-feed/extensions/events/readme.md b/json-schema/json-feed/extensions/events/readme.md new file mode 100644 index 0000000..3cf8270 --- /dev/null +++ b/json-schema/json-feed/extensions/events/readme.md @@ -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" + } + } + ] +} +``` diff --git a/json-schema/json-feed-extensions/events/v1.json b/json-schema/json-feed/extensions/events/v1.json similarity index 92% rename from json-schema/json-feed-extensions/events/v1.json rename to json-schema/json-feed/extensions/events/v1.json index 0543132..1638204 100644 --- a/json-schema/json-feed-extensions/events/v1.json +++ b/json-schema/json-feed/extensions/events/v1.json @@ -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": { diff --git a/json-schema/json-feed-extensions/events/v1.yaml b/json-schema/json-feed/extensions/events/v1.yaml similarity index 92% rename from json-schema/json-feed-extensions/events/v1.yaml rename to json-schema/json-feed/extensions/events/v1.yaml index 11741f4..fc50776 100644 --- a/json-schema/json-feed-extensions/events/v1.yaml +++ b/json-schema/json-feed/extensions/events/v1.yaml @@ -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: diff --git a/json-schema/json-feed/extensions/rsvps/readme.md b/json-schema/json-feed/extensions/rsvps/readme.md new file mode 100644 index 0000000..695eab0 --- /dev/null +++ b/json-schema/json-feed/extensions/rsvps/readme.md @@ -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" + } + } + ] +} +``` diff --git a/json-schema/json-feed-extensions/rsvps/v1.json b/json-schema/json-feed/extensions/rsvps/v1.json similarity index 93% rename from json-schema/json-feed-extensions/rsvps/v1.json rename to json-schema/json-feed/extensions/rsvps/v1.json index 944b7bc..bc3bfc4 100644 --- a/json-schema/json-feed-extensions/rsvps/v1.json +++ b/json-schema/json-feed/extensions/rsvps/v1.json @@ -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": { diff --git a/json-schema/json-feed-extensions/rsvps/v1.yaml b/json-schema/json-feed/extensions/rsvps/v1.yaml similarity index 93% rename from json-schema/json-feed-extensions/rsvps/v1.yaml rename to json-schema/json-feed/extensions/rsvps/v1.yaml index bd1f3e3..054ffff 100644 --- a/json-schema/json-feed-extensions/rsvps/v1.yaml +++ b/json-schema/json-feed/extensions/rsvps/v1.yaml @@ -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: