Repository navigation
fix(openapi): align API contract with real responses for SDK generation #9533
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
Open
lfals
wants to merge
10
commits into
LibreSign:main
Choose a base branch
from
lfals:fix/openapi-sdk-contract-9087
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,920
β491
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
09c6f23
fix(openapi): align the contract with what the controllers return
lfals c81791b
test(sdk): re-evaluate typescript-axios against the current contract
lfals 1bf272f
fix(openapi): keep the 422 bodies sent by the permission middleware
lfals f86e01b
docs(sdk): correct the 422 and 401 findings of the evaluation
lfals ba8fa3d
docs(sdk): fix inaccurate statements found in the second review
lfals acffd0a
fix(openapi): document the permission 422 and the nullable nodeId
lfals ff4d520
docs(sdk): record the completed annotations and the validation nodeId
lfals 34dfed9
docs(sdk): fix the description of how the 422 bodies are produced
lfals 40ca88c
fix(openapi): build the admin background response with its documentedβ¦
lfals f1225dc
fix(openapi): keep the attachment disposition of the admin background
lfals File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
FileβIdDocFilerename makes sense for this domain and resolves the TypeScript generator's reserved-name issue.However, it also changes a published OpenAPI component reference, which may affect consumers that generate SDKs or reference schemas by name.
Could we evaluate whether this should be treated as a breaking change and how such changes should be documented across LibreSign releases?
Nextcloud provides a useful reference in its Developer Manual Release Notes, separating critical changes, new features, deprecations, and previous release notes from the general changelog.
I suggest considering a similar release-specific section in the LibreSign Developer Manual for breaking changes and migration instructions. If this rename affects supported consumers, we should document the previous schema name, its replacement, and any required migration steps.
If schema names are not currently guaranteed to remain stable, we should clarify that compatibility policy instead of automatically classifying every rename as a breaking change.