Skip to content

Commit 2f34c25

Browse files
authored
proposed additional entity metadata (#76)
* proposed additional entity metadata * flatten keys (consistency) and sort (readability) * fix formatting change * add entity_email and clarify URL fields * update example to be more consistent
1 parent c25d0c3 commit 2f34c25

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The JSON file is expected to contain a simple array of meetings. [Here is an exa
3232
"group": "The Serenity Group",
3333
"notes": "Ring buzzer. Meeting is on the 2nd floor.",
3434
"updated": "2014-05-31 14:32:23",
35-
"url": "https://intergroup.org/meetings/sunday-serenity",
35+
"url": "https://district123.org/meetings/sunday-serenity",
3636
"types": [
3737
"O",
3838
"T",
@@ -43,7 +43,16 @@ The JSON file is expected to contain a simple array of meetings. [Here is an exa
4343
"state": "CA",
4444
"postal_code": "98765",
4545
"country": "US",
46-
"approximate": "no"
46+
"approximate": "no",
47+
"entity": "District 123",
48+
"entity_email": "info@district123.org",
49+
"entity_feedback_emails": [
50+
"meetingupdates@district123.org"
51+
],
52+
"entity_location": "Example County, California",
53+
"entity_logo": "https://district123.org/images/logo.svg",
54+
"entity_phone": "+1-123-456-7890",
55+
"entity_url": "https://district123.org"
4756
},
4857
...
4958
]
@@ -105,7 +114,21 @@ The JSON file is expected to contain a simple array of meetings. [Here is an exa
105114

106115
`edit_url` is an optional string URL that trusted servants can use to edit the specific meeting's listing.
107116

108-
`feedback_url` is an optional string URL that can be used to provide feedback about the meeting. These could be local links, eg `/feedback?meeting=meeting-slug-1`, remote links, eg `https://typeform.com/to/23904203?meeting=meeting-slug-1`, or email links, eg `mailto:webservant@domain.org?subject=meeting-slug-1`.
117+
`feedback_url` is an optional string URL that can be used to provide feedback about the meeting. These can be on-site or off-site absolute URLs, eg `https://example.org/feedback?meeting=meeting-slug-1` or `https://typeform.com/to/23904203?meeting=meeting-slug-1`, or email links, eg `mailto:webservant@domain.org?subject=meeting-slug-1`.
118+
119+
`entity` is the name of the service entity responsible for the listing. entity info is optional, but `entity` is required if any of the other entity fields are present.
120+
121+
`entity_email` is a public email address for the service entity responsible for the listing.
122+
123+
`entity_feedback_emails` an array of feedback addresses for the service entity responsible for the listing.
124+
125+
`entity_location` is a human-readable physical description of the service area of the entity, eg `Whatcom County, Washington`.
126+
127+
`entity_logo` is the URL of the logo of the service entity responsible for the listing. should begin with `https://`. ideally the image this points to is a vector-based SVG so it can be scaled to any size. Additionally, the image should be square, and have a transparent background. Finally, colors should be specified using `currentColor` so that they can adapt to the color mode (light, dark) of the app.
128+
129+
`entity_phone` is the phone number of the service entity responsible for the listing. Should be in the format `+1-123-456-7890` and start with country code for international dialing.
130+
131+
`entity_website_url` is the URL of the website homepage of the service entity responsible for the listing. should begin with `https://`
109132

110133
## Common Questions & Concerns
111134

0 commit comments

Comments
 (0)