Skip to content

Update PlanetScale OpenAPI schema - #330

Merged
nholden merged 2 commits into
mainfrom
openapi/update
Aug 18, 2026
Merged

Update PlanetScale OpenAPI schema#330
nholden merged 2 commits into
mainfrom
openapi/update

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

This automated PR updates schemas/openapi.yaml to the latest version published by PlanetScale.

This PR does not run Speakeasy generation. Provider code changes are intentionally left for a maintainer to produce and validate locally.

Required follow-up

Before merging, a maintainer should:

  1. Check out this branch locally
  2. Run make generate to regenerate the Terraform provider from the updated schema and overlays
  3. Review and validate all generated changes
  4. Commit any overlay adjustments and generated code to this branch

Review checklist

Existing resources and data sources

Carefully review any changes that affect existing Terraform resources or data sources.
Schema changes such as new required fields, removed attributes, or type changes may require:

Remove superfluous API fields via overlays

The raw OpenAPI schema includes many fields that are not useful in Terraform (timestamps, display names, actor metadata, and similar UI-only values). Remove them using overlay remove: true actions in schemas/.

Examples of fields that should typically be stripped:

  • created_at, updated_at, deleted_at
  • display_name on nested objects
  • actor, avatar_url, and similar metadata

See existing overlays such as schemas/overlay-terraform-vitess-branch-backup.yaml for patterns.

@github-actions
github-actions Bot requested review from a team as code owners August 18, 2026 20:12
The refreshed OpenAPI schema adds a `ready` flag to Postgres role
responses and `total_count`/`total_pages` pagination metadata to list
responses. Mark them x-speakeasy-terraform-ignore so the provider
surface is unchanged; the SDK models still carry the new fields.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@nholden
nholden enabled auto-merge August 18, 2026 20:35
@nholden
nholden merged commit fed5e89 into main Aug 18, 2026
12 checks passed
@nholden
nholden deleted the openapi/update branch August 18, 2026 20:48
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.

1 participant