migrate some services from examples to openApi

chris48s · Jul 31, 2023 · f33d104 · f33d104
1 parent 57c2ba0
commit f33d104
Show file tree

Hide file tree

Showing 18 changed files with 231 additions and 156 deletions.
diff --git a/services/itunes/itunes.service.js b/services/itunes/itunes.service.js
@@ -1,7 +1,7 @@
 import Joi from 'joi'
 import { renderVersionBadge } from '../version.js'
 import { nonNegativeInteger } from '../validators.js'
-import { BaseJsonService, NotFound } from '../index.js'
+import { BaseJsonService, NotFound, pathParams } from '../index.js'
 
 const schema = Joi.object({
   resultCount: nonNegativeInteger,
@@ -18,13 +18,17 @@ export default class Itunes extends BaseJsonService {
     pattern: ':bundleId',
   }
 
-  static examples = [
-    {
-      title: 'iTunes App Store',
-      namedParams: { bundleId: '803453959' },
-      staticPreview: renderVersionBadge({ version: 'v3.3.3' }),
+  static openApi = {
+    '/itunes/v/{bundleId}': {
+      get: {
+        summary: 'iTunes App Store',
+        parameters: pathParams({
+          name: 'bundleId',
+          example: '803453959',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'itunes app store' }
 

diff --git a/services/jetbrains/jetbrains-downloads.service.js b/services/jetbrains/jetbrains-downloads.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { renderDownloadsBadge } from '../downloads.js'
 import { nonNegativeInteger } from '../validators.js'
 import JetbrainsBase from './jetbrains-base.js'
@@ -29,15 +30,17 @@ export default class JetbrainsDownloads extends JetbrainsBase {
     pattern: ':pluginId',
   }
 
-  static examples = [
-    {
-      title: 'JetBrains plugins',
-      namedParams: {
-        pluginId: '1347',
+  static openApi = {
+    '/jetbrains/plugin/d/{pluginId}': {
+      get: {
+        summary: 'JetBrains plugins',
+        parameters: pathParams({
+          name: 'pluginId',
+          example: '1347',
+        }),
       },
-      staticPreview: renderDownloadsBadge({ downloads: 10200000 }),
     },
-  ]
+  }
 
   async handle({ pluginId }) {
     let downloads

diff --git a/services/jetbrains/jetbrains-version.service.js b/services/jetbrains/jetbrains-version.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { renderVersionBadge } from '../version.js'
 import JetbrainsBase from './jetbrains-base.js'
 
@@ -35,15 +36,17 @@ export default class JetbrainsVersion extends JetbrainsBase {
     pattern: ':pluginId',
   }
 
-  static examples = [
-    {
-      title: 'JetBrains Plugins',
-      namedParams: {
-        pluginId: '9630',
+  static openApi = {
+    '/jetbrains/plugin/v/{pluginId}': {
+      get: {
+        summary: 'JetBrains Plugins',
+        parameters: pathParams({
+          name: 'pluginId',
+          example: '9630',
+        }),
       },
-      staticPreview: this.render({ version: 'v1.7' }),
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'jetbrains plugin' }
 

diff --git a/services/jitpack/jitpack-version.service.js b/services/jitpack/jitpack-version.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(),
@@ -17,17 +17,23 @@ export default class JitPackVersion extends BaseJsonService {
     pattern: ':groupId/:artifactId',
   }
 
-  static examples = [
-    {
-      title: 'JitPack',
-      namedParams: {
-        groupId: 'com.github.jitpack',
-        artifactId: 'maven-simple',
+  static openApi = {
+    '/jitpack/version/{groupId}/{artifactId}': {
+      get: {
+        summary: 'JitPack',
+        parameters: pathParams(
+          {
+            name: 'groupId',
+            example: 'com.github.jitpack',
+          },
+          {
+            name: 'artifactId',
+            example: 'maven-simple',
+          },
+        ),
       },
-      staticPreview: renderVersionBadge({ version: 'v1.1' }),
-      keywords: ['java', 'maven'],
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'jitpack' }
 

diff --git a/services/jsdelivr/jsdelivr-hits-github.service.js b/services/jsdelivr/jsdelivr-hits-github.service.js
@@ -1,3 +1,4 @@
+import { pathParams } from '../index.js'
 import { schema, periodMap, BaseJsDelivrService } from './jsdelivr-base.js'
 
 export default class JsDelivrHitsGitHub extends BaseJsDelivrService {
@@ -6,17 +7,27 @@ export default class JsDelivrHitsGitHub extends BaseJsDelivrService {
     pattern: ':period(hd|hw|hm|hy)/:user/:repo',
   }
 
-  static examples = [
-    {
-      title: 'jsDelivr hits (GitHub)',
-      namedParams: {
-        period: 'hm',
-        user: 'jquery',
-        repo: 'jquery',
+  static openApi = {
+    '/jsdelivr/gh/{period}/{user}/{repo}': {
+      get: {
+        summary: 'jsDelivr hits (GitHub)',
+        parameters: pathParams(
+          {
+            name: 'period',
+            example: 'hm',
+          },
+          {
+            name: 'user',
+            example: 'jquery',
+          },
+          {
+            name: 'repo',
+            example: 'jquery',
+          },
+        ),
       },
-      staticPreview: this.render({ period: 'hm', hits: 9809876 }),
     },
-  ]
+  }
 
   async fetch({ period, user, repo }) {
     return this._requestJson({

diff --git a/services/keybase/keybase-btc.service.js b/services/keybase/keybase-btc.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { nonNegativeInteger } from '../validators.js'
 import KeybaseProfile from './keybase-profile.js'
 
@@ -32,16 +33,17 @@ export default class KeybaseBTC extends KeybaseProfile {
     pattern: ':username',
   }
 
-  static examples = [
-    {
-      title: 'Keybase BTC',
-      namedParams: { username: 'skyplabs' },
-      staticPreview: this.render({
-        address: '12ufRLmbEmgjsdGzhUUFY4pcfiQZyRPV9J',
-      }),
-      keywords: ['bitcoin'],
+  static openApi = {
+    '/keybase/btc/{username}': {
+      get: {
+        summary: 'Keybase BTC',
+        parameters: pathParams({
+          name: 'username',
+          example: 'skyplabs',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = {
     label: 'btc',

diff --git a/services/keybase/keybase-pgp.service.js b/services/keybase/keybase-pgp.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { nonNegativeInteger } from '../validators.js'
 import KeybaseProfile from './keybase-profile.js'
 
@@ -28,13 +29,17 @@ export default class KeybasePGP extends KeybaseProfile {
     pattern: ':username',
   }
 
-  static examples = [
-    {
-      title: 'Keybase PGP',
-      namedParams: { username: 'skyplabs' },
-      staticPreview: this.render({ fingerprint: '1863145FD39EE07E' }),
+  static openApi = {
+    '/keybase/pgp/{username}': {
+      get: {
+        summary: 'Keybase PGP',
+        parameters: pathParams({
+          name: 'username',
+          example: 'skyplabs',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = {
     label: 'pgp',

diff --git a/services/keybase/keybase-xlm.service.js b/services/keybase/keybase-xlm.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { nonNegativeInteger } from '../validators.js'
 import KeybaseProfile from './keybase-profile.js'
 
@@ -30,16 +31,17 @@ export default class KeybaseXLM extends KeybaseProfile {
     pattern: ':username',
   }
 
-  static examples = [
-    {
-      title: 'Keybase XLM',
-      namedParams: { username: 'skyplabs' },
-      staticPreview: this.render({
-        address: 'GCGH37DYONEBPGAZGCHJEZZF3J2Q3EFYZBQBE6UJL5QKTULCMEA6MXLA',
-      }),
-      keywords: ['stellar'],
+  static openApi = {
+    '/keybase/xlm/{username}': {
+      get: {
+        summary: 'Keybase XLM',
+        parameters: pathParams({
+          name: 'username',
+          example: 'skyplabs',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = {
     label: 'xlm',

diff --git a/services/keybase/keybase-zec.service.js b/services/keybase/keybase-zec.service.js
@@ -1,4 +1,5 @@
 import Joi from 'joi'
+import { pathParams } from '../index.js'
 import { nonNegativeInteger } from '../validators.js'
 import KeybaseProfile from './keybase-profile.js'
 
@@ -32,16 +33,17 @@ export default class KeybaseZEC extends KeybaseProfile {
     pattern: ':username',
   }
 
-  static examples = [
-    {
-      title: 'Keybase ZEC',
-      namedParams: { username: 'skyplabs' },
-      staticPreview: this.render({
-        address: 't1RJDxpBcsgqAotqhepkhLFMv2XpMfvnf1y',
-      }),
-      keywords: ['zcash'],
+  static openApi = {
+    '/keybase/zec/{username}': {
+      get: {
+        summary: 'Keybase ZEC',
+        parameters: pathParams({
+          name: 'username',
+          example: 'skyplabs',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = {
     label: 'zec',

diff --git a/services/lemmy/lemmy.service.js b/services/lemmy/lemmy.service.js
@@ -1,6 +1,6 @@
 import Joi from 'joi'
 import { metric } from '../text-formatters.js'
-import { BaseJsonService, InvalidParameter } from '../index.js'
+import { BaseJsonService, InvalidParameter, pathParams } from '../index.js'
 
 const lemmyCommunitySchema = Joi.object({
   community_view: Joi.object({
@@ -18,16 +18,17 @@ export default class Lemmy extends BaseJsonService {
     pattern: ':community',
   }
 
-  static examples = [
-    {
-      title: 'Lemmy',
-      namedParams: { community: 'asklemmy@lemmy.ml' },
-      staticPreview: this.render({
-        community: 'asklemmy@lemmy.ml',
-        members: 42,
-      }),
+  static openApi = {
+    '/lemmy/{community}': {
+      get: {
+        summary: 'Lemmy',
+        parameters: pathParams({
+          name: 'community',
+          example: 'asklemmy@lemmy.ml',
+        }),
+      },
     },
-  ]
+  }
 
   static defaultBadgeData = { label: 'community' }
 

diff --git a/services/liberapay/liberapay-gives.service.js b/services/liberapay/liberapay-gives.service.js
@@ -1,20 +1,20 @@
-import { InvalidResponse } from '../index.js'
+import { InvalidResponse, pathParams } from '../index.js'
 import { renderCurrencyBadge, LiberapayBase } from './liberapay-base.js'
 
 export default class LiberapayGives extends LiberapayBase {
   static route = this.buildRoute('gives')
 
-  static examples = [
-    {
-      title: 'Liberapay giving',
-      namedParams: { entity: 'Changaco' },
-      staticPreview: renderCurrencyBadge({
-        label: 'gives',
-        amount: '2.58',
-        currency: 'EUR',
-      }),
+  static openApi = {
+    '/liberapay/gives/{entity}': {
+      get: {
+        summary: 'Liberapay giving',
+        parameters: pathParams({
+          name: 'entity',
+          example: 'Changaco',
+        }),
+      },
     },
-  ]
+  }
 
   async handle({ entity }) {
     const data = await this.fetch({ entity })