starred/documenso

Fork 0

mirror of https://github.com/documenso/documenso.git synced 2026-04-24 21:36:01 +03:00

[GH-ISSUE #825] [DOC-371] Investigate Automated OpenAPI Specification Generation Tools #253

New issue

Closed

opened 2026-02-26 18:46:08 +03:00 by kerem · 1 comment

kerem commented

2026-02-26 18:46:08 +03:00

Owner

Originally created by @Mythie on GitHub (Jan 10, 2024).
Original GitHub issue: https://github.com/documenso/documenso/issues/825

Originally assigned to: @catalinpit on GitHub.

Description:

Explore API tools capable of automatically generating OpenAPI specifications, to efficiently document our API endpoints.

Investigation Goals:

Identify tools that auto-generate OpenAPI specs with complete endpoint shapes and documentation.
Evaluate the feasibility of using these tools to provide hosted API documentation and future SDK generation.

Context:

A known tool is ts-rest.com, which supports OpenAPI spec generation.
Manual generation of OpenAPI specs is not viable due to the need for constant updates.

Rationale:

Automating OpenAPI spec generation will save time, ensure accuracy in documentation, and facilitate easier API consumption by users and developers.

_{From SyncLinear.com | DOC-371}

Originally created by @Mythie on GitHub (Jan 10, 2024). Original GitHub issue: https://github.com/documenso/documenso/issues/825 Originally assigned to: @catalinpit on GitHub. **Description:** Explore API tools capable of automatically generating OpenAPI specifications, to efficiently document our API endpoints. **Investigation Goals:** 1. Identify tools that auto-generate OpenAPI specs with complete endpoint shapes and documentation. 2. Evaluate the feasibility of using these tools to provide hosted API documentation and future SDK generation. **Context:** * A known tool is [ts-rest.com](https://ts-rest.com/docs/open-api), which supports OpenAPI spec generation. * Manual generation of OpenAPI specs is not viable due to the need for constant updates. **Rationale:** Automating OpenAPI spec generation will save time, ensure accuracy in documentation, and facilitate easier API consumption by users and developers. <sub>From [SyncLinear.com](https://synclinear.com) | [DOC-371](https://linear.app/documenso/issue/DOC-371/investigate-automated-openapi-specification-generation-tools)</sub>

kerem

2026-02-26 18:46:08 +03:00

closed this issue
added the
type: enhancement

status: triage

type: documentation
labels

kerem commented

2026-02-26 18:46:09 +03:00

Author

Owner

@Mythie commented on GitHub (Jan 10, 2024):

Looks like another option, this would simply mean creating a public router and then using that:

https://github.com/jlalmes/trpc-openapi

@Mythie commented on GitHub (Jan 10, 2024): Looks like another option, this would simply mean creating a `public` router and then using that: [https://github.com/jlalmes/trpc-openapi](https://github.com/jlalmes/trpc-openapi)

kerem referenced this issue

2026-02-26 19:30:38 +03:00

[PR #253] [MERGED] docs: add gitpod setup #825

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#253

No description provided.

Rows
Columns