reorg json-feed files; add readmes for json-feed extensions
This commit is contained in:
39
json-schema/json-feed/extensions/rsvps/readme.md
Normal file
39
json-schema/json-feed/extensions/rsvps/readme.md
Normal 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"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
24
json-schema/json-feed/extensions/rsvps/v1.json
Normal file
24
json-schema/json-feed/extensions/rsvps/v1.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"$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",
|
||||
"type": "object",
|
||||
"description": "Contains additional Item metadata for Items that represent RSVPs to events",
|
||||
"properties": {
|
||||
"about": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"description": "URI pointing to more information about this \"_rsvp\" extension"
|
||||
},
|
||||
"rsvp": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"invited",
|
||||
"yes",
|
||||
"no",
|
||||
"maybe",
|
||||
"interested"
|
||||
],
|
||||
"description": "The type of RSVP response, based on https://microformats.org/wiki/h-entry#Core_Properties and https://microformats.org/wiki/rsvp-brainstorming\n"
|
||||
}
|
||||
}
|
||||
}
|
20
json-schema/json-feed/extensions/rsvps/v1.yaml
Normal file
20
json-schema/json-feed/extensions/rsvps/v1.yaml
Normal file
@@ -0,0 +1,20 @@
|
||||
$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
|
||||
type: object
|
||||
description: Contains additional Item metadata for Items that represent RSVPs to events
|
||||
properties:
|
||||
about:
|
||||
type: string
|
||||
format: uri
|
||||
description: URI pointing to more information about this "_rsvp" extension
|
||||
rsvp:
|
||||
type: string
|
||||
enum:
|
||||
- "invited"
|
||||
- "yes"
|
||||
- "no"
|
||||
- "maybe"
|
||||
- "interested"
|
||||
description: >
|
||||
The type of RSVP response, based on https://microformats.org/wiki/h-entry#Core_Properties
|
||||
and https://microformats.org/wiki/rsvp-brainstorming
|
Reference in New Issue
Block a user