From b2f47a330399597d709652ff2fa4bee60658f795 Mon Sep 17 00:00:00 2001 From: chris48s Date: Wed, 9 Aug 2023 00:57:47 +0100 Subject: [PATCH] migrate `examples` to `openApi` part 2; affects [archlinux bitcomponents bountysource cdnjs chrome clearlydefined clojars cocoapods coincap] (#9428) * convert an example that doesn't matter * migrate some services from examples to openApi * improve and de-dupe service titles * revert changes to codefactor --- services/archlinux/archlinux.service.js | 30 +++++++++----- services/bit/bit-components.service.js | 25 ++++++++---- services/bountysource/bountysource.service.js | 18 +++++---- services/cdnjs/cdnjs.service.js | 17 +++++--- .../chrome-web-store-price.service.js | 18 +++++---- .../chrome-web-store-users.service.js | 18 +++++---- .../chrome-web-store-version.service.js | 18 +++++---- .../clearlydefined-score.service.js | 40 +++++++++++++------ services/clojars/clojars-downloads.service.js | 16 +++++--- services/cocoapods/cocoapods-docs.service.js | 18 +++++---- .../cocoapods/cocoapods-license.service.js | 17 +++++--- .../cocoapods/cocoapods-platform.service.js | 19 +++++---- .../cocoapods/cocoapods-version.service.js | 17 +++++--- .../coincap-changepercent24hr.service.js | 20 +++++----- services/coincap/coincap-priceusd.service.js | 20 +++++----- services/coincap/coincap-rank.service.js | 18 +++++---- .../github/github-workflow-status.service.js | 2 +- 17 files changed, 209 insertions(+), 122 deletions(-) diff --git a/services/archlinux/archlinux.service.js b/services/archlinux/archlinux.service.js index 8694c3b38948a..84a6c67fca020 100644 --- a/services/archlinux/archlinux.service.js +++ b/services/archlinux/archlinux.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({ pkgver: Joi.string().required(), @@ -13,17 +13,27 @@ export default class ArchLinux extends BaseJsonService { pattern: ':repository/:architecture/:packageName', } - static examples = [ - { - title: 'Arch Linux package', - namedParams: { - architecture: 'x86_64', - repository: 'core', - packageName: 'pacman', + static openApi = { + '/archlinux/v/{repository}/{architecture}/{packageName}': { + get: { + summary: 'Arch Linux package', + parameters: pathParams( + { + name: 'repository', + example: 'core', + }, + { + name: 'architecture', + example: 'x86_64', + }, + { + name: 'packageName', + example: 'pacman', + }, + ), }, - staticPreview: renderVersionBadge({ version: '5.1.3' }), }, - ] + } static defaultBadgeData = { label: 'arch linux' } diff --git a/services/bit/bit-components.service.js b/services/bit/bit-components.service.js index 15f27730d4dfc..7b40a08e4ede7 100644 --- a/services/bit/bit-components.service.js +++ b/services/bit/bit-components.service.js @@ -2,7 +2,7 @@ import Joi from 'joi' import { metric } from '../text-formatters.js' import { nonNegativeInteger } from '../validators.js' import { downloadCount } from '../color-formatters.js' -import { BaseJsonService } from '../index.js' +import { BaseJsonService, pathParams } from '../index.js' const collectionSchema = Joi.object({ payload: Joi.object({ @@ -17,14 +17,23 @@ export default class BitComponents extends BaseJsonService { pattern: ':owner/:collection', } - static examples = [ - { - title: 'bit', - namedParams: { owner: 'ramda', collection: 'ramda' }, - staticPreview: this.render({ count: 330 }), - keywords: ['components'], + static openApi = { + '/bit/collection/total-components/{owner}/{collection}': { + get: { + summary: 'Bit', + parameters: pathParams( + { + name: 'owner', + example: 'ramda', + }, + { + name: 'collection', + example: 'ramda', + }, + ), + }, }, - ] + } static defaultBadgeData = { label: 'components' } diff --git a/services/bountysource/bountysource.service.js b/services/bountysource/bountysource.service.js index 8e7ed9963a7e5..36aaa46d230da 100644 --- a/services/bountysource/bountysource.service.js +++ b/services/bountysource/bountysource.service.js @@ -1,6 +1,6 @@ import Joi from 'joi' import { metric } from '../text-formatters.js' -import { BaseJsonService } from '../index.js' +import { BaseJsonService, pathParams } from '../index.js' const schema = Joi.object({ activity_total: Joi.number().required() }) @@ -8,13 +8,17 @@ export default class Bountysource extends BaseJsonService { static category = 'funding' static route = { base: 'bountysource/team', pattern: ':team/activity' } - static examples = [ - { - title: 'Bountysource', - namedParams: { team: 'mozilla-core' }, - staticPreview: this.render({ total: 53000 }), + static openApi = { + '/bountysource/team/{team}/activity': { + get: { + summary: 'Bountysource', + parameters: pathParams({ + name: 'team', + example: 'mozilla-core', + }), + }, }, - ] + } static defaultBadgeData = { label: 'bounties' } diff --git a/services/cdnjs/cdnjs.service.js b/services/cdnjs/cdnjs.service.js index d1d9e967f59b2..fff7ec39fa5d8 100644 --- a/services/cdnjs/cdnjs.service.js +++ b/services/cdnjs/cdnjs.service.js @@ -1,6 +1,6 @@ import Joi from 'joi' import { renderVersionBadge } from '../version.js' -import { BaseJsonService, NotFound } from '../index.js' +import { BaseJsonService, NotFound, pathParams } from '../index.js' const cdnjsSchema = Joi.object({ // optional due to non-standard 'not found' condition @@ -11,12 +11,17 @@ export default class Cdnjs extends BaseJsonService { static category = 'version' static route = { base: 'cdnjs/v', pattern: ':library' } - static examples = [ - { - namedParams: { library: 'jquery' }, - staticPreview: this.render({ version: '1.5.2' }), + static openApi = { + '/cdnjs/v/{library}': { + get: { + summary: 'Cdnjs', + parameters: pathParams({ + name: 'library', + example: 'jquery', + }), + }, }, - ] + } static defaultBadgeData = { label: 'cdnjs' } diff --git a/services/chrome-web-store/chrome-web-store-price.service.js b/services/chrome-web-store/chrome-web-store-price.service.js index 99068389d04b6..dfc77db672d7c 100644 --- a/services/chrome-web-store/chrome-web-store-price.service.js +++ b/services/chrome-web-store/chrome-web-store-price.service.js @@ -1,18 +1,22 @@ import { currencyFromCode } from '../text-formatters.js' -import { NotFound } from '../index.js' +import { NotFound, pathParams } from '../index.js' import BaseChromeWebStoreService from './chrome-web-store-base.js' export default class ChromeWebStorePrice extends BaseChromeWebStoreService { static category = 'funding' static route = { base: 'chrome-web-store/price', pattern: ':storeId' } - static examples = [ - { - title: 'Chrome Web Store', - namedParams: { storeId: 'ogffaloegjglncjfehdfplabnoondfjo' }, - staticPreview: this.render({ priceCurrency: 'USD', price: 0 }), + static openApi = { + '/chrome-web-store/price/{storeId}': { + get: { + summary: 'Chrome Web Store Price', + parameters: pathParams({ + name: 'storeId', + example: 'ogffaloegjglncjfehdfplabnoondfjo', + }), + }, }, - ] + } static defaultBadgeData = { label: 'price' } diff --git a/services/chrome-web-store/chrome-web-store-users.service.js b/services/chrome-web-store/chrome-web-store-users.service.js index 42b6cfa760224..78175213f38cc 100644 --- a/services/chrome-web-store/chrome-web-store-users.service.js +++ b/services/chrome-web-store/chrome-web-store-users.service.js @@ -1,18 +1,22 @@ import { renderDownloadsBadge } from '../downloads.js' -import { redirector, NotFound } from '../index.js' +import { redirector, NotFound, pathParams } from '../index.js' import BaseChromeWebStoreService from './chrome-web-store-base.js' class ChromeWebStoreUsers extends BaseChromeWebStoreService { static category = 'downloads' static route = { base: 'chrome-web-store/users', pattern: ':storeId' } - static examples = [ - { - title: 'Chrome Web Store', - namedParams: { storeId: 'ogffaloegjglncjfehdfplabnoondfjo' }, - staticPreview: renderDownloadsBadge({ downloads: 573 }), + static openApi = { + '/chrome-web-store/users/{storeId}': { + get: { + summary: 'Chrome Web Store Users', + parameters: pathParams({ + name: 'storeId', + example: 'ogffaloegjglncjfehdfplabnoondfjo', + }), + }, }, - ] + } static defaultBadgeData = { label: 'users' } diff --git a/services/chrome-web-store/chrome-web-store-version.service.js b/services/chrome-web-store/chrome-web-store-version.service.js index e9e42af9596a0..4fac27f85b587 100644 --- a/services/chrome-web-store/chrome-web-store-version.service.js +++ b/services/chrome-web-store/chrome-web-store-version.service.js @@ -1,18 +1,22 @@ import { renderVersionBadge } from '../version.js' -import { NotFound } from '../index.js' +import { NotFound, pathParams } from '../index.js' import BaseChromeWebStoreService from './chrome-web-store-base.js' export default class ChromeWebStoreVersion extends BaseChromeWebStoreService { static category = 'version' static route = { base: 'chrome-web-store/v', pattern: ':storeId' } - static examples = [ - { - title: 'Chrome Web Store', - namedParams: { storeId: 'ogffaloegjglncjfehdfplabnoondfjo' }, - staticPreview: renderVersionBadge({ version: 'v1.1.0' }), + static openApi = { + '/chrome-web-store/v/{storeId}': { + get: { + summary: 'Chrome Web Store Version', + parameters: pathParams({ + name: 'storeId', + example: 'ogffaloegjglncjfehdfplabnoondfjo', + }), + }, }, - ] + } static defaultBadgeData = { label: 'chrome web store' } diff --git a/services/clearlydefined/clearlydefined-score.service.js b/services/clearlydefined/clearlydefined-score.service.js index d100df5bcca76..85a72bfcfefec 100644 --- a/services/clearlydefined/clearlydefined-score.service.js +++ b/services/clearlydefined/clearlydefined-score.service.js @@ -4,7 +4,7 @@ import { optionalNonNegativeInteger, } from '../validators.js' import { floorCount as floorCountColor } from '../color-formatters.js' -import { BaseJsonService, NotFound } from '../index.js' +import { BaseJsonService, NotFound, pathParams } from '../index.js' const schema = Joi.object({ scores: Joi.object({ @@ -24,19 +24,35 @@ export default class ClearlyDefinedService extends BaseJsonService { pattern: 'score/:type/:provider/:namespace/:name/:revision', } - static examples = [ - { - title: 'ClearlyDefined Score', - namedParams: { - type: 'npm', - provider: 'npmjs', - namespace: '-', - name: 'jquery', - revision: '3.4.1', + static openApi = { + '/clearlydefined/score/{type}/{provider}/{namespace}/{name}/{revision}': { + get: { + summary: 'ClearlyDefined Score', + parameters: pathParams( + { + name: 'type', + example: 'npm', + }, + { + name: 'provider', + example: 'npmjs', + }, + { + name: 'namespace', + example: '-', + }, + { + name: 'name', + example: 'jquery', + }, + { + name: 'revision', + example: '3.4.1', + }, + ), }, - staticPreview: this.render({ score: 88 }), }, - ] + } static defaultBadgeData = { label: 'score' } diff --git a/services/clojars/clojars-downloads.service.js b/services/clojars/clojars-downloads.service.js index 4999095dc4e2e..2c5c693ccbe37 100644 --- a/services/clojars/clojars-downloads.service.js +++ b/services/clojars/clojars-downloads.service.js @@ -1,3 +1,4 @@ +import { pathParams } from '../index.js' import { renderDownloadsBadge } from '../downloads.js' import { BaseClojarsService } from './clojars-base.js' @@ -5,12 +6,17 @@ export default class ClojarsDownloads extends BaseClojarsService { static category = 'downloads' static route = { base: 'clojars/dt', pattern: ':clojar+' } - static examples = [ - { - namedParams: { clojar: 'prismic' }, - staticPreview: renderDownloadsBadge({ downloads: 117 }), + static openApi = { + '/clojars/dt/{clojar}': { + get: { + summary: 'Clojars Downloads', + parameters: pathParams({ + name: 'clojar', + example: 'prismic', + }), + }, }, - ] + } static defaultBadgeData = { label: 'downloads' } diff --git a/services/cocoapods/cocoapods-docs.service.js b/services/cocoapods/cocoapods-docs.service.js index a25403ad65efb..20bdd8b57c304 100644 --- a/services/cocoapods/cocoapods-docs.service.js +++ b/services/cocoapods/cocoapods-docs.service.js @@ -1,6 +1,6 @@ import Joi from 'joi' import { coveragePercentage as coveragePercentageColor } from '../color-formatters.js' -import { BaseJsonService } from '../index.js' +import { BaseJsonService, pathParams } from '../index.js' const schema = Joi.object({ cocoadocs: Joi.object({ @@ -12,13 +12,17 @@ export default class CocoapodsDocs extends BaseJsonService { static category = 'analysis' static route = { base: 'cocoapods/metrics/doc-percent', pattern: ':spec' } - static examples = [ - { - title: 'Cocoapods doc percentage', - namedParams: { spec: 'AFNetworking' }, - staticPreview: this.render({ percentage: 94 }), + static openApi = { + '/cocoapods/metrics/doc-percent/{spec}': { + get: { + summary: 'Cocoapods doc percentage', + parameters: pathParams({ + name: 'spec', + example: 'AFNetworking', + }), + }, }, - ] + } static defaultBadgeData = { label: 'docs' } diff --git a/services/cocoapods/cocoapods-license.service.js b/services/cocoapods/cocoapods-license.service.js index 95f401b054c8f..d9d84374bd852 100644 --- a/services/cocoapods/cocoapods-license.service.js +++ b/services/cocoapods/cocoapods-license.service.js @@ -1,16 +1,21 @@ +import { pathParams } from '../index.js' import BaseCocoaPodsService from './cocoapods-base.js' export default class CocoapodsLicense extends BaseCocoaPodsService { static category = 'license' static route = { base: 'cocoapods/l', pattern: ':spec' } - static examples = [ - { - title: 'Cocoapods', - namedParams: { spec: 'AFNetworking' }, - staticPreview: this.render({ license: 'MIT' }), + static openApi = { + '/cocoapods/l/{spec}': { + get: { + summary: 'Cocoapods License', + parameters: pathParams({ + name: 'spec', + example: 'AFNetworking', + }), + }, }, - ] + } static defaultBadgeData = { label: 'license' } diff --git a/services/cocoapods/cocoapods-platform.service.js b/services/cocoapods/cocoapods-platform.service.js index 83cb468d84191..c415aadbf4227 100644 --- a/services/cocoapods/cocoapods-platform.service.js +++ b/services/cocoapods/cocoapods-platform.service.js @@ -1,18 +1,21 @@ +import { pathParams } from '../index.js' import BaseCocoaPodsService from './cocoapods-base.js' export default class CocoapodsPlatform extends BaseCocoaPodsService { static category = 'platform-support' static route = { base: 'cocoapods/p', pattern: ':spec' } - static examples = [ - { - title: 'Cocoapods platforms', - namedParams: { spec: 'AFNetworking' }, - staticPreview: this.render({ - platforms: ['ios', 'osx', 'watchos', 'tvos'], - }), + static openApi = { + '/cocoapods/p/{spec}': { + get: { + summary: 'Cocoapods platforms', + parameters: pathParams({ + name: 'spec', + example: 'AFNetworking', + }), + }, }, - ] + } static defaultBadgeData = { label: 'platform' } diff --git a/services/cocoapods/cocoapods-version.service.js b/services/cocoapods/cocoapods-version.service.js index bc55f8306361d..b5d79226b6e4a 100644 --- a/services/cocoapods/cocoapods-version.service.js +++ b/services/cocoapods/cocoapods-version.service.js @@ -1,3 +1,4 @@ +import { pathParams } from '../index.js' import { renderVersionBadge } from '../version.js' import BaseCocoaPodsService from './cocoapods-base.js' @@ -5,13 +6,17 @@ export default class CocoapodsVersion extends BaseCocoaPodsService { static category = 'version' static route = { base: 'cocoapods/v', pattern: ':spec' } - static examples = [ - { - title: 'Cocoapods', - namedParams: { spec: 'AFNetworking' }, - staticPreview: renderVersionBadge({ version: 'v3.2.1' }), + static openApi = { + '/cocoapods/v/{spec}': { + get: { + summary: 'Cocoapods Version', + parameters: pathParams({ + name: 'spec', + example: 'AFNetworking', + }), + }, }, - ] + } static defaultBadgeData = { label: 'pod' } diff --git a/services/coincap/coincap-changepercent24hr.service.js b/services/coincap/coincap-changepercent24hr.service.js index 29b853b8d499e..2906cc7634943 100644 --- a/services/coincap/coincap-changepercent24hr.service.js +++ b/services/coincap/coincap-changepercent24hr.service.js @@ -1,4 +1,5 @@ import Joi from 'joi' +import { pathParams } from '../index.js' import { floorCount } from '../color-formatters.js' import BaseCoincapService from './coincap-base.js' @@ -14,16 +15,17 @@ const schema = Joi.object({ export default class CoincapChangePercent24HrUsd extends BaseCoincapService { static route = { base: 'coincap/change-percent-24hr', pattern: ':assetId' } - static examples = [ - { - title: 'Coincap (Change Percent 24Hr)', - namedParams: { assetId: 'bitcoin' }, - staticPreview: this.render({ - asset: { name: 'bitcoin', changePercent24Hr: '2.0670573674501840"' }, - }), - keywords: ['bitcoin', 'crypto', 'cryptocurrency'], + static openApi = { + '/coincap/change-percent-24hr/{assetId}': { + get: { + summary: 'Coincap (Change Percent 24Hr)', + parameters: pathParams({ + name: 'assetId', + example: 'bitcoin', + }), + }, }, - ] + } static percentFormat(changePercent24Hr) { return `${parseInt(changePercent24Hr).toFixed(2)}%` diff --git a/services/coincap/coincap-priceusd.service.js b/services/coincap/coincap-priceusd.service.js index 94c1e477c435f..f594c68415858 100644 --- a/services/coincap/coincap-priceusd.service.js +++ b/services/coincap/coincap-priceusd.service.js @@ -1,4 +1,5 @@ import Joi from 'joi' +import { pathParams } from '../index.js' import BaseCoincapService from './coincap-base.js' const schema = Joi.object({ @@ -13,16 +14,17 @@ const schema = Joi.object({ export default class CoincapPriceUsd extends BaseCoincapService { static route = { base: 'coincap/price-usd', pattern: ':assetId' } - static examples = [ - { - title: 'Coincap (Price USD)', - namedParams: { assetId: 'bitcoin' }, - staticPreview: this.render({ - asset: { name: 'bitcoin', priceUsd: '19116.0479117336250772' }, - }), - keywords: ['bitcoin', 'crypto', 'cryptocurrency'], + static openApi = { + '/coincap/price-usd/{assetId}': { + get: { + summary: 'Coincap (Price USD)', + parameters: pathParams({ + name: 'assetId', + example: 'bitcoin', + }), + }, }, - ] + } static priceFormat(price) { return `$${parseFloat(price) diff --git a/services/coincap/coincap-rank.service.js b/services/coincap/coincap-rank.service.js index 7240b4ee9286a..7566b3314e8f1 100644 --- a/services/coincap/coincap-rank.service.js +++ b/services/coincap/coincap-rank.service.js @@ -1,4 +1,5 @@ import Joi from 'joi' +import { pathParams } from '../index.js' import BaseCoincapService from './coincap-base.js' const schema = Joi.object({ @@ -13,14 +14,17 @@ const schema = Joi.object({ export default class CoincapRank extends BaseCoincapService { static route = { base: 'coincap/rank', pattern: ':assetId' } - static examples = [ - { - title: 'Coincap (Rank)', - namedParams: { assetId: 'bitcoin' }, - staticPreview: this.render({ asset: { name: 'bitcoin', rank: '1' } }), - keywords: ['bitcoin', 'crypto', 'cryptocurrency'], + static openApi = { + '/coincap/rank/{assetId}': { + get: { + summary: 'Coincap (Rank)', + parameters: pathParams({ + name: 'assetId', + example: 'bitcoin', + }), + }, }, - ] + } static render({ asset }) { return { diff --git a/services/github/github-workflow-status.service.js b/services/github/github-workflow-status.service.js index 69e6e8f286d8d..9881676db3cf7 100644 --- a/services/github/github-workflow-status.service.js +++ b/services/github/github-workflow-status.service.js @@ -8,7 +8,7 @@ export default class DeprecatedGithubWorkflowStatus extends BaseService { pattern: ':various+', } - static examples = [] + static openApi = {} static defaultBadgeData = { label: 'build' }