Skip to content

Conversation

@hxtomprice
Copy link
Contributor

What does this PR do? (please provide any background)

Updates the documentation for booking requests to link to the reference document for the Title field.
We have an enum of valid titles which are mentioned in a separate document but they aren't the easiest thing to find.
The error messaging to partners when they pass an invalid title is also not useful so this should help partners to self serve when calling the API.

Any tech debt?

Another ticket will be raised to improve the error messaging when an invalid title is passed in.

Screenshots / Screencast

Screenshot 2025-08-29 at 08 21 32

By approving a review you are confirming you have...

  • Witnessed the work behaving as expected (this could be on the author's machine or screencast).
  • Checked for coding anti-patterns.
  • Checked for appropriate test coverage.
  • Checked all the tests are passing.

Aurore-HX
Aurore-HX previously approved these changes Aug 29, 2025
@hxtomprice hxtomprice merged commit c0ef773 into master Aug 29, 2025
4 checks passed
@hxtomprice hxtomprice deleted the improve-title-docs branch August 29, 2025 09:06
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.

3 participants