Skip to content

docs: update Postgres FAQ & OpenAPI docs#61

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
port/pg-openapi-faq
Open

docs: update Postgres FAQ & OpenAPI docs#61
mintlify[bot] wants to merge 1 commit into
mainfrom
port/pg-openapi-faq

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 26, 2026

Summary

Port clickhouse/clickhouse-docs#6280 to Mintlify.

Changes

  • FAQ: link to Query Performance Insights blog, mention OpenAPI under Terraform answer, change "100+" extensions to "over 90", minor copy edits (EXECUTE, max_client_conn code-fenced heading, "rather than", "open in the pooler").
  • OpenAPI: uncomment the org-ID list-API example and update the example payload to UUIDs with the new field set; remove storageSize from create requests; switch service id examples from UBID to UUID; expand the config API example with the implemented pgConfig/pgBouncerConfig body and response; reflow the monitoring paragraph and reorder link refs.

Context

Ported file-by-file from the source PR; slugs preserved. The one fix required for Mintlify: the FAQ link to the OpenAPI page uses /products/managed-postgres/openapi (matching this repo's convention) rather than the source openapi.md relative link.


Note

Low Risk
Documentation-only edits to FAQ and OpenAPI examples; no application code or security behavior changes.

Overview
Updates Managed Postgres docs in faq.mdx and openapi.mdx to match current product and API behavior (ported from upstream docs).

FAQ now points readers to live Query Performance Insights (blog + Query Insights tab) instead of a “coming soon” note. The Terraform answer adds OpenAPI as an alternative to the console. Extension count is corrected to over 90. Small copy fixes cover PgBouncer/prepared-statement wording (EXECUTE, direct vs pooler, max_client_conn heading).

OpenAPI guide enables the org list example with a realistic JSON shape (UUID id, provider/region/version fields). Create examples drop storageSize from the request body while responses still show it. Service IDs in samples move from legacy UBIDs to UUIDs. The config API section documents the real pgConfig / pgBouncerConfig payload and restart message in the response. Monitoring prose is lightly reflowed.

Reviewed by Cursor Bugbot for commit a523608. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview May 26, 2026, 12:18 PM

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.

0 participants