Skip to content
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.

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

feat(tickets): added child and student ticket types #18

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

paperclypse
Copy link

@paperclypse paperclypse commented Apr 14, 2024

What/Why/How?

It seemed like it would be a good idea to add museum ticket types for students (reduced price) and children aged 0-5 (free) so that there are a variety of ticket prices.

(Created as part of the Write The Docs writing conference Writing Day)

Check yourself

  • [ x] Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More examples are always valuable, thank you! I added some comments for minor alterations.

@@ -70,7 +70,7 @@ paths:
$ref: '#/components/responses/NotFound'
get:
summary: List special events
description: Return a list of upcoming special events at the museum.
description: Return a list of past special events at the museum. See one you like? Use this API to [buy a ticket](/#tag/Tickets/operation/buyMuseumTickets).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should still be upcoming special events rather than past ones - we may need to add a date filter and/or some further-in-the-future events!

And the URL should be a full URL, so that the description markdown is useful in any context.

@@ -221,11 +229,13 @@ paths:
components:
schemas:
TicketType:
description: Type of ticket being purchased. Use `general` for regular museum entry and `event` for tickets to special events.
description: Type of ticket being purchased. Use `general` for regular museum entry and `event` for tickets to special events. Use `student` for school-aged children. Visitors aged 0-5 are free.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For clarity, could we rephrase this to put the general, student and child tickets in one sentence, and the special event ones in another? I think it's age-related general entry, or an event ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants