Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions .github/workflows/sync-management-api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,28 @@ jobs:
- name: Install dependencies
run: pnpm install

- name: Fetch OpenAPI spec
working-directory: apps/docs
run: pnpm fetch-openapi

- name: Generate docs
- name: Generate docs and Postman collection
working-directory: apps/docs
run: pnpm run generate:management-api-docs

- name: Check for changes
id: changes
run: |
if [[ -z "$(git status --porcelain --untracked-files=all -- apps/docs/content/docs/management-api/)" ]]; then
if [[ -z "$(git status --porcelain --untracked-files=all -- apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json)" ]]; then
echo "changed=false" >> $GITHUB_OUTPUT
echo "No MDX changes detected"
echo "No changes detected"
else
echo "changed=true" >> $GITHUB_OUTPUT
echo "MDX changes detected:"
git status --short -- apps/docs/content/docs/management-api/
echo "Changes detected:"
git status --short -- apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json
fi

- name: Commit and push
if: steps.changes.outputs.changed == 'true'
run: |
git config user.email "prismabots@gmail.com"
git config user.name "Prismo"
git add apps/docs/content/docs/management-api/
git add apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json
git commit -m "chore(docs): sync management API documentation"
git push "https://x-access-token:${{ secrets.BOT_TOKEN_DOCS_COMMIT }}@github.com/${{ github.repository }}.git" HEAD:${{ github.ref_name }}

Expand Down
2 changes: 2 additions & 0 deletions apps/docs/content/docs/management-api/api-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ metaDescription: Learn how to use the Management API with API Clients

This guide shows you how to configure popular API clients to work with the Management API using OAuth 2.0 authentication.

<a href="/docs/prisma-management-api.postman_collection.json" download="prisma-management-api.postman_collection.json">Download the Postman collection</a> to import all endpoints with OAuth2 auth pre-configured. Compatible with Postman, Yaak, Insomnia, and other clients that support the Postman Collection v2.1 format.

## Postman

Postman is a popular API client with testing, collaboration, and automation features for working with REST APIs.
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading