add meaningful descriptions including keywords (#9715)

services/amo/amo-base.js

@@ -2,7 +2,8 @@ import Joi from 'joi'
 import { nonNegativeInteger } from '../validators.js'
 import { BaseJsonService } from '../index.js'
 
-const keywords = ['amo', 'firefox']
+const description =
+  '[addons.mozilla.org](https://addons.mozilla.org) (AMO) publishes extensions for Mozilla Firefox'
 
 const schema = Joi.object({
   average_daily_users: nonNegativeInteger,
@@ -26,4 +27,4 @@ class BaseAmoService extends BaseJsonService {
   }
 }
 
-export { BaseAmoService, keywords }
+export { BaseAmoService, description }

services/amo/amo-downloads.service.js

@@ -1,8 +1,9 @@
 import { renderDownloadsBadge } from '../downloads.js'
 import { redirector, pathParams } from '../index.js'
-import { BaseAmoService } from './amo-base.js'
+import { BaseAmoService, description as baseDescription } from './amo-base.js'
+
+const description = `${baseDescription}
 
-const description = `
 Previously \`amo/d\` provided a “total downloads” badge. However,
 [updates to the v3 API](https://github.com/badges/shields/issues/3079)
 only give us weekly downloads. The route \`amo/d\` redirects to \`amo/dw\`.

services/amo/amo-rating.service.js

@@ -1,7 +1,7 @@
 import { starRating } from '../text-formatters.js'
 import { floorCount as floorCountColor } from '../color-formatters.js'
 import { pathParams } from '../index.js'
-import { BaseAmoService } from './amo-base.js'
+import { BaseAmoService, description } from './amo-base.js'
 
 export default class AmoRating extends BaseAmoService {
   static category = 'rating'
@@ -11,12 +11,14 @@ export default class AmoRating extends BaseAmoService {
     '/amo/rating/{addonId}': {
       get: {
         summary: 'Mozilla Add-on Rating',
+        description,
         parameters: pathParams({ name: 'addonId', example: 'dustman' }),
       },
     },
     '/amo/stars/{addonId}': {
       get: {
         summary: 'Mozilla Add-on Stars',
+        description,
         parameters: pathParams({ name: 'addonId', example: 'dustman' }),
       },
     },

services/amo/amo-users.service.js

@@ -1,6 +1,6 @@
 import { renderDownloadsBadge } from '../downloads.js'
 import { pathParams } from '../index.js'
-import { BaseAmoService } from './amo-base.js'
+import { BaseAmoService, description } from './amo-base.js'
 
 export default class AmoUsers extends BaseAmoService {
   static category = 'downloads'
@@ -10,6 +10,7 @@ export default class AmoUsers extends BaseAmoService {
     '/amo/users/{addonId}': {
       get: {
         summary: 'Mozilla Add-on Users',
+        description,
         parameters: pathParams({ name: 'addonId', example: 'dustman' }),
       },
     },

services/amo/amo-version.service.js

@@ -1,6 +1,6 @@
 import { renderVersionBadge } from '../version.js'
 import { pathParams } from '../index.js'
-import { BaseAmoService } from './amo-base.js'
+import { BaseAmoService, description } from './amo-base.js'
 
 export default class AmoVersion extends BaseAmoService {
   static category = 'version'
@@ -10,6 +10,7 @@ export default class AmoVersion extends BaseAmoService {
     '/amo/v/{addonId}': {
       get: {
         summary: 'Mozilla Add-on Version',
+        description,
         parameters: pathParams({ name: 'addonId', example: 'dustman' }),
       },
     },

services/bit/bit-components.service.js

@@ -20,7 +20,7 @@ export default class BitComponents extends BaseJsonService {
   static openApi = {
     '/bit/collection/total-components/{owner}/{collection}': {
       get: {
-        summary: 'Bit',
+        summary: 'Bit Components',
         parameters: pathParams(
           {
             name: 'owner',

services/coincap/coincap-base.js

@@ -1,5 +1,8 @@
 import { BaseJsonService } from '../index.js'
 
+const description =
+  '[Coincap](https://coincap.io/) is a cryptocurrency exchange'
+
 export default class BaseCoincapService extends BaseJsonService {
   static category = 'other'
 
@@ -19,4 +22,4 @@ export default class BaseCoincapService extends BaseJsonService {
   }
 }
 
-export { BaseCoincapService }
+export { BaseCoincapService, description }

services/coincap/coincap-changepercent24hr.service.js

@@ -1,7 +1,7 @@
 import Joi from 'joi'
 import { pathParams } from '../index.js'
 import { floorCount } from '../color-formatters.js'
-import BaseCoincapService from './coincap-base.js'
+import { BaseCoincapService, description } from './coincap-base.js'
 
 const schema = Joi.object({
   data: Joi.object({
@@ -19,6 +19,7 @@ export default class CoincapChangePercent24HrUsd extends BaseCoincapService {
     '/coincap/change-percent-24hr/{assetId}': {
       get: {
         summary: 'Coincap (Change Percent 24Hr)',
+        description,
         parameters: pathParams({
           name: 'assetId',
           example: 'bitcoin',

services/coincap/coincap-priceusd.service.js

@@ -1,6 +1,6 @@
 import Joi from 'joi'
 import { pathParams } from '../index.js'
-import BaseCoincapService from './coincap-base.js'
+import { BaseCoincapService, description } from './coincap-base.js'
 
 const schema = Joi.object({
   data: Joi.object({
@@ -18,6 +18,7 @@ export default class CoincapPriceUsd extends BaseCoincapService {
     '/coincap/price-usd/{assetId}': {
       get: {
         summary: 'Coincap (Price USD)',
+        description,
         parameters: pathParams({
           name: 'assetId',
           example: 'bitcoin',

services/coincap/coincap-rank.service.js

@@ -1,6 +1,6 @@
 import Joi from 'joi'
 import { pathParams } from '../index.js'
-import BaseCoincapService from './coincap-base.js'
+import { BaseCoincapService, description } from './coincap-base.js'
 
 const schema = Joi.object({
   data: Joi.object({
@@ -18,6 +18,7 @@ export default class CoincapRank extends BaseCoincapService {
     '/coincap/rank/{assetId}': {
       get: {
         summary: 'Coincap (Rank)',
+        description,
         parameters: pathParams({
           name: 'assetId',
           example: 'bitcoin',

services/conan/conan-version.service.js

@@ -13,6 +13,7 @@ export default class ConanVersion extends ConditionalGithubAuthV3Service {
     '/conan/v/{packageName}': {
       get: {
         summary: 'Conan Center',
+        description: '[Conan](https://conan.io/) is a package manager for C++',
         parameters: pathParams({
           name: 'packageName',
           example: 'boost',

services/cpan/cpan-license.service.js

@@ -1,5 +1,5 @@
 import { pathParams } from '../index.js'
-import BaseCpanService from './cpan.js'
+import { BaseCpanService, description } from './cpan.js'
 
 export default class CpanLicense extends BaseCpanService {
   static category = 'license'
@@ -9,6 +9,7 @@ export default class CpanLicense extends BaseCpanService {
     '/cpan/l/{packageName}': {
       get: {
         summary: 'CPAN License',
+        description,
         parameters: pathParams({
           name: 'packageName',
           example: 'Config-Augeas',

services/cpan/cpan-version.service.js

@@ -1,6 +1,6 @@
 import { pathParams } from '../index.js'
 import { renderVersionBadge } from '../version.js'
-import BaseCpanService from './cpan.js'
+import { BaseCpanService, description } from './cpan.js'
 
 export default class CpanVersion extends BaseCpanService {
   static category = 'version'
@@ -10,6 +10,7 @@ export default class CpanVersion extends BaseCpanService {
     '/cpan/v/{packageName}': {
       get: {
         summary: 'CPAN Version',
+        description,
         parameters: pathParams({
           name: 'packageName',
           example: 'Config-Augeas',

services/cpan/cpan.js

@@ -6,6 +6,9 @@ const schema = Joi.object({
   license: Joi.array().items(Joi.string()).min(1).required(),
 }).required()
 
+const description =
+  '[CPAN](https://www.cpan.org/) is a package registry for Perl'
+
 export default class BaseCpanService extends BaseJsonService {
   static defaultBadgeData = { label: 'cpan' }
 
@@ -14,3 +17,5 @@ export default class BaseCpanService extends BaseJsonService {
     return this._requestJson({ schema, url })
   }
 }
+
+export { BaseCpanService, description }