Update OpenAPI documentation with comprehensive guide and examples #65
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.
This PR significantly enhances the OpenAPI documentation page by adding detailed information about our API specification and integration guidelines. The updates include comprehensive sections on SDK generation, client library usage, API reference integration, validation/testing approaches, and version management. The changes transform the previous single-line reference into a complete developer resource with practical code examples in multiple languages (TypeScript, Python, cURL) and detailed explanations of API capabilities.
The main file affected is fern/api-reference/openapi.mdx, which now provides a structured guide covering everything from basic usage to advanced integration scenarios, making it easier for developers to understand and implement our API.