Skip to content
/
Create special events

Redocly Museum API (1.1.1)

Imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://redocly.com/docs/cli/
E-mail
team@redocly.com
License
MIT
Terms of Service
Languages
Servers
Mock server
https://my-safe-zone-series.redocly.app/_mock/openapi/
https://api.fake-museum-example.com/v1.1/

Operations

Operational information about the museum.

Operations

Events

Special events hosted by the museum.

Operations

Create special events

Request

Creates a new special event for the museum.

Security
MuseumPlaceholderAuth
Bodyapplication/jsonrequired
namestring(EventName)required
locationstring(EventLocation)required
eventDescriptionstring(EventDescription)required
datesArray of strings(date)(EventDates)required
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)required
curl -i -X POST \
  -u <username>:<password> \
  https://my-safe-zone-series.redocly.app/_mock/openapi/special-events \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Mermaid Treasure Identification and Analysis",
    "location": "Under the seaaa 🦀 🎶 🌊.",
    "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
    "dates": [
      "2023-09-05",
      "2023-09-08"
    ],
    "price": 0
  }'

Responses

Created.

Bodyapplication/json
eventIdstring(uuid)(EventId)required
namestring(EventName)required
locationstring(EventLocation)required
eventDescriptionstring(EventDescription)required
datesArray of strings(date)(EventDates)required
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)required
Response
application/json
{
  "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
  "name": "Mermaid Treasure Identification and Analysis",
  "location": "Under the seaaa 🦀 🎶 🌊.",
  "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
  "dates": [
    "2023-09-05",
    "2023-09-08"
  ],
  "price": 30
}

List special events

Request

Return a list of upcoming special events at the museum.

Security
MuseumPlaceholderAuth
Query
startDatestring(date)

Starting date to retrieve future operating hours from. Defaults to today's date.

Example: startDate=2023-02-23
endDatestring(date)

End of a date range to retrieve special events for. Defaults to 7 days after startDate.

Example: endDate=2023-04-18
pageinteger

Page number to retrieve.

Default 1
Example: page=2
limitinteger<= 30

Number of days per page.

Default 10
Example: limit=15
curl -i -X GET \
  -u <username>:<password> \
  'https://my-safe-zone-series.redocly.app/_mock/openapi/special-events?startDate=2023-02-23&endDate=2023-04-18&page=2&limit=15'

Responses

Success.

Bodyapplication/jsonArray [
eventIdstring(uuid)(EventId)required
namestring(EventName)required
locationstring(EventLocation)required
eventDescriptionstring(EventDescription)required
datesArray of strings(date)(EventDates)required
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)required
]
Response
application/json
[
  {
    "eventId": "f3e0e76e-e4a8-466e-ab9c-ae36c15b8e97",
    "name": "Sasquatch Ballet",
    "location": "Seattle... probably",
    "eventDescription": "They're big, they're hairy, but they're also graceful. Come learn how the biggest feet can have the lightest touch.",
    "dates": [ … ],
    "price": 40
  },
  {
    "eventId": "2f14374a-9c65-4ee5-94b7-fba66d893483",
    "name": "Solar Telescope Demonstration",
    "location": "Far from the sun.",
    "eventDescription": "Look at the sun without going blind!",
    "dates": [ … ],
    "price": 50
  },
  {
    "eventId": "6aaa61ba-b2aa-4868-b803-603dbbf7bfdb",
    "name": "Cook like a Caveman",
    "location": "Fire Pit on East side",
    "eventDescription": "Learn to cook on an open flame.",
    "dates": [ … ],
    "price": 5
  },
  {
    "eventId": "602b75e1-5696-4ab8-8c7a-f9e13580f910",
    "name": "Underwater Basket Weaving",
    "location": "Rec Center Pool next door.",
    "eventDescription": "Learn to weave baskets underwater.",
    "dates": [ … ],
    "price": 15
  },
  {
    "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
    "name": "Mermaid Treasure Identification and Analysis",
    "location": "Room Sea-12",
    "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits — kindly donated by Ariel.",
    "dates": [ … ],
    "price": 30
  },
  {
    "eventId": "6744a0da-4121-49cd-8479-f8cc20526495",
    "name": "Time Traveler Tea Party",
    "location": "Temporal Tearoom",
    "eventDescription": "Sip tea with important historical figures.",
    "dates": [ … ],
    "price": 60
  },
  {
    "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
    "name": "Pirate Coding Workshop",
    "location": "Computer Room",
    "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
    "dates": [ … ],
    "price": 45
  },
  {
    "eventId": "9d90d29a-2af5-4206-97d9-9ea9ceadcb78",
    "name": "Llama Street Art Through the Ages",
    "location": "Auditorium",
    "eventDescription": "Llama street art?! Alpaca my bags -- let's go!",
    "dates": [ … ],
    "price": 45
  },
  {
    "eventId": "a3c7b2c4-b5fb-4ef7-9322-00a919864957",
    "name": "The Great Parrot Debate",
    "location": "Outdoor Amphitheatre",
    "eventDescription": "See leading parrot minds discuss important geopolitical issues.",
    "dates": [ … ],
    "price": 35
  },
  {
    "eventId": "b92d46b7-4c5d-422b-87a5-287767e26f29",
    "name": "Eat a Bunch of Corn",
    "location": "Cafeteria",
    "eventDescription": "We accidentally bought too much corn. Please come eat it.",
    "dates": [ … ],
    "price": 5
  }
]

Get special event

Request

Get details about a special event.

Security
MuseumPlaceholderAuth
Path
eventIdstring(uuid)required

Identifier for a special event.

Example: dad4bce8-f5cb-4078-a211-995864315e39
curl -i -X GET \
  -u <username>:<password> \
  https://my-safe-zone-series.redocly.app/_mock/openapi/special-events/dad4bce8-f5cb-4078-a211-995864315e39

Responses

Success.

Bodyapplication/json
eventIdstring(uuid)(EventId)required
namestring(EventName)required
locationstring(EventLocation)required
eventDescriptionstring(EventDescription)required
datesArray of strings(date)(EventDates)required
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)required
Response
application/json
{
  "eventId": "6744a0da-4121-49cd-8479-f8cc20526495",
  "name": "Time Traveler Tea Party",
  "location": "Temporal Tearoom",
  "eventDescription": "Sip tea with important historical figures.",
  "dates": [
    "2023-11-18",
    "2023-11-25",
    "2023-12-02"
  ],
  "price": 60
}

Update special event

Request

Update the details of a special event.

Security
MuseumPlaceholderAuth
Path
eventIdstring(uuid)required

Identifier for a special event.

Example: dad4bce8-f5cb-4078-a211-995864315e39
Bodyapplication/jsonrequired
namestring(EventName)
locationstring(EventLocation)
eventDescriptionstring(EventDescription)
datesArray of strings(date)(EventDates)
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)
curl -i -X PATCH \
  -u <username>:<password> \
  https://my-safe-zone-series.redocly.app/_mock/openapi/special-events/dad4bce8-f5cb-4078-a211-995864315e39 \
  -H 'Content-Type: application/json' \
  -d '{
    "location": "On the beach.",
    "price": 15
  }'

Responses

Success.

Bodyapplication/json
eventIdstring(uuid)(EventId)required
namestring(EventName)required
locationstring(EventLocation)required
eventDescriptionstring(EventDescription)required
datesArray of strings(date)(EventDates)required
Example: ["2023-10-29"]
pricenumber(float)(EventPrice)required
Response
application/json
{
  "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
  "name": "Mermaid Treasure Identification and Analysis",
  "location": "On the beach.",
  "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
  "dates": [
    "2023-09-05",
    "2023-09-08"
  ],
  "price": 15
}

Delete special event

Request

Delete a special event from the collection. Allows museum to cancel planned events.

Security
MuseumPlaceholderAuth
Path
eventIdstring(uuid)required

Identifier for a special event.

Example: dad4bce8-f5cb-4078-a211-995864315e39
curl -i -X DELETE \
  -u <username>:<password> \
  https://my-safe-zone-series.redocly.app/_mock/openapi/special-events/dad4bce8-f5cb-4078-a211-995864315e39

Responses

Success - no content.

Response
No content

Tickets

Museum tickets for general entrance or special events.

Operations