migrate examples to openApi part 13; affects [curseforge date fedora …

…hsts modrinth ore] (badges#9499) * migrate some services from examples to openApi * improve and de-dupe service titles * improve ore description
Lordfirespeed · Dec 18, 2023 · 4cb17c8 · 4cb17c8
1 parent 557a7eb
commit 4cb17c8
Show file tree

Hide file tree

Showing 19 changed files with 226 additions and 161 deletions.
diff --git a/services/curseforge/curseforge-base.js b/services/curseforge/curseforge-base.js
@@ -14,7 +14,7 @@ const schema = Joi.object({
   }).required(),
 }).required()
 
-const documentation = `
+const description = `
 <p>
   The CurseForge badge requires the <code>Project ID</code> in order access the
   <a href="https://docs.curseforge.com/#get-mod" target="_blank">CurseForge API</a>.
@@ -58,4 +58,4 @@ export default class BaseCurseForgeService extends BaseJsonService {
   }
 }
 
-export { BaseCurseForgeService, documentation }
+export { BaseCurseForgeService, description }
diff --git a/services/curseforge/curseforge-downloads.service.js b/services/curseforge/curseforge-downloads.service.js
@@ -1,5 +1,6 @@
+import { pathParams } from '../index.js'
 import { renderDownloadsBadge } from '../downloads.js'
-import BaseCurseForgeService, { documentation } from './curseforge-base.js'
+import BaseCurseForgeService, { description } from './curseforge-base.js'
 
 export default class CurseForgeDownloads extends BaseCurseForgeService {
   static category = 'downloads'
@@ -9,16 +10,18 @@ export default class CurseForgeDownloads extends BaseCurseForgeService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'CurseForge Downloads',
-      namedParams: {
-        projectId: '238222',
+  static openApi = {
+    '/curseforge/dt/{projectId}': {
+      get: {
+        summary: 'CurseForge Downloads',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: '238222',
+        }),
       },
-      staticPreview: renderDownloadsBadge({ downloads: 234000000 }),
-      documentation,
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'downloads' }
 

diff --git a/services/curseforge/curseforge-game-versions.service.js b/services/curseforge/curseforge-game-versions.service.js
@@ -1,4 +1,5 @@
-import BaseCurseForgeService, { documentation } from './curseforge-base.js'
+import { pathParams } from '../index.js'
+import BaseCurseForgeService, { description } from './curseforge-base.js'
 
 export default class CurseForgeGameVersions extends BaseCurseForgeService {
   static category = 'platform-support'
@@ -8,16 +9,18 @@ export default class CurseForgeGameVersions extends BaseCurseForgeService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'CurseForge Game Versions',
-      namedParams: {
-        projectId: '238222',
+  static openApi = {
+    '/curseforge/game-versions/{projectId}': {
+      get: {
+        summary: 'CurseForge Game Versions',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: '238222',
+        }),
       },
-      staticPreview: this.render({ versions: ['1.20.0', '1.19.4'] }),
-      documentation,
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'game versions' }
 

diff --git a/services/curseforge/curseforge-version.service.js b/services/curseforge/curseforge-version.service.js
@@ -1,5 +1,6 @@
+import { pathParams } from '../index.js'
 import { renderVersionBadge } from '../version.js'
-import BaseCurseForgeService, { documentation } from './curseforge-base.js'
+import BaseCurseForgeService, { description } from './curseforge-base.js'
 
 export default class CurseForgeVersion extends BaseCurseForgeService {
   static category = 'version'
@@ -9,18 +10,18 @@ export default class CurseForgeVersion extends BaseCurseForgeService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'CurseForge Version',
-      namedParams: {
-        projectId: '238222',
+  static openApi = {
+    '/curseforge/v/{projectId}': {
+      get: {
+        summary: 'CurseForge Version',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: '238222',
+        }),
       },
-      staticPreview: renderVersionBadge({
-        version: 'jei-1.20-forge-14.0.0.4.jar',
-      }),
-      documentation,
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'version' }
 

diff --git a/services/date/date.service.js b/services/date/date.service.js
@@ -1,7 +1,7 @@
 import { formatRelativeDate } from '../text-formatters.js'
-import { BaseService } from '../index.js'
+import { BaseService, pathParams } from '../index.js'
 
-const documentation = `
+const description = `
 <p>
   Supply a unix timestamp in seconds to display the relative time from/to now
 </p>
@@ -11,16 +11,18 @@ export default class Date extends BaseService {
   static category = 'other'
   static route = { base: 'date', pattern: ':timestamp(-?[0-9]+)' }
 
-  static examples = [
-    {
-      title: 'Relative date',
-      pattern: ':timestamp',
-      namedParams: { timestamp: '1540814400' },
-      staticPreview: this.render({ relativeDateString: '2 days ago' }),
-      keywords: ['time', 'countdown', 'countup', 'moment'],
-      documentation,
+  static openApi = {
+    '/date/{timestamp}': {
+      get: {
+        summary: 'Relative date',
+        description,
+        parameters: pathParams({
+          name: 'timestamp',
+          example: '1540814400',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'date' }
 

diff --git a/services/fedora/fedora.service.js b/services/fedora/fedora.service.js
@@ -1,6 +1,6 @@
 import Joi from 'joi'
 import { renderVersionBadge } from '../version.js'
-import { BaseJsonService } from '../index.js'
+import { BaseJsonService, pathParams } from '../index.js'
 
 const schema = Joi.object({
   version: Joi.string().required(),
@@ -9,18 +9,40 @@ const schema = Joi.object({
 // No way to permalink to current "stable", https://pagure.io/mdapi/issue/69
 const defaultBranch = 'rawhide'
 
+const description =
+  'See <a href="https://apps.fedoraproject.org/mdapi/">mdapi docs</a> for information on valid branches.'
+
 export default class Fedora extends BaseJsonService {
   static category = 'version'
   static route = { base: 'fedora/v', pattern: ':packageName/:branch?' }
-  static examples = [
-    {
-      title: 'Fedora package',
-      namedParams: { packageName: 'rpm', branch: 'rawhide' },
-      staticPreview: renderVersionBadge({ version: '4.14.2.1' }),
-      documentation:
-        'See <a href="https://apps.fedoraproject.org/mdapi/">mdapi docs</a> for information on valid branches.',
+  static openApi = {
+    '/fedora/v/{packageName}/{branch}': {
+      get: {
+        summary: 'Fedora package (with branch)',
+        description,
+        parameters: pathParams(
+          {
+            name: 'packageName',
+            example: 'rpm',
+          },
+          {
+            name: 'branch',
+            example: 'rawhide',
+          },
+        ),
+      },
     },
-  ]
+    '/fedora/v/{packageName}': {
+      get: {
+        summary: 'Fedora package',
+        description,
+        parameters: pathParams({
+          name: 'packageName',
+          example: 'rpm',
+        }),
+      },
+    },
+  }
 
   static defaultBadgeData = { label: 'fedora' }
 

diff --git a/services/hsts/hsts.service.js b/services/hsts/hsts.service.js
@@ -1,11 +1,12 @@
 import Joi from 'joi'
-import { BaseJsonService } from '../index.js'
+import { BaseJsonService, pathParams } from '../index.js'
+
 const label = 'hsts preloaded'
 const schema = Joi.object({
   status: Joi.string().required(),
 }).required()
 
-const documentation = `
+const description = `
 [\`Strict-Transport-Security\` is an HTTP response header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)
 that signals that browsers should only access the site using HTTPS.
 
@@ -24,15 +25,18 @@ export default class HSTS extends BaseJsonService {
     pattern: ':domain',
   }
 
-  static examples = [
-    {
-      title: 'Chromium HSTS preload',
-      namedParams: { domain: 'github.com' },
-      staticPreview: this.render({ status: 'preloaded' }),
-      keywords: ['security'],
-      documentation,
+  static openApi = {
+    '/hsts/preload/{domain}': {
+      get: {
+        summary: 'Chromium HSTS preload',
+        description,
+        parameters: pathParams({
+          name: 'domain',
+          example: 'github.com',
+        }),
+      },
     },
-  ]
+  }
 
   static render({ status }) {
     let color = 'red'

diff --git a/services/modrinth/modrinth-base.js b/services/modrinth/modrinth-base.js
@@ -16,7 +16,7 @@ const versionSchema = Joi.array()
   )
   .required()
 
-const documentation =
+const description =
   "<p>You can use your project slug, or the project ID. The ID can be found in the 'Technical information' section of your Modrinth page.</p>"
 
 class BaseModrinthService extends BaseJsonService {
@@ -36,4 +36,4 @@ class BaseModrinthService extends BaseJsonService {
   }
 }
 
-export { BaseModrinthService, documentation }
+export { BaseModrinthService, description }
diff --git a/services/modrinth/modrinth-downloads.service.js b/services/modrinth/modrinth-downloads.service.js
@@ -1,5 +1,6 @@
+import { pathParams } from '../index.js'
 import { renderDownloadsBadge } from '../downloads.js'
-import { BaseModrinthService, documentation } from './modrinth-base.js'
+import { BaseModrinthService, description } from './modrinth-base.js'
 
 export default class ModrinthDownloads extends BaseModrinthService {
   static category = 'downloads'
@@ -9,14 +10,18 @@ export default class ModrinthDownloads extends BaseModrinthService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'Modrinth Downloads',
-      namedParams: { projectId: 'AANobbMI' },
-      staticPreview: renderDownloadsBadge({ downloads: 120000 }),
-      documentation,
+  static openApi = {
+    '/modrinth/dt/{projectId}': {
+      get: {
+        summary: 'Modrinth Downloads',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: 'AANobbMI',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'downloads' }
 

diff --git a/services/modrinth/modrinth-followers.service.js b/services/modrinth/modrinth-followers.service.js
@@ -1,5 +1,6 @@
+import { pathParams } from '../index.js'
 import { metric } from '../text-formatters.js'
-import { BaseModrinthService, documentation } from './modrinth-base.js'
+import { BaseModrinthService, description } from './modrinth-base.js'
 
 export default class ModrinthFollowers extends BaseModrinthService {
   static category = 'social'
@@ -9,17 +10,18 @@ export default class ModrinthFollowers extends BaseModrinthService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'Modrinth Followers',
-      namedParams: { projectId: 'AANobbMI' },
-      staticPreview: Object.assign(this.render({ followers: 176 }), {
-        label: 'Followers',
-        style: 'social',
-      }),
-      documentation,
+  static openApi = {
+    '/modrinth/followers/{projectId}': {
+      get: {
+        summary: 'Modrinth Followers',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: 'AANobbMI',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'followers' }
 

diff --git a/services/modrinth/modrinth-game-versions.service.js b/services/modrinth/modrinth-game-versions.service.js
@@ -1,4 +1,5 @@
-import { BaseModrinthService, documentation } from './modrinth-base.js'
+import { pathParams } from '../index.js'
+import { BaseModrinthService, description } from './modrinth-base.js'
 
 export default class ModrinthGameVersions extends BaseModrinthService {
   static category = 'platform-support'
@@ -8,14 +9,18 @@ export default class ModrinthGameVersions extends BaseModrinthService {
     pattern: ':projectId',
   }
 
-  static examples = [
-    {
-      title: 'Modrinth Game Versions',
-      namedParams: { projectId: 'AANobbMI' },
-      staticPreview: this.render({ versions: ['1.19.2', '1.19.1', '1.19'] }),
-      documentation,
+  static openApi = {
+    '/modrinth/game-versions/{projectId}': {
+      get: {
+        summary: 'Modrinth Game Versions',
+        description,
+        parameters: pathParams({
+          name: 'projectId',
+          example: 'AANobbMI',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'game versions' }