chris48sandGitHub
14892e3943
* allow serviceData to override cacheSeconds with a longer value * prevent [endpoint] json cacheSeconds property exceeding service default * allow ShieldsRuntimeError to specify a cacheSeconds property By default error responses use the cacheLength of the service class throwing the error. This allows error to tell the handling layer the maxAge that should be set on the error badge response. * add customExceptions param This 1. allows us to specify custom properties to pass to the exception constructor if we throw any of the standard got errors e.g: `ETIMEDOUT`, `ECONNRESET`, etc 2. uses a custom `cacheSeconds` property (if set on the exception) to set the response maxAge * customExceptions --> systemErrors * errorMessages --> httpErrors
65 lines
1.9 KiB
JavaScript
65 lines
1.9 KiB
JavaScript
import { MetricNames } from '../../core/base-service/metric-helper.js'
|
|
import { BaseJsonService } from '../index.js'
|
|
import { createRoute } from './dynamic-helpers.js'
|
|
import jsonPath from './json-path.js'
|
|
|
|
export default class DynamicJson extends jsonPath(BaseJsonService) {
|
|
static enabledMetrics = [MetricNames.SERVICE_RESPONSE_SIZE]
|
|
static route = createRoute('json')
|
|
static openApi = {
|
|
'/badge/dynamic/json': {
|
|
get: {
|
|
summary: 'Dynamic JSON Badge',
|
|
description: `<p>
|
|
The Dynamic JSON Badge allows you to extract an arbitrary value from any
|
|
JSON Document using a JSONPath selector and show it on a badge.
|
|
</p>`,
|
|
parameters: [
|
|
{
|
|
name: 'url',
|
|
description: 'The URL to a JSON document',
|
|
in: 'query',
|
|
required: true,
|
|
schema: { type: 'string' },
|
|
example:
|
|
'https://github.com/badges/shields/raw/master/package.json',
|
|
},
|
|
{
|
|
name: 'query',
|
|
description:
|
|
'A <a href="https://jsonpath.com/">JSONPath</a> expression that will be used to query the document',
|
|
in: 'query',
|
|
required: true,
|
|
schema: { type: 'string' },
|
|
example: '$.name',
|
|
},
|
|
{
|
|
name: 'prefix',
|
|
description: 'Optional prefix to append to the value',
|
|
in: 'query',
|
|
required: false,
|
|
schema: { type: 'string' },
|
|
example: '[',
|
|
},
|
|
{
|
|
name: 'suffix',
|
|
description: 'Optional suffix to append to the value',
|
|
in: 'query',
|
|
required: false,
|
|
schema: { type: 'string' },
|
|
example: ']',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
}
|
|
|
|
async fetch({ schema, url, httpErrors }) {
|
|
return this._requestJson({
|
|
schema,
|
|
url,
|
|
httpErrors,
|
|
})
|
|
}
|
|
}
|