Files
developer.sailpoint.com/sidebars.ts
2025-03-13 16:31:57 -04:00

358 lines
9.6 KiB
TypeScript

import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
import { versionSelector, versionCrumb } from 'docusaurus-plugin-openapi-docs/lib/sidebars/utils';
import versions from './docs/api/v2025/versions.json';
const sidebars: SidebarsConfig = {
openApiSidebar: [
{
type: 'category',
label: 'Documentation',
collapsible: false,
link: { type: 'doc', id: 'docs' },
items: [
{
type: 'category',
label: 'Extensibility',
link: { type: 'doc', id: 'extensibility' },
items: [{ type: 'autogenerated', dirName: 'extensibility' }],
},
{
type: 'category',
label: 'Connectivity',
link: { type: 'doc', id: 'connectivity' },
items: [{ type: 'autogenerated', dirName: 'connectivity' }],
},
{
type: 'category',
label: 'Tools',
link: { type: 'doc', id: 'tools' },
items: [{ type: 'autogenerated', dirName: 'tools' }],
},
{
type: 'category',
label: 'Reporting',
link: { type: 'doc', id: 'reporting' },
items: [{ type: 'autogenerated', dirName: 'reporting' }],
},
{
type: 'category',
label: 'Guides',
link: { type: 'doc', id: 'guides' },
items: [{ type: 'autogenerated', dirName: 'guides' }],
},
{
type: 'link',
label: 'Product Documentation',
href: 'https://documentation.sailpoint.com',
},
],
},
],
iiqSideBar: [
{
type: 'category',
label: 'Documentation',
collapsible: false,
link: { type: 'doc', id: 'iiq' },
items: [
{
type: 'category',
label: 'Plugin Developer Guide',
link: { type: 'doc', id: 'plugin-developer-guide' },
items: [{ type: 'autogenerated', dirName: 'iiq/plugin-developer-guide' }],
},
{
type: 'link',
label: 'Product Documentation',
href: 'https://documentation.sailpoint.com/#identityiq',
},
],
},
],
iiqApiSideBar: [
{
type: 'category',
label: 'API Specifications',
collapsible: false,
link: {
type: 'generated-index',
title: 'API Specifications',
description:
"These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. 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: '/api/iiq',
},
items: require('./docs/api/iiq/sidebar.ts'),
},
],
nermSideBar: [
{
type: 'category',
label: 'NERM',
collapsible: true,
link: { type: 'doc', id: 'api/non-employee' },
customProps: { description: 'NERM API specifications.' },
items: [
{ type: 'doc', id: 'api/nerm/getting-started' },
{ type: 'doc', id: 'api/nerm/authentication' },
{ type: 'doc', id: 'api/nerm/pagination-metadata-filtering' },
{
type: 'category',
label: 'NERM v1 API',
link: {
type: 'generated-index',
title: 'NERM v1 API',
description:
'These are the Non-employee Risk Management APIs for SailPoint. 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: '/api/nerm/v1',
},
items: require('./docs/api/nerm/v1/sidebar.ts'),
},
],
},
],
isc_2025_sidebar: [
{
type: 'html',
defaultStyle: true,
value: versionSelector(versions),
className: 'version-button',
},
{
type: 'html',
defaultStyle: true,
value: versionCrumb(`v2025`),
},
{
type: 'doc',
id: 'api/v2025/getting-started',
},
{
type: 'doc',
id: 'api/v2025/authentication',
},
{
type: 'doc',
id: 'api/v2025/authorization',
},
{
type: 'doc',
id: 'api/v2025/api-versioning-strategy',
},
{
type: 'doc',
id: 'api/v2025/standard-collection-parameters',
},
{
type: 'doc',
id: 'api/v2025/rate-limit',
},
{
type: 'doc',
id: 'api/v2025/postman-collections',
},
{
type: 'doc',
id: 'api/v2025/patch-requests',
},
{
type: 'category',
label: 'V2025 APIs',
link: {
type: 'generated-index',
title: 'v2025 APIs',
description:
'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. 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: '/api/v2025',
},
items: require('./docs/api/v2025/sidebar.ts'),
},
],
isc_2024_sidebar: [
{
type: 'html',
defaultStyle: true,
value: versionSelector(versions),
className: 'version-button',
},
{
type: 'html',
defaultStyle: true,
value: versionCrumb(`v2024`),
},
{
type: 'doc',
id: 'api/v2024/getting-started',
},
{
type: 'doc',
id: 'api/v2024/authentication',
},
{
type: 'doc',
id: 'api/v2024/authorization',
},
{
type: 'doc',
id: 'api/v2024/api-versioning-strategy',
},
{
type: 'doc',
id: 'api/v2024/standard-collection-parameters',
},
{
type: 'doc',
id: 'api/v2024/rate-limit',
},
{
type: 'doc',
id: 'api/v2024/postman-collections',
},
{
type: 'doc',
id: 'api/v2024/patch-requests',
},
{
type: 'category',
label: 'V2024 APIs',
link: {
type: 'generated-index',
title: 'v2024 APIs',
description:
'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. 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: '/api/v2024',
},
items: require('./docs/api/v2024/sidebar.ts'),
},
],
isc_beta_sidebar: [
{
type: 'html',
defaultStyle: true,
value: versionSelector(versions),
className: 'version-button',
},
{
type: 'html',
defaultStyle: true,
value: versionCrumb(`beta`),
},
{
type: 'doc',
id: 'api/beta/getting-started',
},
{
type: 'doc',
id: 'api/beta/authentication',
},
{
type: 'doc',
id: 'api/beta/authorization',
},
{
type: 'doc',
id: 'api/beta/api-versioning-strategy',
},
{
type: 'doc',
id: 'api/beta/standard-collection-parameters',
},
{
type: 'doc',
id: 'api/beta/rate-limit',
},
{
type: 'doc',
id: 'api/beta/postman-collections',
},
{
type: 'doc',
id: 'api/beta/patch-requests',
},
{
type: 'category',
label: 'Beta APIs',
link: {
type: 'generated-index',
title: 'Beta APIs',
description:
'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. 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: '/api/beta',
},
items: require('./docs/api/beta/sidebar.ts'),
},
],
isc_v3_sidebar: [
{
type: 'html',
defaultStyle: true,
value: versionSelector(versions),
className: 'version-button',
},
{
type: 'html',
defaultStyle: true,
value: versionCrumb(`v3`),
},
{
type: 'doc',
id: 'api/v3/getting-started',
},
{
type: 'doc',
id: 'api/v3/authentication',
},
{
type: 'doc',
id: 'api/v3/authorization',
},
{
type: 'doc',
id: 'api/v3/api-versioning-strategy',
},
{
type: 'doc',
id: 'api/v3/standard-collection-parameters',
},
{
type: 'doc',
id: 'api/v3/rate-limit',
},
{
type: 'doc',
id: 'api/v3/postman-collections',
},
{
type: 'doc',
id: 'api/v3/patch-requests',
},
{
type: 'category',
label: 'V3 APIs',
link: {
type: 'generated-index',
title: 'V3 APIs',
description:
'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. 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: '/api/v3',
},
items: require('./docs/api/v3/sidebar.ts'),
},
],
};
export default sidebars;