Skip to content

Conversation

@asoorm
Copy link
Contributor

@asoorm asoorm commented Jan 6, 2026

This PR adds a complete documentation set for Cosmo Connect API consumption, covering both the producer workflow and consumer experience.

What's included

Producer workflow

  • Overview of the API consumption model
  • Defining contracts using Trusted Documents
  • Generating and distributing SDKs and OpenAPI specs with Buf
  • Configuring the Cosmo Router to serve ConnectRPC APIs

Consumption options

  • Consuming APIs via generated SDKs (TypeScript, Go)
  • Consuming APIs via REST / OpenAPI (HTTP/JSON, tooling, caching)
  • Consuming APIs via gRPC (high-performance clients, grpcurl)

Structure & intent

  • Written for platform teams
  • Presents a clear flow: contracts → artifacts → runtime → consumption
  • Consumption pages act as DX showcases that can be adapted for consumer-facing docs
  • Clearly positions tradeoffs and recommended paths per protocol

@asoorm asoorm requested review from a team as code owners January 6, 2026 20:48
@asoorm asoorm requested review from JivusAyrus, StarpTech, alepane21 and thisisnithin and removed request for a team January 6, 2026 20:48
@asoorm asoorm changed the title feat(connectrpc): add API consumption docs for Cosmo Connect feat(connectrpc): add API consumption docs for Cosmo ConnectRPC Jan 6, 2026
@asoorm asoorm force-pushed the ahmet/eng-8587-documentation-for-connect-client-v2 branch 2 times, most recently from eb327e5 to d4818df Compare January 7, 2026 12:18
@asoorm asoorm force-pushed the ahmet/eng-8587-documentation-for-connect-client-v2 branch 3 times, most recently from 58eecd3 to 8ed4c43 Compare January 23, 2026 11:07
- Enhance produce-define-contracts page with ASCII tree visualizations
- Add custom CSS for improved diff syntax highlighting
- Simplify overview page to focus on GraphQL to OpenAPI/SDK transformation
- Add simple mermaid diagram showing transformation flow
- Remove curl/grpcurl examples to reduce complexity
- Update all internal links from /connect/api-consumption/ to /connect-rpc/
- Simplify description and messaging for better clarity
@asoorm asoorm force-pushed the ahmet/eng-8587-documentation-for-connect-client-v2 branch from 3f200e9 to 8434768 Compare January 23, 2026 12:37
…ttern

- Replace services_provider_id with nested storage.provider_id configuration
- Add minimal and full configuration examples
- Document all configuration fields in a table format
- Add environment variables section
- Include note about storage object being required when enabled
- Explain storage provider behavior and file system requirement
- Align with Persisted Operations and MCP Server configuration patterns
…implified content

- Add wgc CLI install link and reference to CLI docs
- Simplify router config section and link to full docs
- Replace mermaid diagram with ASCII tree
- Add link to Buf Connect docs for other language SDKs
- Link back to SDK generation page from OpenAPI section"
@asoorm asoorm force-pushed the ahmet/eng-8587-documentation-for-connect-client-v2 branch from 4eaca36 to 74f6ac9 Compare January 23, 2026 18:40
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.

1 participant