docs: enhance OpenAPI specification for sign API#2920
Merged
caio-pizzol merged 4 commits intoApr 23, 2026
Conversation
- Updated the `document` object description to clarify the requirement of providing either `base64` or `url`. - Expanded the `signer` object description to specify required fields and optional fields, including examples. - Improved the `auditTrail` description to emphasize compliance requirements. - Added a new `certificate` object to configure the audit trail certificate page. - Updated the API documentation in `backend.mdx` to reflect the changes in the `signer` fields and their requirements.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 24d7aad26c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
- Replaced the `field` and `value` properties with a new `data` object in the event schema. - The `data` object now supports an event-specific payload with detailed descriptions for different event types, enhancing clarity and usability.
caio-pizzol
reviewed
Apr 23, 2026
caio-pizzol
left a comment
caio-pizzol
left a comment
Contributor
There was a problem hiding this comment.
hey @andrii! good call - updating this :)
three things to flag, all inline.
- Enhanced the OpenAPI specification to clarify the structure of the event payload, including updates to the `field_change` type to support additional data types. - Simplified the `signer` object in the backend documentation by removing unnecessary properties and added a warning about trusting browser-submitted `ip` and `userAgent` values.
Contributor
Author
|
@caio-pizzol done |
caio-pizzol
deleted the
andrii/sd-2666-update-superdoc-services-sign-docs
branch
April 23, 2026 15:30
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.
documentobject description to clarify the requirement of providing eitherbase64orurl.signerobject description to specify required fields and optional fields, including examples.auditTraildescription to emphasize compliance requirements.certificateobject to configure the audit trail certificate page.backend.mdxto reflect the changes in thesignerfields and their requirements.