[PR #1112] Create OpenAPI specification schema #1322

New Issue

GiteaMirror · 2025-11-09T10:10:37-06:00

GiteaMirror commented

2025-11-09 10:10:37 -06:00

📋 Pull Request Information

Original PR: https://github.com/imputnet/cobalt/pull/1112
Author: @tobq
Created: 2/16/2025
Status: 🔄 Open

Base: main ← Head: patch-2

📝 Commits (3)

d59968b Create OpenAPI specification schema
176b33b removed redundant request body
3910f2d remove defaults

📊 Changes

1 file changed (+462 additions, -0 deletions)

View changed files

➕ docs/openapi-schema.yaml (+462 -0)

📄 Description

feat: Create OpenAPI Specification schema

Adds a structured OpenAPI 3.0 specification for the Cobalt API.
Provides a unified, standardized definition of endpoints, authentication, and request/response schemas.
Enables easy generation of server and client SDKs with OpenAPI tools
Ensures better compliance with API documentation best practices.
Improves maintainability and facilitates integrations with third-party services.

Here's a live preview of the API: https://app.swaggerhub.com/apis/twoshot/Cobalt/1.0.0

_{🔄 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/imputnet/cobalt/pull/1112 **Author:** [@tobq](https://github.com/tobq) **Created:** 2/16/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `patch-2` --- ### 📝 Commits (3) - [`d59968b`](https://github.com/imputnet/cobalt/commit/d59968bb6bcef9660f8412001ba0ed06332529cd) Create OpenAPI specification schema - [`176b33b`](https://github.com/imputnet/cobalt/commit/176b33b0cef1c9c291da680bd3fd7a1687e8a514) removed redundant request body - [`3910f2d`](https://github.com/imputnet/cobalt/commit/3910f2de56609459dd0a43114cdcc12c3a6f6bfa) remove defaults ### 📊 Changes **1 file changed** (+462 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/openapi-schema.yaml` (+462 -0) </details> ### 📄 Description feat: Create OpenAPI Specification schema - Adds a structured OpenAPI 3.0 specification for the Cobalt API. - Provides a unified, standardized definition of endpoints, authentication, and request/response schemas. - Enables easy generation of server and client SDKs with [OpenAPI tools](https://github.com/OpenAPITools/openapi-generator) - Ensures better compliance with API documentation best practices. - Improves maintainability and facilitates integrations with third-party services. Here's a live preview of the API: https://app.swaggerhub.com/apis/twoshot/Cobalt/1.0.0 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-09 10:10:37 -06:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/cobalt#1322