updated openapi spec

[akshaydeo]

Summary

Added container management operations to the OpenAPI specification, enabling users to create, list, retrieve, and delete containers for storing files and data.

Changes

• Added a new "Containers" tag to the OpenAPI specification
• Implemented four new API endpoints:
  • POST /v1/containers - Create a container
  • GET /v1/containers - List containers
  • GET /v1/containers/{container_id} - Retrieve a container
  • DELETE /v1/containers/{container_id} - Delete a container
• Defined request/response schemas for container operations including properties like name, provider, expiration settings, memory limits, and metadata

Type of change

• Feature
• Bug fix
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (Next.js)
• Docs

How to test

Test the new container endpoints using curl or any API client:

# Create a container
curl -X POST https://api.example.com/v1/containers \
  -H "Content-Type: application/json" \
  -d '{"provider": "openai", "name": "test-container"}'

# List containers
curl -X GET https://api.example.com/v1/containers?provider=openai

# Retrieve a container
curl -X GET https://api.example.com/v1/containers/container_id?provider=openai

# Delete a container
curl -X DELETE https://api.example.com/v1/containers/container_id?provider=openai

Breaking changes

• No
• Yes

Related issues

N/A

Security considerations

The container API requires provider authentication and follows the same security model as other API endpoints.

Checklist

• I read docs/contributing/README.md and followed the guidelines
• I added/updated tests where appropriate
• I updated documentation where needed
• I verified builds succeed (Go and UI)
• I verified the CI pipeline passes locally if applicable

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Added container file management endpoints to the API specification, including operations for creating, listing, retrieving, and deleting files within containers.
  • Extended OpenAI-compatible integration APIs with matching container file endpoints for consistent access across integration methods.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Adds OpenAPI specifications for container file management endpoints to the Unified Inference API and OpenAI Integration, including operations for creating, listing, retrieving, deleting, and downloading container files, along with corresponding request/response schemas.

Changes

Cohort / File(s)	Summary
Main API Reference docs/openapi/openapi.yaml	Adds path references to container file endpoints across two API sections: Unified Inference (/v1/containers/{container_id}/files/) and OpenAI Integration (/openai/v1/containers/). Routes to definitions in inference and OpenAI containers specifications.
Inference Endpoints docs/openapi/paths/inference/containers.yaml	Defines 5 new container file operation paths: POST/GET for file creation and listing with multipart/JSON request handling; GET/DELETE for file metadata and deletion; GET for content download. Includes pagination (limit, after) and provider parameters.
OpenAI Integration Endpoints docs/openapi/paths/integrations/openai/containers.yaml	Comprehensive OpenAPI specification mirroring inference endpoints plus container CRUD operations (POST/GET/DELETE containers). All 10 operations include operationIds, request bodies, and responses referencing shared schemas.
Container File Schemas docs/openapi/schemas/inference/containers.yaml	Introduces 6 schema definitions for container file operations: ContainerFileObject, ContainerFileCreateMultipartRequest, ContainerFileCreateJsonRequest, ContainerFileCreateResponse, ContainerFileListResponse, ContainerFileRetrieveResponse, and ContainerFileDeleteResponse with consistent field definitions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Hop hop, new containers take flight,
Files bundled up, organized just right,
Upload, download, delete with glee,
The schemas bloom like carrots on a tree! 🥕

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 01-22-updated_openapi_spec

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[akshaydeo]

• updated openapi spec #1419 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

🧪 Test Suite Available

This PR can be tested by a repository admin.

Run tests for PR #1419