starred/documenso

Fork 0

mirror of https://github.com/documenso/documenso.git synced 2026-04-25 05:46:01 +03:00

[PR #1392] [MERGED] feat: start the work on the API reference #1603

New issue

Closed

opened 2026-02-26 19:33:57 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 19:33:57 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/documenso/documenso/pull/1392
Author: @catalinpit
Created: 10/9/2024
Status: ✅ Merged
Merged: 10/15/2024
Merged by: @catalinpit

Base: main ← Head: feat/api-documentation

📝 Commits (10+)

05a4ab1 feat: start the work on the API reference
9d550c1 feat: add more info about uploading docs
a13e302 feat: add more info about uploading docs
f16c8be feat: add more info about uploading docs
7674ab0 feat: add more info about uploading docs
099399b feat: add more info about generating a doc from a template
3dc0f9a feat: finish generate doc from template section
c2c876e feat: add fields docs
52cac0b feat: final touches
43a6424 Merge branch 'main' into feat/api-documentation

📊 Changes

6 files changed (+507 additions, -0 deletions)

View changed files

➕ apps/documentation/pages/developers/public-api/reference.mdx (+507 -0)
➕ apps/documentation/public/api-reference/documenso-template-id.webp (+0 -0)
➕ apps/documentation/public/api-reference/document-generated-from-template.webp (+0 -0)
➕ apps/documentation/public/api-reference/document-uploaded-to-documenso-via-api.webp (+0 -0)
➕ apps/documentation/public/api-reference/fields-added-via-api.webp (+0 -0)
➕ apps/documentation/public/api-reference/upload-document-to-s3.webp (+0 -0)

📄 Description

later

Description

Changes Made

Change 1
Change 2
...

Testing Performed

Tested feature X in scenario Y.
Ran unit tests for component Z.
Tested on browsers A, B, and C.
...

Checklist

I have tested these changes locally and they work as expected.
I have added/updated tests that prove the effectiveness of these changes.
I have updated the documentation to reflect these changes, if applicable.
I have followed the project's coding style guidelines.
I have addressed the code review feedback from the previous submission, if applicable.

Additional Notes

Summary by CodeRabbit

New Features
- Introduced comprehensive documentation for the Documenso public API.
- Added detailed guides for the following API endpoints:
  - Uploading documents
  - Generating documents from templates
  - Adding fields to documents
- Included example payloads and response structures for better understanding.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/documenso/documenso/pull/1392 **Author:** [@catalinpit](https://github.com/catalinpit) **Created:** 10/9/2024 **Status:** ✅ Merged **Merged:** 10/15/2024 **Merged by:** [@catalinpit](https://github.com/catalinpit) **Base:** `main` ← **Head:** `feat/api-documentation` --- ### 📝 Commits (10+) - [`05a4ab1`](https://github.com/documenso/documenso/commit/05a4ab14f432b5e6af653722412d7b56b3f43db6) feat: start the work on the API reference - [`9d550c1`](https://github.com/documenso/documenso/commit/9d550c101074ad322bf27f37431a4c32fc6cfc3f) feat: add more info about uploading docs - [`a13e302`](https://github.com/documenso/documenso/commit/a13e30239f8149601ea370208e552e20fa07031a) feat: add more info about uploading docs - [`f16c8be`](https://github.com/documenso/documenso/commit/f16c8be5f4659a3b05b0644b9dda198ded9a9583) feat: add more info about uploading docs - [`7674ab0`](https://github.com/documenso/documenso/commit/7674ab0868f74f77e77d326cc79d72691a3d465f) feat: add more info about uploading docs - [`099399b`](https://github.com/documenso/documenso/commit/099399beeac0cec9c2eb2b3cb04627de98d84f7b) feat: add more info about generating a doc from a template - [`3dc0f9a`](https://github.com/documenso/documenso/commit/3dc0f9a4a9dd71c88d318a0382b35941182a144c) feat: finish generate doc from template section - [`c2c876e`](https://github.com/documenso/documenso/commit/c2c876eb479cb6ff5ede72197cc3967debfd0270) feat: add fields docs - [`52cac0b`](https://github.com/documenso/documenso/commit/52cac0b5e0761a3c4dac7c232bf77547dfa7a987) feat: final touches - [`43a6424`](https://github.com/documenso/documenso/commit/43a6424efa408d4ed79d36bb28e267c5c58c7cb2) Merge branch 'main' into feat/api-documentation ### 📊 Changes **6 files changed** (+507 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `apps/documentation/pages/developers/public-api/reference.mdx` (+507 -0) ➕ `apps/documentation/public/api-reference/documenso-template-id.webp` (+0 -0) ➕ `apps/documentation/public/api-reference/document-generated-from-template.webp` (+0 -0) ➕ `apps/documentation/public/api-reference/document-uploaded-to-documenso-via-api.webp` (+0 -0) ➕ `apps/documentation/public/api-reference/fields-added-via-api.webp` (+0 -0) ➕ `apps/documentation/public/api-reference/upload-document-to-s3.webp` (+0 -0) </details> ### 📄 Description `later` ## Description   ## Related Issue   ## Changes Made   - Change 1 - Change 2 - ... ## Testing Performed   - Tested feature X in scenario Y. - Ran unit tests for component Z. - Tested on browsers A, B, and C. - ... ## Checklist   - [ ] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [ ] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## Additional Notes    ## Summary by CodeRabbit - **New Features** - Introduced comprehensive documentation for the Documenso public API. - Added detailed guides for the following API endpoints: - Uploading documents - Generating documents from templates - Adding fields to documents - Included example payloads and response structures for better understanding.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-02-26 19:33:57 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/documenso#1603

No description provided.

Rows
Columns