Skip to content
This repository has been archived by the owner on Jan 28, 2024. It is now read-only.

Commit

Permalink
chore: fix server jsdoc tag param type
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Dec 31, 2021
1 parent 47a9d66 commit 98e9064
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/plugins/jwt-jwks-auth/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ async function getSigningKey(token, jwksUri) {
* @author Frazer Smith
* @description Decorator plugin that adds `verifyJWT` function
* to authenticate JWTs using JWKS endpoint.
* @param {Function} server - Fastify instance.
* @param {object} server - Fastify instance.
* @param {object} options - Plugin config values.
* @param {string} options.jwksEndpoint - URL of endpoint containing JWKS public keys.
* @param {string|Array=} options.allowedAudiences - Accepted recipient(s) that JWT is intended for.
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/shared-schemas/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const S = require("fluent-json-schema");
/**
* @author Frazer Smith
* @description Plugin that adds collection of shared schemas for re-use throughout server.
* @param {Function} server - Fastify instance.
* @param {object} server - Fastify instance.
*/
async function plugin(server) {
// Response schemas
Expand Down
2 changes: 1 addition & 1 deletion src/routes/admin/healthcheck/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const { healthcheckGetSchema } = require("./schema");
* @description Sets routing options for server for healthcheck endpoint.
* This is used by monitoring software to poll and confirm the API is running,
* so needs no authentication.
* @param {Function} server - Fastify instance.
* @param {object} server - Fastify instance.
* @param {object} options - Route config values.
* @param {object} options.cors - CORS settings.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/routes/redirect/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const { redirectGetSchema } = require("./schema");
/**
* @author Frazer Smith
* @description Sets routing options for server.
* @param {Function} server - Fastify instance.
* @param {object} server - Fastify instance.
* @param {object} options - Route config values.
* @param {object} options.cors - CORS settings.
* @param {string} options.redirectUrl - URL and port the Mirth Connect FHIR/HTTP Listener channel is listening on.
Expand Down
2 changes: 1 addition & 1 deletion src/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const sharedSchemas = require("./plugins/shared-schemas");
/**
* @author Frazer Smith
* @description Build Fastify instance.
* @param {Function} server - Fastify instance.
* @param {object} server - Fastify instance.
* @param {object} config - Fastify configuration values.
*/
async function plugin(server, config) {
Expand Down

0 comments on commit 98e9064

Please sign in to comment.