docs: add comprehensive usage guide to README#33
Open
halotukozak wants to merge 7 commits intomasterfrom
Open
Conversation
- Add Generated Client Usage section with dependencies, client creation, auth examples - Document Bearer, API Key, Basic, and no-auth constructor patterns - Add HttpResult/Either error handling guide with HttpError subtype table - Add serialization setup with SerializersModule for polymorphic types - Add multi-spec configuration example Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Coverage Report
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Generated Client Usage” section to the project README to document how consumers should add dependencies, instantiate generated clients, handle errors, and configure serialization when using the Gradle plugin’s generated Ktor clients.
Changes:
- Document runtime dependencies and client instantiation patterns.
- Add sections for authentication, request/response handling, error handling, and serialization setup.
- Include an example for multi-spec Gradle configuration.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fix inaccuracies in generated client documentation to match actual code: use tag-derived class names (PetsApi), Bearer-only auth, Raise-based error handling, HttpErrorType enum, and correct JSON config. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Merge Authentication info into Creating the Client section to eliminate duplicate code example. Remove Multi-Spec Configuration section already covered in Usage. Fix ApiResponseGenerator KDoc listing 3 enum values instead of 4 (missing Redirect). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add three new README sections: - Supported OpenAPI Features: type mapping table, composition/polymorphism support matrix, parameter and request body support - Generated Code Structure: output layout tree, model/api package contents, Gradle task reference - Customization: package overrides, Ktor engine selection, JSON configuration Remove redundant Serialization Setup section (now covered by Customization). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…rect Arrow version Testing revealed two issues: - Generated code uses Kotlin context parameters, requiring -Xcontext-parameters compiler flag (was undocumented) - Arrow version 2.1.2 missing arrow.core.raise.context.raise, updated to 2.2.1.1 matching the actual project dependency Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
# Conflicts: # core/src/main/kotlin/com/avsystem/justworks/core/gen/shared/ApiResponseGenerator.kt
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.
Summary
HttpResult/Eithererror handling guide withHttpErrorsubtype tableSerializersModulefor polymorphic typesTest plan
🤖 Generated with Claude Code