updated to separate docs sections

This commit is contained in:
philip-ellis-sp
2022-08-30 01:40:21 -04:00
parent b0935db3c8
commit 60fd9d9d70
173 changed files with 342 additions and 285 deletions

6
.gitignore vendored
View File

@@ -19,6 +19,6 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
/docs/arm/api
/docs/idn/api
/docs/iiq/api
/products/arm/api
/products/idn/api
/products/iiq/api

1
docs/README.md Normal file
View File

@@ -0,0 +1 @@
# Developer Relations main

View File

@@ -1,35 +0,0 @@
const openApiSidebar = {
openApiSidebar: [
{
type: "category",
label: "IDN V3",
link: {
type: "generated-index",
title: "IDN V3",
description: "These are the public APIs for SailPoint's SaaS services. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.",
slug: "/category/identity-now-api-v3"
},
// @ts-ignore
items: require("./api/v3/sidebar.js")
},
{
type: "category",
label: "IDN Beta",
link: {
type: "generated-index",
title: "IDN Beta",
description: "These are the public APIs for SailPoint's SaaS services. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.",
slug: "/category/identity-now-api-beta"
},
// @ts-ignore
items: require("./api/beta/sidebar.js")
}
],
idnDocs: [
'idn/getting-started'
]
};
module.exports = openApiSidebar;

View File

View File

@@ -70,19 +70,6 @@ const config = {
{to: '/docs/category/identity-now-api-beta', label: 'Beta APIs'}
// ... more items
],
},
{
type: 'dropdown',
label: 'IdentityNow',
position: 'right',
items: [
{
type: 'doc',
docId: 'idn/docs/getting-started/getting-started',
label: 'Documentation',
},
// ... more items
]
}
]
},
@@ -94,15 +81,34 @@ const config = {
}),
plugins: [
[
"@docusaurus/plugin-content-docs",
{
id: "idn",
path: "products/idn",
routeBasePath: "idn",
sidebarPath: require.resolve("./products/idn/sidebar.js"),
},
],
[
"@docusaurus/plugin-content-docs",
{
id: "iiq",
path: "products/iiq",
routeBasePath: "iiq",
sidebarPath: require.resolve("./products/iiq/sidebar.js"),
},
],
[
"docusaurus-plugin-openapi-docs",
{
id: "openapi",
docsPluginId: "classic",
id: "idn",
docsPluginId: "idn",
config: {
idn_v3: {
specPath: "static/idn-api/sailpoint-api.v3.yaml",
outputDir: "docs/idn/api/v3",
outputDir: "products/idn/api/v3",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
@@ -110,7 +116,24 @@ const config = {
},
idn_beta: {
specPath: "static/idn-api/sailpoint-api.beta.yaml",
outputDir: "docs/idn/api/beta",
outputDir: "products/idn/api/beta",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"
}
},
}
}
],
[
"docusaurus-plugin-openapi-docs",
{
id: "iiq",
docsPluginId: "iiq",
config: {
iiq: {
specPath: "static/iiq-api/swagger.json",
outputDir: "products/iiq/api",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag"

61
package-lock.json generated
View File

@@ -12,7 +12,7 @@
"@docusaurus/preset-classic": "2.0.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"docusaurus-plugin-openapi-docs": "^1.1.6",
"docusaurus-plugin-openapi-docs": "github:philip-ellis-sp/docusaurus-plugin-openapi-docs",
"docusaurus-theme-openapi-docs": "^1.1.6",
"prism-react-renderer": "^1.3.1",
"react": "^17.0.2",
@@ -2956,9 +2956,9 @@
}
},
"node_modules/@redocly/openapi-core": {
"version": "1.0.0-beta.107",
"resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.0.0-beta.107.tgz",
"integrity": "sha512-Hj/DQkPZiaa0L5s4Wu4mKYVkzjKccFudI350scUQ0wykNoXXaYf4Ny82UJdAH4JGfe7Uf5xRoNrpRmeMekj5Uw==",
"version": "1.0.0-beta.108",
"resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.0.0-beta.108.tgz",
"integrity": "sha512-4Lq7KB+XiBvVzpaY/M0a8qog/Zr8kGrvJbRW2z7Sk2Zpc/m+8LTuZbRh15eMoneVc13M9qbHFIRh3PG18g3Tng==",
"dependencies": {
"@redocly/ajv": "^8.6.5",
"@types/node": "^14.11.8",
@@ -5749,8 +5749,8 @@
},
"node_modules/docusaurus-plugin-openapi-docs": {
"version": "1.1.8",
"resolved": "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-1.1.8.tgz",
"integrity": "sha512-A4xEN0dy9WCZavAvAoucEhlklWp8wI57bTlSytvWJWjsYa1qsxgpzOx9fLyUhzodI8XJmGJVHmrQgTi/TdMPiw==",
"resolved": "git+ssh://git@github.com/philip-ellis-sp/docusaurus-plugin-openapi-docs.git#97f436d7433891365e758b92f274b03ca1e2738b",
"license": "MIT",
"dependencies": {
"@apidevtools/json-schema-ref-parser": "^9.0.9",
"@docusaurus/mdx-loader": "2.0.1",
@@ -5772,7 +5772,8 @@
"slugify": "^1.6.5",
"swagger2openapi": "^7.0.8",
"url-template": "^3.0.0",
"webpack": "^5.61.0"
"webpack": "^5.61.0",
"xml-formatter": "^2.6.1"
},
"engines": {
"node": ">=14"
@@ -14857,6 +14858,17 @@
"node": ">=8"
}
},
"node_modules/xml-formatter": {
"version": "2.6.1",
"resolved": "https://registry.npmjs.org/xml-formatter/-/xml-formatter-2.6.1.tgz",
"integrity": "sha512-dOiGwoqm8y22QdTNI7A+N03tyVfBlQ0/oehAzxIZtwnFAHGeSlrfjF73YQvzSsa/Kt6+YZasKsrdu6OIpuBggw==",
"dependencies": {
"xml-parser-xo": "^3.2.0"
},
"engines": {
"node": ">= 10"
}
},
"node_modules/xml-js": {
"version": "1.6.11",
"resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz",
@@ -14868,6 +14880,14 @@
"xml-js": "bin/cli.js"
}
},
"node_modules/xml-parser-xo": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/xml-parser-xo/-/xml-parser-xo-3.2.0.tgz",
"integrity": "sha512-8LRU6cq+d7mVsoDaMhnkkt3CTtAs4153p49fRo+HIB3I1FD1o5CeXRjRH29sQevIfVJIcPjKSsPU/+Ujhq09Rg==",
"engines": {
"node": ">= 10"
}
},
"node_modules/xtend": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz",
@@ -17097,9 +17117,9 @@
}
},
"@redocly/openapi-core": {
"version": "1.0.0-beta.107",
"resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.0.0-beta.107.tgz",
"integrity": "sha512-Hj/DQkPZiaa0L5s4Wu4mKYVkzjKccFudI350scUQ0wykNoXXaYf4Ny82UJdAH4JGfe7Uf5xRoNrpRmeMekj5Uw==",
"version": "1.0.0-beta.108",
"resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.0.0-beta.108.tgz",
"integrity": "sha512-4Lq7KB+XiBvVzpaY/M0a8qog/Zr8kGrvJbRW2z7Sk2Zpc/m+8LTuZbRh15eMoneVc13M9qbHFIRh3PG18g3Tng==",
"requires": {
"@redocly/ajv": "^8.6.5",
"@types/node": "^14.11.8",
@@ -19154,9 +19174,8 @@
}
},
"docusaurus-plugin-openapi-docs": {
"version": "1.1.8",
"resolved": "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-1.1.8.tgz",
"integrity": "sha512-A4xEN0dy9WCZavAvAoucEhlklWp8wI57bTlSytvWJWjsYa1qsxgpzOx9fLyUhzodI8XJmGJVHmrQgTi/TdMPiw==",
"version": "git+ssh://git@github.com/philip-ellis-sp/docusaurus-plugin-openapi-docs.git#97f436d7433891365e758b92f274b03ca1e2738b",
"from": "docusaurus-plugin-openapi-docs@https://github.com/philip-ellis-sp/docusaurus-plugin-openapi-docs",
"requires": {
"@apidevtools/json-schema-ref-parser": "^9.0.9",
"@docusaurus/mdx-loader": "2.0.1",
@@ -19178,7 +19197,8 @@
"slugify": "^1.6.5",
"swagger2openapi": "^7.0.8",
"url-template": "^3.0.0",
"webpack": "^5.61.0"
"webpack": "^5.61.0",
"xml-formatter": "^2.6.1"
},
"dependencies": {
"fs-extra": {
@@ -25627,6 +25647,14 @@
"resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz",
"integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q=="
},
"xml-formatter": {
"version": "2.6.1",
"resolved": "https://registry.npmjs.org/xml-formatter/-/xml-formatter-2.6.1.tgz",
"integrity": "sha512-dOiGwoqm8y22QdTNI7A+N03tyVfBlQ0/oehAzxIZtwnFAHGeSlrfjF73YQvzSsa/Kt6+YZasKsrdu6OIpuBggw==",
"requires": {
"xml-parser-xo": "^3.2.0"
}
},
"xml-js": {
"version": "1.6.11",
"resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz",
@@ -25635,6 +25663,11 @@
"sax": "^1.2.4"
}
},
"xml-parser-xo": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/xml-parser-xo/-/xml-parser-xo-3.2.0.tgz",
"integrity": "sha512-8LRU6cq+d7mVsoDaMhnkkt3CTtAs4153p49fRo+HIB3I1FD1o5CeXRjRH29sQevIfVJIcPjKSsPU/+Ujhq09Rg=="
},
"xtend": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz",

View File

@@ -22,7 +22,7 @@
"@docusaurus/preset-classic": "2.0.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"docusaurus-plugin-openapi-docs": "^1.1.6",
"docusaurus-plugin-openapi-docs": "github:philip-ellis-sp/docusaurus-plugin-openapi-docs",
"docusaurus-theme-openapi-docs": "^1.1.6",
"prism-react-renderer": "^1.3.1",
"react": "^17.0.2",

View File

@@ -1,6 +1,6 @@
---
id: access-request-dynamic-approval
slug: /idn/event-triggers/access-request-dynamic-approval
slug: /event-triggers/access-request-dynamic-approval
---
# Access Request Dynamic Approval

View File

@@ -1,6 +1,6 @@
---
id: access-request-postapproval
slug: /idn/event-triggers/access-request-postapproval
slug: /event-triggers/access-request-postapproval
---
# Access Request Postapproval

View File

@@ -1,6 +1,6 @@
---
id: access-request-preapproval
slug: /idn/event-triggers/access-request-preapproval
slug: /event-triggers/access-request-preapproval
---
# Access Request Preapproval

View File

@@ -1,6 +1,6 @@
---
id: account-aggregation-completed
slug: /idn/event-triggers/account-aggregation-completed
slug: /event-triggers/account-aggregation-completed
---
# Account Aggregation Completed

View File

@@ -1,6 +1,6 @@
---
id: identity-attribute-changed
slug: /idn/event-triggers/identity-attribute-changed
slug: /event-triggers/identity-attribute-changed
---
# Identity Attribute Changed

View File

@@ -1,6 +1,6 @@
---
id: identity-created
slug: /idn/event-triggers/identity-created
slug: /event-triggers/identity-created
---
# Identity Created

View File

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 100 KiB

View File

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 123 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

View File

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 114 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

@@ -1,6 +1,6 @@
---
id: provisioning-action-completed
slug: /idn/event-triggers/provisioning-action-completed
slug: /event-triggers/provisioning-action-completed
---
# Provisioning Action Completed

View File

@@ -1,6 +1,6 @@
---
id: saved-search-completed
slug: /idn/event-triggers/saved-search-completed
slug: /event-triggers/saved-search-completed
---
# Saved Search Completed

View File

@@ -1,6 +1,6 @@
---
id: source-created
slug: /idn/event-triggers/source-created
slug: /event-triggers/source-created
---
# Source Created

View File

@@ -1,6 +1,6 @@
---
id: source-deleted
slug: /idn/event-triggers/source-deleted
slug: /event-triggers/source-deleted
---
# Source Deleted

View File

@@ -1,6 +1,6 @@
---
id: source-updated
slug: /idn/event-triggers/source-updated
slug: /event-triggers/source-updated
---
# Source Updated

View File

@@ -1,6 +1,6 @@
---
id: va-cluster-status-change
slug: /idn/event-triggers/va-cluster-status-change
slug: /event-triggers/va-cluster-status-change
---
# VA Cluster Status Change

View File

@@ -1,6 +1,6 @@
---
id: identity-deleted
slug: /idn/event-triggers/early-access/va-cluster-status-change
slug: /event-triggers/early-access/va-cluster-status-change
---
# Identity Deleted

View File

@@ -1,6 +1,6 @@
---
id: source-account-created
slug: /idn/event-triggers/early-access/source-account-created
slug: /event-triggers/early-access/source-account-created
---
# Source Account Created

View File

@@ -1,6 +1,6 @@
---
id: source-account-deleted
slug: /idn/event-triggers/early-access/source-account-deleted
slug: /event-triggers/early-access/source-account-deleted
---
# Source Account Deleted

View File

@@ -1,6 +1,6 @@
---
id: source-account-updated
slug: /idn/event-triggers/early-access/source-account-updated
slug: /event-triggers/early-access/source-account-updated
---
# Source Account Updated

View File

@@ -1,6 +1,6 @@
---
id: filtering-events
slug: /idn/event-triggers/getting-started/filtering-events
slug: /event-triggers/getting-started/filtering-events
---
# Filtering Events

View File

@@ -1,6 +1,6 @@
---
id: getting-started
slug: /idn/event-triggers/getting-started
slug: /event-triggers/getting-started
---
# Getting Started

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 114 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 192 KiB

After

Width:  |  Height:  |  Size: 192 KiB

View File

Before

Width:  |  Height:  |  Size: 128 KiB

After

Width:  |  Height:  |  Size: 128 KiB

View File

@@ -1,6 +1,6 @@
---
id: preparing-a-subscriber-service
slug: /idn/event-triggers/getting-started/preparing-a-subscriber-service
slug: /event-triggers/getting-started/preparing-a-subscriber-service
---
# Preparing a Subscriber Service

View File

@@ -1,6 +1,6 @@
---
id: responding-to-request-response
slug: /idn/event-triggers/getting-started/responding-to-request-response
slug: /event-triggers/getting-started/responding-to-request-response
---
# Responding to a Request Response Trigger

View File

@@ -1,6 +1,6 @@
---
id: subscribing-to-a-trigger
slug: /idn/event-triggers/getting-started/subscribing-to-a-trigger
slug: /event-triggers/getting-started/subscribing-to-a-trigger
---
# Subscribing to a Trigger

View File

@@ -1,6 +1,6 @@
---
id: testing-triggers
slug: /idn/event-triggers/getting-started/testing-triggers
slug: /event-triggers/getting-started/testing-triggers
---
# Testing Triggers

View File

@@ -1,6 +1,6 @@
---
id: trigger-types
slug: /idn/event-triggers/getting-started/trigger-types
slug: /event-triggers/getting-started/trigger-types
---
# Trigger Types

View File

@@ -1,6 +1,6 @@
---
id: authentication
slug: /idn/getting-started/authentication
slug: /getting-started/authentication
---
# Authentication

View File

@@ -1,6 +1,6 @@
---
id: getting-started
slug: /idn/getting-started
slug: /getting-started
---
# Getting Started with SailPoint APIs

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 92 KiB

View File

@@ -1,6 +1,6 @@
---
id: standard-collection-parameters
slug: /idn/getting-started/standard-collection-parameters
slug: /getting-started/standard-collection-parameters
---
# Standard Collection Parameters

View File

Before

Width:  |  Height:  |  Size: 238 KiB

After

Width:  |  Height:  |  Size: 238 KiB

View File

Before

Width:  |  Height:  |  Size: 223 KiB

After

Width:  |  Height:  |  Size: 223 KiB

View File

@@ -1,6 +1,6 @@
---
id: saas-configuration
slug: /idn/saas-configuration
slug: /saas-configuration
---
# Overview

View File

@@ -1,6 +1,6 @@
---
id: account-create
slug: /idn/saas-connectivity/commands/account-create
slug: /saas-connectivity/commands/account-create
---
# Account Create

View File

@@ -1,6 +1,6 @@
---
id: account-delete
slug: /idn/saas-connectivity/commands/account-delete
slug: /saas-connectivity/commands/account-delete
---
# Account Delete

View File

@@ -1,6 +1,6 @@
---
id: account-discover
slug: /idn/saas-connectivity/commands/account-discover
slug: /saas-connectivity/commands/account-discover
---
# Account Discover Schema

View File

@@ -1,6 +1,6 @@
---
id: account-enable
slug: /idn/saas-connectivity/commands/account-enable
slug: /saas-connectivity/commands/account-enable
---
# Account Enable/Disable

View File

@@ -1,6 +1,6 @@
---
id: account-list
slug: /idn/saas-connectivity/commands/account-list
slug: /saas-connectivity/commands/account-list
---
# Account List

View File

@@ -1,6 +1,6 @@
---
id: account-read
slug: /idn/saas-connectivity/commands/account-read
slug: /saas-connectivity/commands/account-read
---
# Account Read

View File

@@ -1,6 +1,6 @@
---
id: account-unlock
slug: /idn/saas-connectivity/commands/account-unlock
slug: /saas-connectivity/commands/account-unlock
---
# Account Unlock

View File

@@ -1,6 +1,6 @@
---
id: account-update
slug: /idn/saas-connectivity/commands/account-update
slug: /saas-connectivity/commands/account-update
---
# Account Update

View File

@@ -1,6 +1,6 @@
---
id: entitlement-list
slug: /idn/saas-connectivity/commands/entitlement-list
slug: /saas-connectivity/commands/entitlement-list
---
# Entitlement List

View File

@@ -1,6 +1,6 @@
---
id: entitlement-read
slug: /idn/saas-connectivity/commands/entitlement-read
slug: /saas-connectivity/commands/entitlement-read
---
# Entitlement Read

View File

Before

Width:  |  Height:  |  Size: 129 KiB

After

Width:  |  Height:  |  Size: 129 KiB

View File

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 131 KiB

View File

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 132 KiB

View File

Before

Width:  |  Height:  |  Size: 133 KiB

After

Width:  |  Height:  |  Size: 133 KiB

View File

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 108 KiB

View File

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 94 KiB

View File

@@ -1,6 +1,6 @@
---
id: test-connection
slug: /idn/saas-connectivity/commands/test-connection
slug: /saas-connectivity/commands/test-connection
---
# Test Connection

View File

@@ -1,6 +1,6 @@
---
id: cli-common-commands
slug: /idn/saas-connectivity/getting-started/cli-common-commands
slug: /saas-connectivity/getting-started/cli-common-commands
---
# Common CLI/SDK Commands

View File

@@ -1,6 +1,6 @@
---
id: cli
slug: /idn/saas-connectivity/getting-started/cli
slug: /saas-connectivity/getting-started/cli
---
# Getting Started with the CLI

View File

@@ -1,6 +1,6 @@
---
id: cli-test-build-deploy
slug: /idn/saas-connectivity/getting-started/cli-test-build-deploy
slug: /saas-connectivity/getting-started/cli-test-build-deploy
---
# Test, Build, and Deploy Using the CLI
## Testing Your Connector

View File

@@ -1,6 +1,6 @@
---
id: connector-spec
slug: /idn/saas-connectivity/getting-started/connector-spec
slug: /saas-connectivity/getting-started/connector-spec
---
# Connector specification file (connector-spec.json)

View File

@@ -1,6 +1,6 @@
---
id: example-connectors
slug: /idn/saas-connectivity/getting-started/example-connectors
slug: /saas-connectivity/getting-started/example-connectors
---
# Example Connectors

View File

@@ -1,6 +1,6 @@
---
id: getting-started
slug: /idn/saas-connectivity/getting-started
slug: /saas-connectivity/getting-started
---
# SaaS Connectivity

Some files were not shown because too many files have changed in this diff Show More