Skip to content

feat: document how to create your own API clients#975

Merged
martin-helmich merged 29 commits intomasterfrom
feat/create-api-clients
Apr 7, 2026
Merged

feat: document how to create your own API clients#975
martin-helmich merged 29 commits intomasterfrom
feat/create-api-clients

Conversation

@gandie
Copy link
Copy Markdown
Contributor

@gandie gandie commented Feb 20, 2026

Explain how to generate API clients with minimal effort. Sprinkle in some wisdom and guidance on software design and architecture, especially why customized clients might be useful.

@gandie gandie marked this pull request as ready for review February 24, 2026 13:49
Copilot AI review requested due to automatic review settings February 24, 2026 13:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces comprehensive documentation for generating custom API clients from the mittwald OpenAPI specification. The guide emphasizes automated code generation over manual client development, providing both conceptual guidance and practical implementation examples.

Changes:

  • Added detailed rationale for building custom API clients, covering use cases from language requirements to security compliance
  • Provided step-by-step instructions for generating a Python client using openapi-python-client
  • Included a complete GitHub Actions workflow for automated client regeneration and publishing

Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Lars Bergmann <lars@bergmann82.de>
* Initial plan

* Add German translation for API clients guide

Co-authored-by: gandie <15710300+gandie@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: gandie <15710300+gandie@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 14 comments.

Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/api/sdks/create-your-own.mdx
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx Outdated
gandie and others added 2 commits February 24, 2026 16:15
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Lars Bergmann <lars@bergmann82.de>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@martin-helmich martin-helmich linked an issue Feb 25, 2026 that may be closed by this pull request
Comment thread docs/api/sdks/create-your-own.mdx
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx
Comment thread docs/platform/development/api-clients.mdx Outdated
Comment thread docs/platform/development/api-clients.mdx
Comment thread docs/platform/development/api-clients.mdx
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 19 comments.

Comment thread docs/api/sdks/python.mdx Outdated
Comment thread docs/api/sdks/python.mdx
Comment thread i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx Outdated
Comment thread i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx Outdated
Comment thread docs/api/sdks/python.mdx Outdated
Comment thread docs/api/sdks/python.mdx Outdated
Comment thread i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx Outdated
Comment thread docs/api/sdks/python.mdx Outdated
Comment thread i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx
Comment thread docs/api/sdks/python.mdx Outdated
Comment thread docs/api/sdks/create-your-own.mdx
Comment thread docs/platform/development/api-clients.mdx Outdated
@gandie gandie requested a review from martin-helmich April 7, 2026 07:04
@martin-helmich martin-helmich changed the title Feat/create api clients feat: document how to create your own API clients Apr 7, 2026
martin-helmich and others added 3 commits April 7, 2026 11:46
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@martin-helmich martin-helmich enabled auto-merge (squash) April 7, 2026 09:52
@martin-helmich martin-helmich merged commit 36cd497 into master Apr 7, 2026
4 checks passed
@martin-helmich martin-helmich deleted the feat/create-api-clients branch April 7, 2026 10:06
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.

Document how to build your own API client

4 participants