Skip to content

Annotate read-only fields with google.api.field_behavior OUTPUT_ONLY - #487

Merged
Robert-Stam merged 1 commit into
mainfrom
feat/annotate-output-only-fields
Sep 8, 2026
Merged

Annotate read-only fields with google.api.field_behavior OUTPUT_ONLY#487
Robert-Stam merged 1 commit into
mainfrom
feat/annotate-output-only-fields

Conversation

@qdrant-cloud-bot

Copy link
Copy Markdown
Contributor

Summary

  • Annotate documented read-only fields across the public API protos with [(google.api.field_behavior) = OUTPUT_ONLY], importing google/api/field_behavior.proto.
  • Cover entity fields already described as read-only in comments (ids, timestamps, keys, caller audit fields, status/state, platform ceilings, etc.) and messages marked entirely read-only (e.g. ClusterState, SpaceEndpoint, BackupRestore, HybridCloudEnvironmentStatus).
  • Regenerate Go/Python/TypeScript/OpenAPI bindings so OpenAPI exposes "readOnly": true for these fields.

Test plan

  • make lint / make generate succeed
  • Spot-check OpenAPI (readOnly: true) for ManagementKey, Cluster, Space, and Backup
  • Confirm create/update request payloads are unchanged at the wire level (annotation-only change)

Add google.api.field_behavior = OUTPUT_ONLY to fields and messages that the
API already documents as read-only, so OpenAPI and clients can treat them as
output-only consistently.
@qdrant-cloud-bot
qdrant-cloud-bot requested a review from a team as a code owner September 8, 2026 11:49
@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

The latest Buf updates on your PR. Results from workflow Pull Request / linting (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedSep 8, 2026, 11:49 AM

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

PR Packages Published

Python Package:

  • Version: 0.182.0.dev487+43c8b64
  • Package: qdrant-cloud-public-api
  • Registry: https://us-python.pkg.dev/qdrant-cloud/python/
  • To update run: uv add qdrant-cloud-public-api==0.182.0.dev487+43c8b64

NPM Package:

  • Version: 0.182.0-dev487.43c8b64
  • Package: @qdrant/qdrant-cloud-public-api
  • Registry: https://us-npm.pkg.dev/qdrant-cloud/npm/
  • To update run: npm install @qdrant/qdrant-cloud-public-api@0.182.0-dev487.43c8b64

@Robert-Stam
Robert-Stam merged commit e93a963 into main Sep 8, 2026
11 checks passed
@Robert-Stam
Robert-Stam deleted the feat/annotate-output-only-fields branch September 8, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants