diff --git a/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md b/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md index e7ec0bd..997ecaf 100644 --- a/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md +++ b/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md @@ -1,5 +1,11 @@ # Auto Provision (Professional) +:::note + +Auto provisioning users requires a paid license. + +::: + Auto provisioning is a feature that allows you to automatically create and manage user accounts in Pangolin when they log in using an external identity provider. This is useful for organizations that want to streamline the onboarding process for new users and ensure that their user accounts are always up-to-date. You will be able to programatically decide the roles and organizations for new users based on the information provided by the identity provider. diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md b/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md new file mode 100644 index 0000000..53210db --- /dev/null +++ b/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md @@ -0,0 +1,75 @@ +# Integration API (Professional) + +:::note + +The Integration API requires a paid license. + +::: + +## Generate API Keys + +You can generate as many API keys as you need. There are two types of API keys: + +### Root API Keys + +Root API keys can only be created by the server admin account from the Server Admin panel. These keys have expanded permissions and can do things such as create and delete organizations. + +### Organization API Keys + +Organization API keys can be created by organization admins from the Organization Admin panel. These keys have limited permissions and can only do things directly related to the organization. + +## Fine-Grained Permissions + +When you create or edit an API key, you can select the permissions that the API key will have. This allows you to create API keys with only the permissions that you need. + +## Configure Integration API + +The below example shows how to expose the Integration API. It will be accessible at `https://api.example.com/v1`. + +There are two things you will need to do to enable the Integration API: + +1. Determine which port the Integration API will run on by setting `server.integration_port` in the configuration file. + +```yaml +server: + integration_port: 3003 +``` + +2. Edit the Traefik `dynamic_config.yml` file to add the following configuration to expose the Integration API. + +```yaml +http: + middlewares: + redirect-to-https: + redirectScheme: + scheme: https + + routers: + # ...existing routers... + int-api-router-redirect: + rule: "Host(`api.fosrl.com`)" + service: int-api-service + entryPoints: + - web + middlewares: + - redirect-to-https + + int-api-router: + rule: "Host(`api.fosrl.com`)" + service: int-api-service + entryPoints: + - websecure + tls: + certResolver: letsencrypt + + services: + # ...existing services... + int-api-service: + loadBalancer: + servers: + - url: "http://pangolin:3003" # Integration API +``` + +## Swagger Docs + +OpenAPI documentation is served via Swagger UI. You can access the documentation at `https://api.example.com/v1/docs`. diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/add-a-role-to-a-user.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/add-a-role-to-a-user.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/add-a-role-to-a-user.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/add-a-role-to-a-user.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-api-key-scoped-to-the-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-api-key-scoped-to-the-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-api-key-scoped-to-the-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-api-key-scoped-to-the-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-client.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-client.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-client.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-client.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-site.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-site.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-new-site.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-new-site.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-resource-rule.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-resource-rule.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-resource-rule.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-resource-rule.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-role.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-role.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-role.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-role.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-a-target-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-target-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-a-target-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-a-target-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-an-idp-policy-for-an-existing-idp-on-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-idp-policy-for-an-existing-idp-on-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-an-idp-policy-for-an-existing-idp-on-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-idp-policy-for-an-existing-idp-on-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-an-oidc-id-p-for-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-oidc-id-p-for-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-an-oidc-id-p-for-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-oidc-id-p-for-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/create-an-oidc-id-p.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-oidc-id-p.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/create-an-oidc-id-p.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/create-an-oidc-id-p.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-access-token.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-access-token.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-access-token.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-access-token.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-client-by-its-client-id.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-client-by-its-client-id.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-client-by-its-client-id.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-client-by-its-client-id.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-resource-rule.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-resource-rule.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-resource-rule.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-resource-rule.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-role.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-role.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-role.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-role.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-site-and-all-its-associated-data.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-site-and-all-its-associated-data.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-site-and-all-its-associated-data.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-site-and-all-its-associated-data.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-a-target.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-target.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-a-target.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-a-target.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-an-api-key.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-an-api-key.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-an-api-key.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-an-api-key.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/delete-idp.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-idp.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/delete-idp.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/delete-idp.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/generate-a-new-access-token-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/generate-a-new-access-token-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/generate-a-new-access-token-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/generate-a-new-access-token-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-client-by-its-client-id.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-client-by-its-client-id.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-client-by-its-client-id.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-client-by-its-client-id.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-site-by-org-id-and-nice-id-nice-id-is-a-readable-id-for-the-site-and-unique-on-a-per-org-basis.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-site-by-org-id-and-nice-id-nice-id-is-a-readable-id-for-the-site-and-unique-on-a-per-org-basis.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-site-by-org-id-and-nice-id-nice-id-is-a-readable-id-for-the-site-and-unique-on-a-per-org-basis.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-site-by-org-id-and-nice-id-nice-id-is-a-readable-id-for-the-site-and-unique-on-a-per-org-basis.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-site-by-site-id.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-site-by-site-id.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-site-by-site-id.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-site-by-site-id.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-target.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-target.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-target.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-target.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-a-user-in-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-user-in-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-a-user-in-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-a-user-in-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-an-idp-by-its-idp-id.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-an-idp-by-its-idp-id.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-an-idp-by-its-idp-id.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-an-idp-by-its-idp-id.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/get-the-whitelist-of-emails-for-a-specific-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-the-whitelist-of-emails-for-a-specific-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/get-the-whitelist-of-emails-for-a-specific-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/get-the-whitelist-of-emails-for-a-specific-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/health-check.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/health-check.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/health-check.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/health-check.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/invite-a-user-to-join-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/invite-a-user-to-join-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/invite-a-user-to-join-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/invite-a-user-to-join-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-access-tokens-in-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-access-tokens-in-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-access-tokens-in-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-access-tokens-in-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-actions-set-for-an-api-key.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-actions-set-for-an-api-key.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-actions-set-for-an-api-key.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-actions-set-for-an-api-key.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-api-keys-for-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-api-keys-for-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-api-keys-for-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-api-keys-for-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-clients-for-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-clients-for-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-clients-for-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-clients-for-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-domains-for-a-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-domains-for-a-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-domains-for-a-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-domains-for-a-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-idp-in-the-system.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-idp-in-the-system.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-idp-in-the-system.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-idp-in-the-system.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-org-policies-on-an-idp.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-org-policies-on-an-idp.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-org-policies-on-an-idp.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-org-policies-on-an-idp.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-organizations-for-a-user.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-organizations-for-a-user.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-organizations-for-a-user.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-organizations-for-a-user.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-organizations-in-the-system.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-organizations-in-the-system.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-organizations-in-the-system.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-organizations-in-the-system.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-roles-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-roles-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-roles-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-roles-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-sites-in-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-sites-in-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-sites-in-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-sites-in-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-all-users-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-users-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-all-users-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-all-users-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-invitations-in-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-invitations-in-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-invitations-in-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-invitations-in-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-resources-for-a-site.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-resources-for-a-site.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-resources-for-a-site.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-resources-for-a-site.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-resources-for-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-resources-for-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-resources-for-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-resources-for-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-roles.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-roles.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-roles.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-roles.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-rules-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-rules-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-rules-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-rules-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-targets-for-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-targets-for-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-targets-for-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-targets-for-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/list-users-in-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-users-in-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/list-users-in-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/list-users-in-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/pangolin-integration-api.info.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/pangolin-integration-api.info.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/pangolin-integration-api.info.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/pangolin-integration-api.info.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/remove-a-user-from-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/remove-a-user-from-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/remove-a-user-from-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/remove-a-user-from-an-organization.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/return-pre-requisite-data-for-creating-a-client.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/return-pre-requisite-data-for-creating-a-client.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/return-pre-requisite-data-for-creating-a-client.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/return-pre-requisite-data-for-creating-a-client.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/return-pre-requisite-data-for-creating-a-site-such-as-the-exit-node-subnet-newt-credentials-etc.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/return-pre-requisite-data-for-creating-a-site-such-as-the-exit-node-subnet-newt-credentials-etc.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/return-pre-requisite-data-for-creating-a-site-such-as-the-exit-node-subnet-newt-credentials-etc.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/return-pre-requisite-data-for-creating-a-site-such-as-the-exit-node-subnet-newt-credentials-etc.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-actions-for-an-api-key-this-will-replace-any-existing-actions.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-actions-for-an-api-key-this-will-replace-any-existing-actions.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-actions-for-an-api-key-this-will-replace-any-existing-actions.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-actions-for-an-api-key-this-will-replace-any-existing-actions.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-email-whitelist-for-a-resource-this-will-replace-all-existing-emails.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-email-whitelist-for-a-resource-this-will-replace-all-existing-emails.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-email-whitelist-for-a-resource-this-will-replace-all-existing-emails.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-email-whitelist-for-a-resource-this-will-replace-all-existing-emails.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-roles-for-a-resource-this-will-replace-all-existing-roles.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-roles-for-a-resource-this-will-replace-all-existing-roles.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-roles-for-a-resource-this-will-replace-all-existing-roles.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-roles-for-a-resource-this-will-replace-all-existing-roles.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-the-password-for-a-resource-setting-the-password-to-null-will-remove-it.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-the-password-for-a-resource-setting-the-password-to-null-will-remove-it.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-the-password-for-a-resource-setting-the-password-to-null-will-remove-it.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-the-password-for-a-resource-setting-the-password-to-null-will-remove-it.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-the-pin-code-for-a-resource-setting-the-pin-code-to-null-will-remove-it.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-the-pin-code-for-a-resource-setting-the-pin-code-to-null-will-remove-it.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-the-pin-code-for-a-resource-setting-the-pin-code-to-null-will-remove-it.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-the-pin-code-for-a-resource-setting-the-pin-code-to-null-will-remove-it.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/set-users-for-a-resource-this-will-replace-all-existing-users.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-users-for-a-resource-this-will-replace-all-existing-users.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/set-users-for-a-resource-this-will-replace-all-existing-users.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/set-users-for-a-resource-this-will-replace-all-existing-users.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/sidebar.ts b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/sidebar.ts similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/sidebar.ts rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/sidebar.ts diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/transfer-a-resource-to-a-different-site-this-will-also-transfer-the-targets-associated-with-the-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/transfer-a-resource-to-a-different-site-this-will-also-transfer-the-targets-associated-with-the-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/transfer-a-resource-to-a-different-site-this-will-also-transfer-the-targets-associated-with-the-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/transfer-a-resource-to-a-different-site-this-will-also-transfer-the-targets-associated-with-the-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-a-client-by-its-client-id.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-client-by-its-client-id.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-a-client-by-its-client-id.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-client-by-its-client-id.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-a-resource-rule.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-resource-rule.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-a-resource-rule.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-resource-rule.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-a-resource.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-resource.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-a-resource.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-resource.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-a-site.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-site.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-a-site.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-site.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-a-target.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-target.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-a-target.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-a-target.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-an-idp-org-policy.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-idp-org-policy.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-an-idp-org-policy.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-idp-org-policy.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-an-oidc-id-p.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-oidc-id-p.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-an-oidc-id-p.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-oidc-id-p.api.mdx diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/update-an-organization.api.mdx b/packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-organization.api.mdx similarity index 100% rename from packages/docusaurus/docs/03-Pangolin/07-API/update-an-organization.api.mdx rename to packages/docusaurus/docs/03-Pangolin/07-API/02-Routes/update-an-organization.api.mdx diff --git a/packages/docusaurus/docusaurus.config.ts b/packages/docusaurus/docusaurus.config.ts index fff73ea..cbceb85 100644 --- a/packages/docusaurus/docusaurus.config.ts +++ b/packages/docusaurus/docusaurus.config.ts @@ -194,7 +194,7 @@ const config: Config = { config: { petstore: { specPath: "./openapi.yml", - outputDir: "docs/03-Pangolin/07-API", + outputDir: "docs/03-Pangolin/07-API/02-Routes", sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "tag",