Skip to content

feat: PG data APIs#1629

Draft
wojcik-dorota wants to merge 15 commits into
mainfrom
PGDX-48-docs-pg-editor-api-support
Draft

feat: PG data APIs#1629
wojcik-dorota wants to merge 15 commits into
mainfrom
PGDX-48-docs-pg-editor-api-support

Conversation

@wojcik-dorota

@wojcik-dorota wojcik-dorota commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

https://aiven.atlassian.net/browse/PGDX-48

DOC PREVIEW

Adds a new Data APIs documentation set covering the limited-availability REST API feature for Aiven for PostgreSQL (PostgREST-backed REST endpoints with external-IdP authentication).

New pages: docs/products/postgresql/howto/data-apis/

  • index.md — Overview: what Data APIs offers, how it works, and limitations (LA badge).
  • get-started.md — Prerequisites (VPC, IdP/JWKS) and steps to enable a REST API for a database.
  • authentication.md — JWKS URL and audience configuration, IdP examples (Auth0, Okta, Microsoft Entra ID), automatic key rotation, and PostgreSQL role-based authorization (default web_anon access and the token role claim).
  • use-endpoints.md — Finding the base URL, viewing endpoints, copying code snippets (curl / JavaScript / Python), and calling endpoints with a bearer token.
  • manage.md — Status (Deploying / Running / Error), exposing more databases, turning off a REST API, and troubleshooting (VPC requirement, deployment failure/timeout).

@wojcik-dorota wojcik-dorota self-assigned this Jun 8, 2026
@github-actions github-actions Bot added service/pg tech Relates to technical updates of the docs platform. labels Jun 8, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 8, 2026

Copy link
Copy Markdown

Deploying aiven-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 106e7e1
Status: ✅  Deploy successful!
Preview URL: https://7841b3ed.aiven-docs.pages.dev
Branch Preview URL: https://pgdx-48-docs-pg-editor-api-s.aiven-docs.pages.dev

View logs

@wojcik-dorota wojcik-dorota marked this pull request as ready for review June 23, 2026 10:48
@wojcik-dorota wojcik-dorota requested a review from a team as a code owner June 23, 2026 10:48
Comment thread docs/products/postgresql/howto/data-api/get-started.md Outdated
Comment thread docs/products/postgresql/howto/data-api/get-started.md Outdated
Comment thread docs/products/postgresql/howto/data-api/get-started.md Outdated
Comment thread docs/products/postgresql/howto/data-api/index.md Outdated
Comment thread docs/products/postgresql/howto/data-api/index.md Outdated
Comment thread docs/products/postgresql/howto/data-api/index.md Outdated
Comment thread docs/products/postgresql/howto/data-api/manage.md Outdated
Comment thread docs/products/postgresql/howto/data-api/use-endpoints.md Outdated
@wojcik-dorota wojcik-dorota dismissed adir-pur’s stale review July 6, 2026 13:03

comments addressed

@wojcik-dorota wojcik-dorota requested a review from adir-pur July 6, 2026 13:03
@wojcik-dorota wojcik-dorota marked this pull request as draft July 9, 2026 11:34
Comment thread .github/vale/styles/config/vocabularies/Aiven/accept.txt
Comment thread docs/products/postgresql/howto/data-api/authentication.md Outdated
Comment thread docs/products/postgresql/howto/data-api/authentication.md
Comment thread docs/products/postgresql/howto/data-api/use-endpoints.md Outdated
Comment thread docs/products/postgresql/howto/data-api/index.md Outdated
@wojcik-dorota wojcik-dorota requested a review from adir-pur July 10, 2026 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

service/pg tech Relates to technical updates of the docs platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants