Skip to content

chore(openapi): sync public API contract - #537

Open
ItamarZand88 wants to merge 1 commit into
mainfrom
itamar/alien-619-improve-aliendev-agent-readiness
Open

chore(openapi): sync public API contract#537
ItamarZand88 wants to merge 1 commit into
mainfrom
itamar/alien-619-improve-aliendev-agent-readiness

Conversation

@ItamarZand88

Copy link
Copy Markdown
Contributor

Summary

This syncs the generated OpenAPI copies with the current public API contract. The contract now describes OAuth authentication and the public health operation.

Contract flow:

  1. Clients read the generated OpenAPI document.
  2. The core change: they can discover API-key and OAuth alternatives plus the unauthenticated health endpoint.
  3. TypeScript and Rust consumers receive identical contract copies.

This PR changes the generated contract from API-key-only discovery to the current public authentication and health surface.

How I tested

  • Parsed every updated file as JSON.
  • Verified all three generated copies have the same SHA-256 checksum.
  • Compared the generated structures and confirmed no new boundary-sensitive references were introduced.
  • Ran the OSS-boundary specialist review; it approved the diff.

I also ran a security review on the diff. What it checked:

  • The files document existing public endpoints and do not add token-handling code.
  • No credentials, secrets, or private implementation paths were added.
  • Nothing turned up.

@greptile-apps

greptile-apps Bot commented Aug 30, 2026

Copy link
Copy Markdown

Greptile Summary

The PR synchronizes three generated OpenAPI contract copies, adding OAuth authentication discovery, the unauthenticated health operation, deployment-compute contract updates, and clarified environment-variable behavior.

  • Adds an OAuth 2.0 authorization-code security scheme alongside API-key authentication.
  • Documents the public health and deployment-compute operations and associated models.
  • Keeps the platform and Rust OpenAPI copies identical.

Confidence Score: 5/5

The PR appears safe to merge with no concrete contract defect or security regression identified.

The three generated contract copies remain synchronized, and the reviewed authentication and operation declarations reveal no reachable, changed-code-triggered failure.

Important Files Changed

Filename Overview
client-sdks/platform/openapi.json Synchronizes the primary platform contract with OAuth discovery and the current public operation and schema surface.
client-sdks/platform/rust/openapi-3.0.json Mirrors the updated OpenAPI 3.0 contract for Rust consumers.
client-sdks/platform/rust/openapi.json Mirrors the updated contract used by Rust build-time client generation.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  A[Public API contract] --> B[Platform OpenAPI copy]
  A --> C[Rust OpenAPI copies]
  B --> D[TypeScript client generation]
  C --> E[Rust build-time generation]
  B --> F[API-key or OAuth discovery]
  B --> G[Unauthenticated health discovery]
Loading

Reviews (1): Last reviewed commit: "chore(openapi): sync public API contract" | Re-trigger Greptile

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