LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding versioning for nerm apis

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-08-04 16:07:28 -04:00
parent 64ff87b840
commit 0f2e959e7b
4 changed files with 402 additions and 336 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
plugins.ts
View File

@@ -1,8 +1,8 @@
const {createApiPageMD} = require('./createApiPageMD');
import clsx from "clsx";
import clsx from 'clsx';
const pluginConfig = [
[
[
function disableExpensiveBundlerOptimizationPlugin() {
return {
name: 'disable-expensive-bundler-optimizations',
@@ -89,45 +89,48 @@ const pluginConfig = [
groupPathsBy: 'tag',
categoryLinkSource: 'tag',
sidebarGenerators: {
createDocItem(
item,
{ sidebarOptions: { customProps }, basePath }
) {
const sidebar_label = item.frontMatter.sidebar_label;
const title = item.title;
const id =
item.type === "schema" ? `schemas/${item.id}` : item.id;
const className =
item.type === "api"
? clsx(
{
"menu__list-item--deprecated": item.api.deprecated,
"menu__list-item--experimental": !!item.api.parameters?.find(header => header.name === 'X-SailPoint-Experimental'), // checks for existence of extension and adds "experimental" class
"api-method": !!item.api.method,
},
item.api.method
)
: clsx(
{
"menu__list-item--deprecated": item.schema.deprecated,
},
"schema"
);
return {
type: "doc" as const,
id:
basePath === "" || undefined
? `${id}`
: `${basePath}/${id}`,
label: (sidebar_label as string) ?? title ?? id,
customProps: customProps,
className: className ? className : undefined,
};
createDocItem(item, {sidebarOptions: {customProps}, basePath}) {
const sidebar_label = item.frontMatter.sidebar_label;
const title = item.title;
const id =
item.type === 'schema' ? `schemas/${item.id}` : item.id;
const className =
item.type === 'api'
? clsx(
{
'menu__list-item--deprecated': item.api.deprecated,
'menu__list-item--experimental':
!!item.api.parameters?.find(
(header) =>
header.name === 'X-SailPoint-Experimental',
), // checks for existence of extension and adds "experimental" class
'api-method': !!item.api.method,
},
item.api.method,
)
: clsx(
{
'menu__list-item--deprecated': item.schema.deprecated,
},
'schema',
);
return {
type: 'doc' as const,
id:
basePath === '' || undefined
? `${id}`
: `${basePath}/${id}`,
label: (sidebar_label as string) ?? title ?? id,
customProps: customProps,
className: className ? className : undefined,
};
},
},
}},
},
version: 'v2025',
label: 'v2025',
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/refs/heads/main/dereferenced/deref-sailpoint-api.v2025.yaml',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/refs/heads/main/dereferenced/deref-sailpoint-api.v2025.yaml',
baseUrl: '/docs/api/v2025',
template: 'api.mustache',
markdownGenerators: {
@@ -137,21 +140,24 @@ const pluginConfig = [
v2024: {
specPath: 'static/code-examples/v2024/v2024.yaml',
outputDir: 'docs/api/v2024',
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v2024.yaml',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v2024.yaml',
label: 'v2024',
baseUrl: '/docs/api/v2024',
},
v3: {
specPath: 'static/code-examples/v3/v3.yaml',
outputDir: 'docs/api/v3',
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v3.yaml',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v3.yaml',
label: 'v3',
baseUrl: '/docs/api/v3',
},
beta: {
specPath: 'static/code-examples/beta/beta.yaml',
outputDir: 'docs/api/beta',
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.beta.yaml',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.beta.yaml',
label: 'Beta',
baseUrl: '/docs/api/beta',
},
@@ -186,21 +192,33 @@ const pluginConfig = [
id: 'nerm-api',
docsPluginId: 'nerm',
config: {
nerm: {
specPath: 'static/api-specs/nerm/openapi.yaml',
outputDir: 'docs/api/nerm/v1',
nerm_versioned: {
version: 'v2025', // The default version shown
label: 'v2025',
specPath: 'static/api-specs/nerm/v2025/v2025.yaml',
outputDir: 'docs/api/nerm/v2025',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.nerm.yaml',
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.nerm.v2025.yaml',
baseUrl: '/docs/api/nerm/v2025',
sidebarOptions: {
groupPathsBy: 'tag',
categoryLinkSource: 'tag',
},
template: 'api.mustache',
versions: {
v1: {
label: 'v1',
specPath: 'static/api-specs/nerm/openapi.yaml',
outputDir: 'docs/api/nerm/v1',
baseUrl: '/docs/api/nerm/v1',
downloadUrl:
'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.nerm.v1.yaml',
},
},
},
},
},
],
];
export default pluginConfig;