410 lines
19 KiB
HTML
410 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: core/base-service/openapi.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: core/base-service/openapi.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Functions for publishing the shields.io URL schema as an OpenAPI Document
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
const baseUrl = process.env.BASE_URL
|
|
const globalParamRefs = [
|
|
{ $ref: '#/components/parameters/style' },
|
|
{ $ref: '#/components/parameters/logo' },
|
|
{ $ref: '#/components/parameters/logoColor' },
|
|
{ $ref: '#/components/parameters/logoSize' },
|
|
{ $ref: '#/components/parameters/label' },
|
|
{ $ref: '#/components/parameters/labelColor' },
|
|
{ $ref: '#/components/parameters/color' },
|
|
{ $ref: '#/components/parameters/cacheSeconds' },
|
|
{ $ref: '#/components/parameters/link' },
|
|
]
|
|
|
|
function getCodeSamples(altText) {
|
|
return [
|
|
{
|
|
lang: 'URL',
|
|
label: 'URL',
|
|
source: '$url',
|
|
},
|
|
{
|
|
lang: 'Markdown',
|
|
label: 'Markdown',
|
|
source: ``,
|
|
},
|
|
{
|
|
lang: 'reStructuredText',
|
|
label: 'rSt',
|
|
source: `.. image:: $url\n :alt: ${altText}`,
|
|
},
|
|
{
|
|
lang: 'AsciiDoc',
|
|
label: 'AsciiDoc',
|
|
source: `image:$url[${altText}]`,
|
|
},
|
|
{
|
|
lang: 'HTML',
|
|
label: 'HTML',
|
|
source: `<img alt="${altText}" src="$url">`,
|
|
},
|
|
]
|
|
}
|
|
|
|
function getEnum(pattern, paramName) {
|
|
const re = new RegExp(`${paramName}\\(([A-Za-z0-9_\\-|]+)\\)`)
|
|
const match = pattern.match(re)
|
|
if (match === null) {
|
|
return undefined
|
|
}
|
|
if (!match[1].includes('|')) {
|
|
return undefined
|
|
}
|
|
return match[1].split('|')
|
|
}
|
|
|
|
function addGlobalProperties(endpoints) {
|
|
const paths = {}
|
|
for (const key of Object.keys(endpoints)) {
|
|
paths[key] = endpoints[key]
|
|
paths[key].get.parameters = [
|
|
...paths[key].get.parameters,
|
|
...globalParamRefs,
|
|
]
|
|
paths[key].get['x-code-samples'] = getCodeSamples(paths[key].get.summary)
|
|
}
|
|
return paths
|
|
}
|
|
|
|
function sortPaths(obj) {
|
|
const entries = Object.entries(obj)
|
|
entries.sort((a, b) => a[1].get.summary.localeCompare(b[1].get.summary))
|
|
return Object.fromEntries(entries)
|
|
}
|
|
|
|
function services2openapi(services, sort) {
|
|
const paths = {}
|
|
for (const service of services) {
|
|
for (const [key, value] of Object.entries(
|
|
addGlobalProperties(service.openApi),
|
|
)) {
|
|
if (key in paths) {
|
|
throw new Error(`Conflicting route: ${key}`)
|
|
}
|
|
paths[key] = value
|
|
}
|
|
}
|
|
return sort ? sortPaths(paths) : paths
|
|
}
|
|
|
|
function category2openapi({ category, services, sort = false }) {
|
|
const spec = {
|
|
openapi: '3.0.0',
|
|
info: {
|
|
version: '1.0.0',
|
|
title: category.name,
|
|
license: {
|
|
name: 'CC0',
|
|
},
|
|
},
|
|
servers: baseUrl ? [{ url: baseUrl }] : undefined,
|
|
components: {
|
|
parameters: {
|
|
style: {
|
|
name: 'style',
|
|
in: 'query',
|
|
required: false,
|
|
description: `If not specified, the default style for this badge is "${
|
|
category.name.toLowerCase() === 'social' ? 'social' : 'flat'
|
|
}".`,
|
|
schema: {
|
|
type: 'string',
|
|
enum: ['flat', 'flat-square', 'plastic', 'for-the-badge', 'social'],
|
|
},
|
|
example: 'flat',
|
|
},
|
|
logo: {
|
|
name: 'logo',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Icon slug from simple-icons. You can click the icon title on <a href="https://simpleicons.org/" rel="noopener noreferrer" target="_blank">simple-icons</a> to copy the slug or they can be found in the <a href="https://github.com/simple-icons/simple-icons/blob/master/slugs.md">slugs.md file</a> in the simple-icons repository. <a href="/docs/logos">Further info</a>.',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'appveyor',
|
|
},
|
|
logoColor: {
|
|
name: 'logoColor',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'violet',
|
|
},
|
|
logoSize: {
|
|
name: 'logoSize',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'auto',
|
|
},
|
|
label: {
|
|
name: 'label',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Override the default left-hand-side text (<a href="https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding">URL-Encoding</a> needed for spaces or special characters!)',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'healthiness',
|
|
},
|
|
labelColor: {
|
|
name: 'labelColor',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'abcdef',
|
|
},
|
|
color: {
|
|
name: 'color',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: 'fedcba',
|
|
},
|
|
cacheSeconds: {
|
|
name: 'cacheSeconds',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).',
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
example: '3600',
|
|
},
|
|
link: {
|
|
name: 'link',
|
|
in: 'query',
|
|
required: false,
|
|
description:
|
|
'Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.',
|
|
style: 'form',
|
|
explode: true,
|
|
schema: {
|
|
type: 'array',
|
|
maxItems: 2,
|
|
items: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
paths: services2openapi(services, sort),
|
|
}
|
|
|
|
return spec
|
|
}
|
|
|
|
/**
|
|
* Helper function for assembling an OpenAPI path parameter object
|
|
*
|
|
* @param {module:core/base-service/openapi~PathParamInput} param Input param
|
|
* @returns {module:core/base-service/openapi~OpenApiParam} OpenAPI Parameter Object
|
|
* @see https://swagger.io/specification/#parameter-object
|
|
*/
|
|
function pathParam({
|
|
name,
|
|
example,
|
|
schema = { type: 'string' },
|
|
description,
|
|
}) {
|
|
return { name, in: 'path', required: true, schema, example, description }
|
|
}
|
|
|
|
/**
|
|
* Helper function for assembling an array of OpenAPI path parameter objects
|
|
* The code
|
|
* ```
|
|
* const params = pathParams(
|
|
* { name: 'name1', example: 'example1' },
|
|
* { name: 'name2', example: 'example2' },
|
|
* )
|
|
* ```
|
|
* is equivalent to
|
|
* ```
|
|
* const params = [
|
|
* pathParam({ name: 'name1', example: 'example1' }),
|
|
* pathParam({ name: 'name2', example: 'example2' }),
|
|
* ]
|
|
* ```
|
|
*
|
|
* @param {...module:core/base-service/openapi~PathParamInput} params Input params
|
|
* @returns {Array.<module:core/base-service/openapi~OpenApiParam>} Array of OpenAPI Parameter Objects
|
|
* @see {@link module:core/base-service/openapi~pathParam}
|
|
*/
|
|
function pathParams(...params) {
|
|
return params.map(param => pathParam(param))
|
|
}
|
|
|
|
/**
|
|
* Helper function for assembling an OpenAPI query parameter object
|
|
*
|
|
* @param {module:core/base-service/openapi~QueryParamInput} param Input param
|
|
* @returns {module:core/base-service/openapi~OpenApiParam} OpenAPI Parameter Object
|
|
* @see https://swagger.io/specification/#parameter-object
|
|
*/
|
|
function queryParam({
|
|
name,
|
|
example,
|
|
schema = { type: 'string' },
|
|
required = false,
|
|
description,
|
|
}) {
|
|
const param = { name, in: 'query', required, schema, example, description }
|
|
if (example === null && schema.type === 'boolean') {
|
|
param.allowEmptyValue = true
|
|
}
|
|
return param
|
|
}
|
|
|
|
/**
|
|
* Helper function for assembling an array of OpenAPI query parameter objects
|
|
* The code
|
|
* ```
|
|
* const params = queryParams(
|
|
* { name: 'name1', example: 'example1' },
|
|
* { name: 'name2', example: 'example2' },
|
|
* )
|
|
* ```
|
|
* is equivalent to
|
|
* ```
|
|
* const params = [
|
|
* queryParam({ name: 'name1', example: 'example1' }),
|
|
* queryParam({ name: 'name2', example: 'example2' }),
|
|
* ]
|
|
* ```
|
|
*
|
|
* @param {...module:core/base-service/openapi~QueryParamInput} params Input params
|
|
* @returns {Array.<module:core/base-service/openapi~OpenApiParam>} Array of OpenAPI Parameter Objects
|
|
* @see {@link module:core/base-service/openapi~queryParam}
|
|
*/
|
|
function queryParams(...params) {
|
|
return params.map(param => queryParam(param))
|
|
}
|
|
|
|
/**
|
|
* @typedef {object} PathParamInput
|
|
* @property {string} name The name of the parameter. Parameter names are case sensitive
|
|
* @property {string} example Example of a valid value for this parameter
|
|
* @property {object} [schema={ type: 'string' }] Parameter schema.
|
|
* An [OpenAPI Schema object](https://swagger.io/specification/#schema-object)
|
|
* specifying the parameter type.
|
|
* Normally this should be omitted as all path parameters are strings.
|
|
* Use this when we also want to pass an enum of valid parameters
|
|
* to be presented as a drop-down in the frontend. e.g:
|
|
* `{'type': 'string', 'enum': ['github', 'bitbucket'}` (Optional)
|
|
* @property {string} description A brief description of the parameter (Optional)
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} QueryParamInput
|
|
* @property {string} name The name of the parameter. Parameter names are case sensitive
|
|
* @property {string|null} example Example of a valid value for this parameter
|
|
* @property {object} [schema={ type: 'string' }] Parameter schema.
|
|
* An [OpenAPI Schema object](https://swagger.io/specification/#schema-object)
|
|
* specifying the parameter type. This can normally be omitted.
|
|
* Query params are usually strings. (Optional)
|
|
* @property {boolean} [required=false] Determines whether this parameter is mandatory (Optional)
|
|
* @property {string} description A brief description of the parameter (Optional)
|
|
*/
|
|
|
|
/**
|
|
* OpenAPI Parameter Object
|
|
*
|
|
* @typedef {object} OpenApiParam
|
|
* @property {string} name The name of the parameter
|
|
* @property {string|null} example Example of a valid value for this parameter
|
|
* @property {('path'|'query')} in The location of the parameter
|
|
* @property {object} schema Parameter schema.
|
|
* An [OpenAPI Schema object](https://swagger.io/specification/#schema-object)
|
|
* specifying the parameter type.
|
|
* @property {boolean} required Determines whether this parameter is mandatory
|
|
* @property {string} description A brief description of the parameter
|
|
* @property {boolean} allowEmptyValue If true, allows the ability to pass an empty value to this parameter
|
|
*/
|
|
|
|
export {
|
|
category2openapi,
|
|
getEnum,
|
|
pathParam,
|
|
pathParams,
|
|
queryParam,
|
|
queryParams,
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-toml.html">core/base-service/base-toml</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_base-service_service-definitions.html">core/base-service/service-definitions</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_date.html">services/date</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_size.html">services/size</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li><li><a href="module-services_version.html">services/version</a></li><li><a href="module-services_website-status.html">services/website-status</a></li><li><a href="module-services_winget_version.html">services/winget/version</a></li></ul><h3>Classes</h3><ul><li><a href="BaseThunderstoreService.html">BaseThunderstoreService</a></li><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-toml-BaseTomlService.html">BaseTomlService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#fakeJwtToken">fakeJwtToken</a></li><li><a href="global.html#generateFakeConfig">generateFakeConfig</a></li><li><a href="global.html#getBadgeExampleCall">getBadgeExampleCall</a></li><li><a href="global.html#getServiceClassAuthOrigin">getServiceClassAuthOrigin</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li><li><a href="global.html#testAuth">testAuth</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Mar 28 2025 18:26:11 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|