Update OpenAPI spec with endpoint specific errors to be consistent with REST doc#316
Merged
Ian-Nice-16 merged 20 commits intomainfrom Mar 4, 2026
Merged
Conversation
…tions/sms endpoint to match those in the REST API doc
…erent required fields for each notification type. Also added updated example data to be consistent with the REST docs
…oser to the REST docs
…parameter to reflect example in the rest docs
…get message status.
…e up with examples for get template by id.
…s for get template by id.
…the new examples.
…dpoint to be consistent with the REST docs
…ndpoint to be consistent with the REST docs. Also removed the examples for the status query parameter which were not formatted correctly by redocly. Redirect reader to the REST docs instead.
klssmith
reviewed
Feb 20, 2026
Contributor
klssmith
left a comment
klssmith
left a comment
There was a problem hiding this comment.
Looks good (and much more consistent with the REST docs 🎉) when viewed in Redocly, just 2 very minor typos I spotted
Contributor
|
Once @spatel033 's PR to add a new validation error for letters is merged, we'll also want that error here but that could be added in a separate PR if it's easier |
Fixing incorrectly named property Co-authored-by: Katie Smith <klssmith@users.noreply.github.com>
Fixing typo Co-authored-by: Katie Smith <klssmith@users.noreply.github.com>
quis
approved these changes
Mar 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is best reviewed commit by commit.
This PR updates the OpenAPI spec to be more closely aligned with the REST API document. Changes include:
To view the OpenAPI spec in HTML format use the redocly docker image and the following command (from the openapi directory):
docker run --rm -v $PWD:/spec redocly/cli lint publicapi_spec.json