Function pathParam

core/base-service/openapi.js:230–237

* 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

({
  name,
  example,
  schema = { type: 'string' },
  description,
})

 * @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