Skip to content

feat(openapi): add secrets v1 schema#22

Open
casey-brooks wants to merge 1 commit intomainfrom
noa/issue-21
Open

feat(openapi): add secrets v1 schema#22
casey-brooks wants to merge 1 commit intomainfrom
noa/issue-21

Conversation

@casey-brooks
Copy link
Contributor

Summary

  • add secrets v1 OpenAPI schema with paths and components
  • mirror team conventions for pagination and problem responses
  • extend OpenAPI publish workflow to bundle, lint, and publish secrets spec

Testing

  • buf lint
  • buf build
  • npx -y @redocly/cli bundle openapi/team/v1/openapi.yaml -o dist/team-v1.yaml
  • npx -y @redocly/cli bundle openapi/files/v1/openapi.yaml -o dist/files-v1.yaml
  • npx -y @redocly/cli bundle openapi/secrets/v1/openapi.yaml -o dist/secrets-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/team-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/files-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/secrets-v1.yaml

Closes #21

@casey-brooks casey-brooks requested a review from a team as a code owner March 12, 2026 22:44
@github-actions
Copy link

The latest Buf updates on your PR. Results from workflow buf-pr / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedMar 12, 2026, 10:45 PM

@casey-brooks
Copy link
Contributor Author

Test & Lint Summary

Commands:

  • buf lint
  • buf build
  • npx -y @redocly/cli bundle openapi/team/v1/openapi.yaml -o dist/team-v1.yaml
  • npx -y @redocly/cli bundle openapi/files/v1/openapi.yaml -o dist/files-v1.yaml
  • npx -y @redocly/cli bundle openapi/secrets/v1/openapi.yaml -o dist/secrets-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/team-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/files-v1.yaml
  • npx -y @stoplight/spectral-cli lint dist/secrets-v1.yaml

Test stats: passed 2, failed 0, skipped 0 (buf lint, buf build)
Lint status: spectral warnings only (no errors) for team/files/secrets.

@casey-brooks
Copy link
Contributor Author

Summary

  • added secrets v1 OpenAPI schema with paths/components mirroring team conventions
  • updated openapi-publish workflow to bundle/lint/publish secrets spec

Copy link

@noa-lucent noa-lucent left a comment

Choose a reason for hiding this comment

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

Clean, well-structured OpenAPI schema that faithfully mirrors the proto definition and follows team/v1 conventions. All routes, schemas, shared components, and CI workflow steps are correctly implemented per issue #21.

One nit left inline — otherwise LGTM.

get:
tags: [Secrets]
summary: List secrets
parameters:

Choose a reason for hiding this comment

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

[nit] The secretProviderId query parameter is missing a description. The team/v1 convention includes descriptions for domain-specific filters (e.g. q in agents). Adding something like description: Filter by secret provider UUID. would improve discoverability for API consumers.

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.

Add OpenAPI schema for Secrets service (secrets/v1)

2 participants