Skip to content

merge openapi repo into api-docs#321

Open
dfenster wants to merge 2 commits intomainfrom
combine-openapi-repo
Open

merge openapi repo into api-docs#321
dfenster wants to merge 2 commits intomainfrom
combine-openapi-repo

Conversation

@dfenster
Copy link
Copy Markdown
Contributor

Merges the separate DeepLcom/openapi repo into api-docs so the API specs, their
JSON artifacts, and the prose docs all live in one place.

  • LICENSE, SECURITY.md, CHANGELOG.md — brought over from the openapi
    repo (CHANGELOG is the full history, unchanged).
  • README.md combined
  • api-reference/openapi.json and api-reference/voice/voice.asyncapi.json
    JSON artifacts that JSON-consuming tooling (Postman imports, codegen) relied on
    in the old repo.
  • .github/workflows/update_openapi_json.yml — CI that regenerates the two
    JSON files from their YAML sources on any PR touching the YAML and commits the
    result back. Uses yq, no Python dependency.
  • .mintignore — excludes the generated JSON from Mintlify rendering.
  • .gitattributes — enforces LF line endings repo-wide so Windows
    contributors don't introduce CRLF diffs.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview Apr 24, 2026, 8:48 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@DeeJayTC
Copy link
Copy Markdown
Member

Probably a good idea but lets keep the OpenAI repo working and actively maintained please. We don't want to loose those stars, forks, watchers etc. Also we don't know where its linked and indexed.

Comment thread CHANGELOG.md
@@ -0,0 +1,340 @@
# Changelog
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should only have 1 changelog - let's either not merge this in, or try to reconcile the updates with our existing changelog page

Copy link
Copy Markdown
Member

@shirgoldbird shirgoldbird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor things. Can you also update the link in the sidebar (docs.json) to point to the new spec?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants