PER-15119: remove deprecated pdp-api.permit.io host from docs#638
Open
EliMoshkovich wants to merge 1 commit into
Open
PER-15119: remove deprecated pdp-api.permit.io host from docs#638EliMoshkovich wants to merge 1 commit into
EliMoshkovich wants to merge 1 commit into
Conversation
The shared public PDP at pdp-api.permit.io is a legacy/decommissioned instance and is no longer in use. Remove all references to that host: - PDP API Reference page: drop the dead online redoc iframe embed and keep the local-PDP OpenAPI/redoc guidance. - SDK redoc deep-links (all-tenants, url-mapping): repoint to the internal /api/pdp-api-reference page. - authz-query curl examples (all-tenants, authorized_users, user-permissions): repoint to the local PDP at http://localhost:7766, matching the convention used elsewhere in the docs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for permitio-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes all references to the deprecated shared PDP host pdp-api.permit.io from the documentation and walkthrough assets, replacing them with local-PDP guidance and internal doc links to avoid pointing users at a decommissioned/broken endpoint.
Changes:
- Removed the embedded online Redoc iframe that pointed at the deprecated
pdp-api.permit.io/redoc. - Updated deep-links to point to the internal
/api/pdp-api-referencepage instead of the deprecated hosted Redoc. - Updated cURL examples in docs and walkthrough scripts to target a local PDP (
http://localhost:7766).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/api/pdp-api-reference.mdx | Removes deprecated hosted Redoc embed; keeps local OpenAPI/Redoc guidance. |
| docs/sdk/nodejs/all-tenants.mdx | Updates Redoc deep-link and switches cURL example host to local PDP. |
| docs/how-to/enforce-permissions/url-mapping/url-mapping-check.mdx | Updates Redoc deep-link to internal PDP API reference page. |
| src/sdks/walkthroughs/authz-queries/getAuthorizedUsers/example.bash | Switches cURL host to local PDP. |
| src/sdks/walkthroughs/authz-queries/getUserPermissions/example.bash | Switches cURL host to local PDP. |
Comments suppressed due to low confidence (2)
docs/sdk/nodejs/all-tenants.mdx:17
- The text says this endpoint is a GET, but the linked Redoc operation name (previously
..._post) and the JSON request payload imply this should be a POST. Please align the description with the actual request method.
You can also find information about the All tenants check in the [PDP API Reference](/api/pdp-api-reference).
:::
To perform this check, send a GET request to the `/allowed/all-tenants` endpoint with the following parameters:
docs/sdk/nodejs/all-tenants.mdx:30
- This cURL example uses
-X GETwith a JSON body and-D(which dumps response headers). If the endpoint expects the JSON payload shown, it should be sent as a POST with--data(and includeContent-Type: application/json).
curl 'http://localhost:7766/allowed/all-tenants' \
-X GET \
-H 'Authorization: Bearer API_SECRET_KEY' \
-D '{ "user": "employee1", "action": "read", "resource": "document", "context": {}, "sdk": "node" }'
Upon successful completion, the API returns a response indicating whether the user is allowed to perform the specified action across all tenants.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Just like the Permit.io cloud service, the local PDP exposes an OpenAPI spec which can be used to develop your own SDKs. | ||
| Assuming you're running your PDP at `localhost:7000` you can access the spec at `http://localhost:7000/openapi.json` and view the docs at `http://localhost:7000/redoc`. No newline at end of file | ||
| Assuming you're running your PDP at `localhost:7000` you can access the spec at `http://localhost:7000/openapi.json` and view the docs at `http://localhost:7000/redoc`. |
zeevmoney
reviewed
Jun 14, 2026
zeevmoney
left a comment
zeevmoney
left a comment
Contributor
There was a problem hiding this comment.
Automated review — every issue this review found is already covered by existing review comments (e.g. GitHub Copilot or a prior review), so no new comments were posted. Please address those existing comments.
zeevmoney
approved these changes
Jun 15, 2026
zeevmoney
left a comment
zeevmoney
left a comment
Contributor
There was a problem hiding this comment.
See co-pilot comment, approved.
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.
What
Removes all references to the shared public PDP host
pdp-api.permit.iofrom the docs. That instance is a legacy/decommissioned PDP (no longer in use), so any docs pointing at it were either broken (the embedded online Redoc) or steering users at a shared host they shouldn't be calling.Changes
docs/api/pdp-api-reference.mdx<iframe>embed (pdp-api.permit.io/redoc); kept and tidied the local-PDP OpenAPI/Redoc guidance.docs/sdk/nodejs/all-tenants.mdx/api/pdp-api-reference; curl example host →http://localhost:7766.docs/how-to/enforce-permissions/url-mapping/url-mapping-check.mdx/api/pdp-api-reference.src/sdks/walkthroughs/authz-queries/getAuthorizedUsers/example.bashhttp://localhost:7766.src/sdks/walkthroughs/authz-queries/getUserPermissions/example.bashhttp://localhost:7766.Notes
http://localhost:7766is the established local-PDP convention across the docs for these authz endpoints (/allowed,/user-permissions,/authorized_users), so the curl examples now match the rest of the docs.permit-pdp-api-keyGCP secret name ingcp-cloud-run.mdx— that's a secret name, not the host.api/pdp-api-referencepage (and its sidebar entry) is kept, just reframed around the local PDP, so no inbound links or sidebar entries break.cloudpdp.api.permit.io/redoc(the current hosted PDP) instead — left out here since the ask was to remove the dead host, not introduce a new embed.🤖 Generated with Claude Code