[bfaulk96]

Description

Documents PATCH /api/v2/collie-job-secrets/:id in the OpenAPI source and generated specification.

packages/go/openapi/
  src/paths/collector-jobs.secrets.id.yaml  # PATCH contract
  doc/openapi.json                        # generated specification

Defines optional name, external_key_id, and write-only value fields, validation requirements, the metadata response, and error statuses.

Merge Danger

Door: Two-way. Documentation can be reverted.

Blast Radius: Documentation. The runtime endpoint is implemented in a separate BHE PR. The contract documents unchanged job snapshots and the possibility that a provider write succeeds before a database commit fails.

Motivation and Context

Resolves BED-10419

Keeps the API specification aligned with the credential update endpoint. Companion implementation: BHE #2398. Merge this PR first, then update the BHE submodule pointer to its merged revision.

How Has This Been Tested?

• Before: The OpenAPI specification described GET and DELETE for an individual credential, but no PATCH operation.
  After: Both the YAML source and generated JSON describe PATCH. The generated JSON parses and includes the expected request fields and response statuses.
• The BHE companion's credential unit, database integration, and routed API tests passed against the documented behavior, including successful partial updates and 400/401/403/404/409 responses.

Manual verification for reviewers: inspect UpdateCollectorJobSecret in the source YAML and generated JSON; confirm value is write-only, at least one update field is required, additional fields are rejected, and the 200 response contains credential metadata only.

No BHCE runtime code changed; the full BHCE test suite was not run.

Screenshots (optional):

Not applicable; OpenAPI documentation change.

Types of changes

• Chore (a change that does not modify the application functionality)

Checklist:

• I have met the contributing prerequisites
  • Assigned myself to this PR
  • Added the appropriate labels
  • Associated an issue: BED-10419
  • Read the Contributing guide
• I have ensured that related documentation is up-to-date
  • Open API docs
  • Code comments (GoDocs / JSDocs)
• I have followed proper test practices
  • Added/updated tests to cover my changes
  • All new and existing tests passed

[coderabbitai]

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

• Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts