Skip to content

Update petition image keys & URLs #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lavaturtle merged 3 commits into from
Aug 12, 2026
Merged

Update petition image keys & URLs #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28ad7b3
in example petition JSON response for authenticated REST API, update …
lavaturtle Aug 10, 2026
35a0939
update image URLs for public json API
lavaturtle Aug 10, 2026
2eaa87c
update example authenticated API response for events to include the c…
lavaturtle Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 98 additions & 35 deletions source/includes/authenticated_api/_events.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The authenticated REST API endpoints for events only deal with events created in
"title": "Deliver the Petition to the Wizard",
"url": "https://demo.controlshiftlabs.com/events/deliver-the-petition-to-the-wizard",
"description": "Join us as we travel to the Emerald City to deliver our petition to the Wizard.",
"rich_description": "<p><em>Join us</em> as we travel to the Emerald City to deliver our petition to the Wizard.</p>",
"start_at": "2018-03-01T12:00:00Z",
"end_at": "2018-03-01T13:30:00Z",
"start_in_zone": "2018-03-01T12:00:00-05:00",
Expand All @@ -26,26 +27,31 @@ The authenticated REST API endpoints for events only deal with events created in
"locale": "en-US",
"host_address": null,
"max_attendees_count": null,
"send_prompt_to_repeat": false,
"prompt_to_repeat_sent_at": null,
"external_id": "control-shift-deliver-the-petition-to-the-wizard",
"host": {
"member_id": 123,
"full_name": "Dorothy of Kansas",
"email": "dorothy@example.com",
"phone_number": "555-555-5555",
"postcode": "66012"
"main_image": {
"urls": {
"original": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--hijklmnop/a-little-teapot.png",
"landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/a-little-teapot.png",
"small_landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--qrstuv/a-little-teapot.png",
"social": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--abcde/a-little-teapot.png"
},
"caption": "This picture was taken by a human, not generated by AI.",
},
"location": {
"query": "wizard room",
"venue": "The Wizard's Throne Room",
"postal_code": "",
"country": "US",
"region": "MA",
"locality": "Anytown",
"latitude": "42.3376368",
"longitude": "-70.99304",
"street_number": "",
"query": "wizard room",
"street": "",
"region": "MA",
"postal_code": "",
"country": "US",
"street_number": "",
"created_at": "2017-11-16T22:38:29Z"
},
"location_venue": "The Wizard's Throne Room",
"shifts": [
{
"id": "103",
Expand All @@ -61,22 +67,44 @@ The authenticated REST API endpoints for events only deal with events created in
}
],
"petition": {
"title": "Repair the Yellow Brick Road",
"slug": "repair-the-yellow-brick-road-1",
"url": "https://demo.controlshiftlabs.com/petitions/repair-the-yellow-brick-road-1"
},
"partnerships": [],
"labels": ["oz-organizer-help"],
"predecessor_event": null,
"successor_event": null,
"campaigner_contactable": true,
"event_host_name_override": null,
"forum_enabled": true,
"hidden_address": false,
"hide_recent_attendees": false,
"location_venue": "The Wizard's Throne Room",
"redirect_to": null,
"sharing_disabled": false,
"web_conference_url": null,
"bluesky_share_message": "Join us at this event!",
"facebook_share_description": "Come deliver the petition with us",
"facebook_share_title": "Deliver the Petition to the Wizard",
"meta_title": "Deliver the Petition to the Wizard - Event",
"meta_description": "Join us as we travel to the Emerald City",
"share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?",
"twitter_share_description": "Join us in the Emerald City!",
"twitter_share_message": "Attending this event to deliver our petition",
"twitter_share_title": "Deliver the Petition to the Wizard",
"web_share_api_share_message": "Check out this event in the Emerald City",
"whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!",
"share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?",
"disable_rsvp_form": false
"disable_rsvp_form": false,
"host": {
"member_id": 123,
"full_name": "Dorothy of Kansas",
"email": "dorothy@example.com",
"phone_number": "555-555-5555",
"postcode": "66012"
},
"mentor": null,
"reviewer": null
},
...
],
Expand Down Expand Up @@ -111,6 +139,7 @@ The response includes all the same data as the single-event endpoint for each ev
"title": "Deliver the Petition to the Wizard",
"url": "https://demo.controlshiftlabs.com/events/deliver-the-petition-to-the-wizard",
"description": "Join us as we travel to the Emerald City to deliver our petition to the Wizard.",
"rich_description": "<p><em>Join us</em> as we travel to the Emerald City to deliver our petition to the Wizard.</p>",
"start_at": "2018-03-01T12:00:00Z",
"end_at": "2018-03-01T13:30:00Z",
"start_in_zone": "2018-03-01T12:00:00-05:00",
Expand All @@ -121,50 +150,84 @@ The response includes all the same data as the single-event endpoint for each ev
"locale": "en-US",
"host_address": null,
"max_attendees_count": null,
"send_prompt_to_repeat": false,
"prompt_to_repeat_sent_at": null,
"external_id": "control-shift-deliver-the-petition-to-the-wizard",
"host": {
"member_id": 123,
"full_name": "Dorothy of Kansas",
"email": "dorothy@example.com",
"phone_number": "555-555-5555",
"postcode": "66012"
"main_image": {
"urls": {
"original": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--hijklmnop/a-little-teapot.png",
"landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/a-little-teapot.png",
"small_landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--qrstuv/a-little-teapot.png",
"social": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--abcde/a-little-teapot.png"
},
"caption": "This picture was taken by a human, not generated by AI.",
},
"location": {
"query": "wizard room",
"venue": "The Wizard's Throne Room",
"postal_code": "",
"country": "US",
"region": "MA",
"locality": "Anytown",
"latitude": "42.3376368",
"longitude": "-70.99304",
"street_number": "",
"query": "wizard room",
"street": "",
"region": "MA",
"postal_code": "",
"country": "US",
"street_number": "",
"created_at": "2017-11-16T22:38:29Z"
},
"location_venue": "The Wizard's Throne Room",
"mentor": {
"member_id": 456,
"full_name": "Glinda the Good",
"email": "glinda@example.com",
"phone_number": "555-555-5555",
"postcode": "12345"
},
"shifts": [
{
"id": "103",
"name": "Lunch",
"start_at": "2018-03-01T12:00:00Z",
"end_at": "2018-03-01T13:00:00Z"
},
{
"id": "105",
"name": "Demonstration",
"start_at": "2018-03-01T13:00:00Z",
"end_at": "2018-03-01T13:30:00Z"
}
],
"petition": {
"title": "Repair the Yellow Brick Road",
"slug": "repair-the-yellow-brick-road-1",
"url": "https://demo.controlshiftlabs.com/petitions/repair-the-yellow-brick-road-1"
},
"partnerships": [],
"labels": ["oz-organizer-help"],
"predecessor_event": null,
"successor_event": null,
"campaigner_contactable": true,
"event_host_name_override": null,
"forum_enabled": true,
"hidden_address": false,
"hide_recent_attendees": false,
"location_venue": "The Wizard's Throne Room",
"redirect_to": null,
"sharing_disabled": false,
"web_conference_url": null,
"bluesky_share_message": "Join us at this event!",
"facebook_share_description": "Come deliver the petition with us",
"facebook_share_title": "Deliver the Petition to the Wizard",
"meta_title": "Deliver the Petition to the Wizard - Event",
"meta_description": "Join us as we travel to the Emerald City",
"share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?",
"twitter_share_description": "Join us in the Emerald City!",
"twitter_share_message": "Attending this event to deliver our petition",
"twitter_share_title": "Deliver the Petition to the Wizard",
"web_share_api_share_message": "Check out this event in the Emerald City",
"whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!",
"share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?",
"disable_rsvp_form": false
"disable_rsvp_form": false,
"host": {
"member_id": 123,
"full_name": "Dorothy of Kansas",
"email": "dorothy@example.com",
"phone_number": "555-555-5555",
"postcode": "66012"
},
"mentor": null,
"reviewer": null
}
}
```
Expand Down
4 changes: 2 additions & 2 deletions source/includes/authenticated_api/_partnerships.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Partnerships are other organisations you collaborate with using the platform.
"created_at": "2015-12-02T01:43:17Z",
"updated_at": "2015-12-02T01:43:17Z",
"url": "https://demo.controlshiftlabs.com/partnerships/fight-fascism",
"image": "https://cdn.example.com/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6ODI2Mzg5LCJ--f17a/OiJ2YXJpYXRpb24ifX0=--924a23c065f/a-little-teapot.png"
"image": "https://images.controlshift.app/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6ODI2Mzg5LCJ--f17a/OiJ2YXJpYXRpb24ifX0=--924a23c065f/a-little-teapot.png"
},
{
"id": 107,
Expand Down Expand Up @@ -63,7 +63,7 @@ Get a paginated list of all partnerships.
"created_at": "2015-12-02T01:43:17Z",
"updated_at": "2015-12-02T01:43:17Z",
"url": "https://demo.controlshiftlabs.com/partnerships/fight-fascism",
"image": "https://cdn.example.com/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6ODI2Mzg5LCJ--f17a/OiJ2YXJpYXRpb24ifX0=--924a23c065f/a-little-teapot.png"
"image": "https://images.controlshift.app/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6ODI2Mzg5LCJ--f17a/OiJ2YXJpYXRpb24ifX0=--924a23c065f/a-little-teapot.png"
}
}
```
Expand Down
10 changes: 5 additions & 5 deletions source/includes/authenticated_api/_petitions.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ Petition are pieces of content that can be signed by members.
"ended_story": "This was an overwhelming success!",
"image": {
"urls": {
"open_graph": "http://cdn.example.com/petitions/images/25/open_graph/a-little-teapot.png?1516647704",
"horizontal": "http://cdn.example.com/petitions/images/25/horizontal/a-little-teapot.png?1516647704",
"hero": "http://cdn.example.com/petitions/images/25/hero/a-little-teapot.png?1516647704",
"original": "http://cdn.example.com/petitions/images/25/original/a-little-teapot.png?1516647704",
"form": "http://cdn.example.com/petitions/images/25/form/a-little-teapot.png?1516647704"
"original": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--hijklmnop/a-little-teapot.png",
"landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/a-little-teapot.png",
"small_landscape": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--qrstuv/a-little-teapot.png",
"social": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--abcde/a-little-teapot.png"
},
"caption": "This picture was taken by a human, not generated by AI.",
"description": "Picture of a small teapot with flowers on it and money tucked under the lid"
},
"public_signature_count": 234,
Expand Down
32 changes: 16 additions & 16 deletions source/includes/json/_category_petitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,23 @@ $(document).ready(function(){
"ended": false,
"created_at": "2015-12-02T01:43:17Z",
"updated_at": "2017-05-07T15:38:39Z",
"image_url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/hero/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741",
"image_url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg",
"additional_image_sizes_url": [
{
"style": "original",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/original/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--hijklmnop/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "form",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/form/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "small_landscape",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--qrstuv/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "horizontal",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/horizontal/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "landscape",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "open_graph",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/open_graph/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "social",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--abcde/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
}
],
"target": {
Expand Down Expand Up @@ -92,23 +92,23 @@ $(document).ready(function(){
"locale": "en",
"created_at": "2014-10-02T01:43:17Z",
"updated_at": "2018-05-07T15:38:39Z",
"image_url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/hero/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741",
"image_url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg",
"additional_image_sizes_url": [
{
"style": "original",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/original/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--hijklmnop/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "form",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/form/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "small_landscape",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--qrstuv/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "horizontal",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/horizontal/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "landscape",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--12345/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
},
{
"style": "open_graph",
"url": "https://d8s293fyljwh4.cloudfront.net/petitions/images/92283/open_graph/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg?1473884741"
"style": "social",
"url": "https://images.controlshift.app/rails/active_storage/representations/proxy/abc123defg--abcde/2016-06-20-1466458252-1098096-ywllowbrickroad.jpg"
}
],
"target": {
Expand Down
Loading
Loading