${dep.message}
+Removal date: ${dep.removal}
`; + + feed.addItem({ + title, + id: dep.id, + link: DEPRECATIONS_URL, + description: descriptionHtml, + author: [ + { + name: 'Glean', + link: 'https://glean.com', + }, + ], + date: pubDate, + category: [{ name: dep.location }], + }); + } + + // Ensure output directory exists + fs.mkdirSync(RSS_OUTPUT_DIR, { recursive: true }); + + // Write RSS feed + const rssXml = feed.rss2(); + fs.writeFileSync(RSS_OUTPUT_FILE, rssXml); + + console.log( + `Generated deprecations RSS feed with ${allDeprecations.length} entries at ${RSS_OUTPUT_FILE}`, + ); +} + +// Run if called directly +generateRss(); diff --git a/scripts/generate-deprecations.mjs b/scripts/generate-deprecations.mjs new file mode 100644 index 00000000..91485a38 --- /dev/null +++ b/scripts/generate-deprecations.mjs @@ -0,0 +1,11 @@ +#!/usr/bin/env node + +/** + * Generate deprecations.json from OpenAPI specs by extracting x-glean-deprecated properties + * + * Usage: node scripts/generate-deprecations.mjs + */ + +import { generateDeprecations } from './deprecations-lib.mjs'; + +generateDeprecations(); diff --git a/scripts/generator/customMdGenerators.ts b/scripts/generator/customMdGenerators.ts index fa12b757..f94f5f32 100644 --- a/scripts/generator/customMdGenerators.ts +++ b/scripts/generator/customMdGenerators.ts @@ -1,3 +1,5 @@ +import fs from 'fs'; +import path from 'path'; import { createAuthorization } from 'docusaurus-plugin-openapi-docs/lib/markdown/createAuthorization'; import { createCallbacks } from 'docusaurus-plugin-openapi-docs/lib/markdown/createCallbacks'; import { createDeprecationNotice } from 'docusaurus-plugin-openapi-docs/lib/markdown/createDeprecationNotice'; @@ -16,6 +18,63 @@ import { Props, } from 'docusaurus-plugin-openapi-docs/lib/markdown/utils'; import type { ApiPageMetadata } from 'docusaurus-plugin-openapi-docs/lib/types'; +import type { + DeprecationItem, + EndpointGroup, + DeprecationsData, +} from '../../src/types/deprecations'; + +function loadDeprecationsData(): DeprecationsData { + const deprecationsPath = path.resolve( + __dirname, + '../../src/data/deprecations.json', + ); + try { + const content = fs.readFileSync(deprecationsPath, 'utf8'); + return JSON.parse(content); + } catch { + return { endpoints: [], generatedAt: '', totalCount: 0 }; + } +} + +function normalizePath(p: string): string { + let normalized = p.replace(/\/+$/, ''); + normalized = normalized.replace(/^\/rest/, ''); + return normalized.toLowerCase(); +} + +function isDeprecationActive(deprecation: DeprecationItem): boolean { + const [year, month, day] = deprecation.removal.split('-').map(Number); + const removalDate = new Date(year, month - 1, day); + const today = new Date(); + today.setHours(0, 0, 0, 0); + return removalDate >= today; +} + +function getActiveDeprecationsForEndpoint( + method: string, + endpointPath: string, + data: DeprecationsData, +): DeprecationItem[] { + const normalizedInputPath = normalizePath(endpointPath); + const normalizedInputMethod = method.toUpperCase(); + + for (const endpoint of data.endpoints) { + const normalizedEndpointPath = normalizePath(endpoint.path); + const normalizedEndpointMethod = endpoint.method.toUpperCase(); + + if ( + normalizedEndpointMethod === normalizedInputMethod && + normalizedEndpointPath === normalizedInputPath + ) { + return endpoint.deprecations.filter(isDeprecationActive); + } + } + + return []; +} + +const deprecationsData = loadDeprecationsData(); interface RequestBodyProps { title: string; @@ -53,6 +112,26 @@ function createPreviewNotice({ ); } +function createApiDeprecations( + method: string, + endpointPath: string, +): string | undefined { + const activeDeprecations = getActiveDeprecationsForEndpoint( + method, + endpointPath, + deprecationsData, + ); + + if (activeDeprecations.length === 0) { + return undefined; + } + + // Serialize deprecations as JSON for the component + const deprecationsJson = JSON.stringify(activeDeprecations); + + return `\n{displayName}
+ {entry.message}
+ {entry.docs && !docsIsUrl && ( +No deprecations found matching the selected filter.
+{group.path}
+