Skip to content

feat: get available managment operation endpoint BED-8266#2984

Open
lrfalslev wants to merge 2 commits into
mainfrom
lfalslev/bed-8266
Open

feat: get available managment operation endpoint BED-8266#2984
lrfalslev wants to merge 2 commits into
mainfrom
lfalslev/bed-8266

Conversation

@lrfalslev

@lrfalslev lrfalslev commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Description

Adds get available management operation endpoints to openapi schema, for BHE pr 1568

Motivation and Context

Resolves BED-8266

Why is this change required? What problem does it solve?

How Has This Been Tested?

Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.

Screenshots (optional):

Types of changes

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Database Migrations

Checklist:

Summary by CodeRabbit

  • New Features
    • Added GET /api/v2/clients/management/available to retrieve the next available client management operations, using the Prefer header (no client_id path parameter).
    • Documented the 200 response as JSON containing a data array of management operation objects.
    • Introduced new operation type (support_bundle) and lifecycle status values (queued, running, succeeded, failed, canceled), including operation identifiers and lifecycle timestamps.
    • Documented error responses for 401, 403, 429, and 500.

@lrfalslev lrfalslev self-assigned this Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 8bb8db03-7e13-4cd9-9de1-47e7f3dd2285

📥 Commits

Reviewing files that changed from the base of the PR and between a36eea9 and fe2347c.

📒 Files selected for processing (2)
  • packages/go/openapi/doc/openapi.json
  • packages/go/openapi/src/paths/clients.clients.management.available.yaml
💤 Files with no reviewable changes (2)
  • packages/go/openapi/src/paths/clients.clients.management.available.yaml
  • packages/go/openapi/doc/openapi.json

📝 Walkthrough

Walkthrough

Adds OpenAPI definitions for client management operation types, statuses, lifecycle fields, and a new GET /api/v2/clients/management/available endpoint.

Changes

Client management availability API

Layer / File(s) Summary
Management operation schemas
packages/go/openapi/src/schemas/enum.client-management-operation-*.yaml, packages/go/openapi/src/schemas/model.client-management-operation.yaml, packages/go/openapi/doc/openapi.json
Defines the supported operation type and lifecycle statuses, plus a composed read-only model with identifiers, timestamps, and execution fields.
Availability endpoint wiring
packages/go/openapi/src/openapi.yaml, packages/go/openapi/src/paths/clients.clients.management.available.yaml, packages/go/openapi/doc/openapi.json
Registers the endpoint with the required Prefer header and documents 200, 401, 403, 429, and 500 responses.

Estimated code review effort: 2 (Simple) | ~15 minutes

Suggested labels: enhancement, api, go

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The template is mostly followed, but the How Has Been Tested section is left empty and needs concrete test details. Fill in How Has Been Tested with the environment and tests run, and add any relevant validation or screenshots if applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and matches the main change: adding the available management operation endpoint.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch lfalslev/bed-8266

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitai coderabbitai Bot added api A pull request containing changes affecting the API code. enhancement New feature or request labels Jul 13, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/go/openapi/src/paths/clients.clients.management.available.yaml`:
- Around line 19-25: The available-clients endpoint declares client_id as a
required path parameter without a matching path template. In
packages/go/openapi/src/paths/clients.clients.management.available.yaml lines
19-25, determine whether client_id is a query parameter or should be removed
based on the endpoint contract; if it remains a path parameter, update
packages/go/openapi/src/openapi.yaml lines 705-708 to include {client_id} in the
path. Regenerate packages/go/openapi/doc/openapi.json lines 16425-16481 from the
corrected YAML rather than editing it directly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 88c2cc87-f269-444a-852c-114551a56cea

📥 Commits

Reviewing files that changed from the base of the PR and between 9e2f82b and 3ed16a0.

📒 Files selected for processing (6)
  • packages/go/openapi/doc/openapi.json
  • packages/go/openapi/src/openapi.yaml
  • packages/go/openapi/src/paths/clients.clients.management.available.yaml
  • packages/go/openapi/src/schemas/enum.client-management-operation-status.yaml
  • packages/go/openapi/src/schemas/enum.client-management-operation-type.yaml
  • packages/go/openapi/src/schemas/model.client-management-operation.yaml

Comment thread packages/go/openapi/src/paths/clients.clients.management.available.yaml Outdated
@lrfalslev lrfalslev force-pushed the lfalslev/bed-8266 branch from 3ed16a0 to a36eea9 Compare July 13, 2026 15:45
@coderabbitai coderabbitai Bot added the go Pull requests that update go code label Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api A pull request containing changes affecting the API code. enhancement New feature or request go Pull requests that update go code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant