Skip to content

refactor: generate OpenAPI JSON and docs.json - #5650

Merged
akshaydeo merged 1 commit into
devfrom
07-29-refactor_api_structure
Aug 11, 2026
Merged

akshaydeo merged 1 commit into
devfrom
07-29-refactor_api_structure

Conversation

@impoiler

Copy link
Copy Markdown
Contributor

Summary

Briefly explain the purpose of this PR and the problem it solves.

Changes

  • What was changed and why
  • Any notable design decisions or trade-offs

Type of change

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

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

Describe the steps to validate this change. Include commands and expected outcomes.

# Core/Transports
go version
go test ./...

# UI
cd ui
pnpm i || npm i
pnpm test || npm test
pnpm build || npm run build

If adding new configs or environment variables, document them here.

Screenshots/Recordings

If UI changes, add before/after screenshots or short clips.

Breaking changes

  • Yes
  • No

If yes, describe impact and migration instructions.

Related issues

Link related issues and discussions. Example: Closes #123

Security considerations

Note any security implications (auth, secrets, PII, sandboxing, etc.).

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

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added a governance API migration guide to the OSS documentation navigation.
    • Reorganized API documentation into categories for inference, integrations, platform, governance, and deprecated endpoints.
    • Expanded navigation for OpenAI-compatible, provider-specific, asynchronous, realtime, administrative, governance, and legacy APIs.
    • Clarified legacy audit-log endpoints for listing, filtering, exporting, lookup, and verification while retaining compatibility aliases.

Walkthrough

The API documentation navigation now covers categorized inference, integration, platform, governance, and deprecated endpoints. The OpenAPI specification repositions legacy audit-log route declarations and retains their existing references.

Changes

API Documentation and Governance

Layer / File(s) Summary
Migration guide and inference navigation
docs/docs.json
Adds the governance namespace migration guide and expands inference API entries.
Integration and platform navigation
docs/docs.json
Adds categorized integration and platform API documentation entries.
Governance and deprecated navigation
docs/docs.json
Adds governance API groups and documents legacy routes in a Deprecated API section.
Legacy audit-log route definitions
docs/openapi/openapi.yaml
Moves the legacy audit-log declarations and adds a labeled alias block with the existing specification references.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

  • maximhq/bifrost#5838: Synchronizes related API navigation and deprecated-operation documentation.
  • maximhq/bifrost#5840: Restructures related governance OpenAPI specifications and legacy audit-log definitions.
  • maximhq/bifrost#5841: Updates related governance migration and legacy audit-log documentation.

Suggested reviewers: akshaydeo, bearts

🚥 Pre-merge checks | ✅ 2 | ❌ 3

❌ Failed checks (3 warnings)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The changes do not implement or document the requested File APIs, including POST /v1/files, from issue [#123]. Implement the provider File APIs and document their supported workflows, or replace [#123] with an issue that matches the documentation and audit-log changes.
Out of Scope Changes check ⚠️ Warning The docs navigation update and legacy audit-log alias changes are unrelated to the linked Files API objective [#123]. Limit this PR to Files API support, or link the documentation and audit-log work to the correct issues and split unrelated changes.
Description check ⚠️ Warning The description contains only the unfilled template and does not document the changes, testing, affected areas, risks, or checklist status. Replace the template with a completed summary, change list, test steps, affected areas, breaking-change status, security considerations, related issues, and checklist results.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title identifies the main documentation-generation change and names the two primary generated artifacts.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 07-29-refactor_api_structure

Comment @coderabbitai help to get the list of available commands.

@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch 2 times, most recently from 63d8af6 to 701e3e8 Compare July 29, 2026 10:03
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch 10 times, most recently from 642c4ea to 78e9abe Compare August 4, 2026 09:32
@impoiler
impoiler changed the base branch from dev to graphite-base/5650 August 4, 2026 09:42
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from 78e9abe to 1354ca8 Compare August 4, 2026 09:43
@impoiler
impoiler force-pushed the graphite-base/5650 branch from 8665274 to 054f389 Compare August 4, 2026 09:43
@impoiler
impoiler changed the base branch from graphite-base/5650 to 08-04-feat_adds_missing_endpoints_to_e2e_api_tests August 4, 2026 09:43
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch 2 times, most recently from 466edac to 4fffa62 Compare August 4, 2026 10:31
@impoiler impoiler self-assigned this Aug 4, 2026
@impoiler
impoiler changed the base branch from 08-04-feat_adds_missing_endpoints_to_e2e_api_tests to graphite-base/5650 August 4, 2026 10:48
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from b8fa7be to 3821d51 Compare August 4, 2026 10:48
@impoiler
impoiler changed the base branch from graphite-base/5650 to 08-04-docs_governance_api_migration_guide August 4, 2026 10:48
coderabbitai[bot]
coderabbitai Bot previously approved these changes Aug 6, 2026
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from 70381ee to 8e31366 Compare August 7, 2026 11:28
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch from 6a574ef to 2f5c167 Compare August 7, 2026 11:28
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from 8e31366 to 77436aa Compare August 10, 2026 03:37
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch from 2f5c167 to 4103a5f Compare August 10, 2026 03:37
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from 77436aa to 7983237 Compare August 10, 2026 07:56
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch from 4103a5f to 72d6a1a Compare August 10, 2026 07:56
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch from 72d6a1a to 8c67b4f Compare August 10, 2026 12:48
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch 2 times, most recently from ad97b5a to 8a5147f Compare August 10, 2026 13:29
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch from 8c67b4f to 73a9a9a Compare August 10, 2026 13:29
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch 2 times, most recently from 8a5147f to 3f10187 Compare August 10, 2026 17:51
@impoiler
impoiler force-pushed the 08-04-docs_governance_api_migration_guide branch 2 times, most recently from 34b6a3f to afdddb7 Compare August 11, 2026 04:20
@impoiler
impoiler force-pushed the 07-29-refactor_api_structure branch from 3f10187 to 943dbee Compare August 11, 2026 04:20
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

akshaydeo commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Merge activity

  • Aug 11, 7:01 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 11, 7:07 AM UTC: Graphite rebased this pull request as part of a merge.
  • Aug 11, 7:08 AM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo changed the base branch from 08-04-docs_governance_api_migration_guide to graphite-base/5650 August 11, 2026 07:05
@akshaydeo
akshaydeo changed the base branch from graphite-base/5650 to dev August 11, 2026 07:05
@akshaydeo
akshaydeo dismissed coderabbitai[bot]’s stale review August 11, 2026 07:05

The base branch was changed.

@akshaydeo
akshaydeo requested a review from a team as a code owner August 11, 2026 07:05
@akshaydeo
akshaydeo force-pushed the 07-29-refactor_api_structure branch from 943dbee to fe0f733 Compare August 11, 2026 07:06
@akshaydeo
akshaydeo merged commit d53d6c3 into dev Aug 11, 2026
15 checks passed
@akshaydeo
akshaydeo deleted the 07-29-refactor_api_structure branch August 11, 2026 07:08
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
## Summary

Briefly explain the purpose of this PR and the problem it solves.

## Changes

- What was changed and why
- Any notable design decisions or trade-offs

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

Describe the steps to validate this change. Include commands and expected outcomes.

```sh
# Core/Transports
go version
go test ./...

# UI
cd ui
pnpm i || npm i
pnpm test || npm test
pnpm build || npm run build
```

If adding new configs or environment variables, document them here.

## Screenshots/Recordings

If UI changes, add before/after screenshots or short clips.

## Breaking changes

- [ ] Yes
- [ ] No

If yes, describe impact and migration instructions.

## Related issues

Link related issues and discussions. Example: Closes #123

## Security considerations

Note any security implications (auth, secrets, PII, sandboxing, etc.).

## 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
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
## Summary

Briefly explain the purpose of this PR and the problem it solves.

## Changes

- What was changed and why
- Any notable design decisions or trade-offs

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

Describe the steps to validate this change. Include commands and expected outcomes.

```sh
# Core/Transports
go version
go test ./...

# UI
cd ui
pnpm i || npm i
pnpm test || npm test
pnpm build || npm run build
```

If adding new configs or environment variables, document them here.

## Screenshots/Recordings

If UI changes, add before/after screenshots or short clips.

## Breaking changes

- [ ] Yes
- [ ] No

If yes, describe impact and migration instructions.

## Related issues

Link related issues and discussions. Example: Closes #123

## Security considerations

Note any security implications (auth, secrets, PII, sandboxing, etc.).

## 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
akshaydeo pushed a commit that referenced this pull request Aug 14, 2026
## Summary

Briefly explain the purpose of this PR and the problem it solves.

## Changes

- What was changed and why
- Any notable design decisions or trade-offs

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

Describe the steps to validate this change. Include commands and expected outcomes.

```sh
# Core/Transports
go version
go test ./...

# UI
cd ui
pnpm i || npm i
pnpm test || npm test
pnpm build || npm run build
```

If adding new configs or environment variables, document them here.

## Screenshots/Recordings

If UI changes, add before/after screenshots or short clips.

## Breaking changes

- [ ] Yes
- [ ] No

If yes, describe impact and migration instructions.

## Related issues

Link related issues and discussions. Example: Closes #123

## Security considerations

Note any security implications (auth, secrets, PII, sandboxing, etc.).

## 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
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.

Files API Support

2 participants