FACT-2997 document swagger update - #348
Merged
Merged
Conversation
Ibrahimelsanosi-moj
changed the title
josh-uk
approved these changes
Aug 12, 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
2 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.
Before creating a pull request make sure that:
https://tools.hmcts.net/jira/browse/FACT-2997
JIRA link
Update the API OpenAPI/Swagger documentation to describe the X-USER-ID header needed by the migration workflow. Confirm its expected format, when it is required, and ensure the documented contract matches the implemented endpoint behaviour.
Change description
Does this PR require manual testing? (check one with "x")
Does this PR introduce a breaking change? (check one with "x")