docs: update Postgres FAQ & OpenAPI docs#61
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Port clickhouse/clickhouse-docs#6280 to Mintlify.
Changes
EXECUTE,max_client_conncode-fenced heading, "rather than", "open in the pooler").storageSizefrom create requests; switch serviceidexamples from UBID to UUID; expand the config API example with the implementedpgConfig/pgBouncerConfigbody 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 sourceopenapi.mdrelative 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.mdxandopenapi.mdxto 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_connheading).OpenAPI guide enables the org list example with a realistic JSON shape (UUID
id, provider/region/version fields). Create examples dropstorageSizefrom the request body while responses still show it. Service IDs in samples move from legacy UBIDs to UUIDs. The config API section documents the realpgConfig/pgBouncerConfigpayload 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.