OpenAPI #47
Merged
OpenAPI #47
Conversation
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
📚 Enhance v1.0 Documentation: Add Protocol Guides, Implementation Exa…
- Add OpenAPI compatibility section explaining UTCP as agent-focused extension - Include minimal OpenAPI ingestion example in Quick Start - Position information early in documentation for better user understanding
- Change 'are automatically converted' to 'can be automatically converted' - More accurate description of optional conversion process
- Add 'or additional infrastructure' to OpenAPI compatibility section - Reinforces UTCP's core value proposition of no wrapper tax
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
docs/index.md
Outdated
| ```python | ||
| from utcp_http.openapi_converter import OpenApiConverter | ||
|
|
||
| converter = OpenApiConverter.from_url("https://api.example.com/openapi.json") |
Contributor
There was a problem hiding this comment.
Undocumented API usage: OpenApiConverter.from_url is not documented elsewhere, which risks copy-paste errors for readers; use the documented constructor pattern or document from_url.
Prompt for AI agents
Address the following comment on docs/index.md at line 55:
<comment>Undocumented API usage: OpenApiConverter.from_url is not documented elsewhere, which risks copy-paste errors for readers; use the documented constructor pattern or document from_url.</comment>
<file context>
@@ -44,7 +48,16 @@ npm install @utcp/core @utcp/http
+```python
+from utcp_http.openapi_converter import OpenApiConverter
+
+converter = OpenApiConverter.from_url("https://api.example.com/openapi.json")
+manual = converter.convert()
+# Your OpenAPI spec is now a UTCP manual with agent-friendly metadata
</file context>
docs/index.md
Outdated
|
|
||
| ## OpenAPI Compatibility | ||
|
|
||
| UTCP extends OpenAPI for AI agents while maintaining full backward compatibility. Where OpenAPI describes APIs for human developers, UTCP adds agent-focused enhancements: `tags` for categorization, `average_response_size` for resource planning, multi-protocol support (CLI, gRPC, WebSocket), and direct execution instructions. Existing OpenAPI specs are automatically converted to UTCP manuals without requiring API changes. |
Contributor
There was a problem hiding this comment.
Mentioning gRPC here can mislead readers since gRPC isn’t listed in the current Supported Protocols; align the examples with documented/stable protocols.
Prompt for AI agents
Address the following comment on docs/index.md at line 33:
<comment>Mentioning gRPC here can mislead readers since gRPC isn’t listed in the current Supported Protocols; align the examples with documented/stable protocols.</comment>
<file context>
@@ -28,6 +28,10 @@ UTCP acts as a **"manual"** that tells agents how to call your tools directly:
+## OpenAPI Compatibility
+
+UTCP extends OpenAPI for AI agents while maintaining full backward compatibility. Where OpenAPI describes APIs for human developers, UTCP adds agent-focused enhancements: `tags` for categorization, `average_response_size` for resource planning, multi-protocol support (CLI, gRPC, WebSocket), and direct execution instructions. Existing OpenAPI specs are automatically converted to UTCP manuals without requiring API changes.
+
## Quick Start (5 Minutes)
</file context>
Suggested change
| UTCP extends OpenAPI for AI agents while maintaining full backward compatibility. Where OpenAPI describes APIs for human developers, UTCP adds agent-focused enhancements: `tags` for categorization, `average_response_size` for resource planning, multi-protocol support (CLI, gRPC, WebSocket), and direct execution instructions. Existing OpenAPI specs are automatically converted to UTCP manuals without requiring API changes. | |
| UTCP extends OpenAPI for AI agents while maintaining full backward compatibility. Where OpenAPI describes APIs for human developers, UTCP adds agent-focused enhancements: `tags` for categorization, `average_response_size` for resource planning, multi-protocol support (CLI, HTTP, WebSocket), and direct execution instructions. Existing OpenAPI specs are automatically converted to UTCP manuals without requiring API changes. |
h3xxit
added a commit
that referenced
this pull request
Sep 9, 2025
OpenAPI docs and fix a lot of issues (#47)
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 by cubic
Added an OpenAPI Compatibility section explaining how UTCP extends OpenAPI while staying fully backward compatible, plus a Quick Start example to convert an existing OpenAPI spec into a UTCP manual. This clarifies migration and surfaces the guidance earlier in the docs.