Conversation
Contributor
There was a problem hiding this comment.
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
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>
i18n/de/docusaurus-plugin-content-docs/current/platform/development/api-clients.mdx
Outdated
Show resolved
Hide resolved
i18n/de/docusaurus-plugin-content-docs/current/platform/development/api-clients.mdx
Outdated
Show resolved
Hide resolved
i18n/de/docusaurus-plugin-content-docs/current/platform/development/api-clients.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Lars Bergmann <lars@bergmann82.de>
Member
There was a problem hiding this comment.
I would suggest moving this to docs/api/sdks; would be a better fit, IMO.
Member
There was a problem hiding this comment.
Reopened; comment was not resolved.
i18n/de/docusaurus-plugin-content-docs/current/platform/development/api-clients.mdx
Outdated
Show resolved
Hide resolved
i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx
Outdated
Show resolved
Hide resolved
i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx
Outdated
Show resolved
Hide resolved
i18n/de/docusaurus-plugin-content-docs/current/api/sdks/python.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Lars Bergmann <lars@bergmann82.de>
Member
There was a problem hiding this comment.
Reopened; comment was not resolved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.