test-openapi/src/core/spec/start/normalize/content_negotiation.js

Automated client requests

'use strict'

const { filterFormDataMimes } = require('./form_data')

// Get OpenAPI `consumes` and `produces` properties as request headers
const getNegotiationsParams = function({ spec, operation, params }) {
  const contentType = getContentTypeParam({ spec, operation, params })
  const accept = getAcceptParam({ spec, operation })
  return { ...contentType, ...accept }
}

// Get `consumes` and `produces` OpenAPI properties as header parameters instead
// A random request Content-Type will be picked
const getContentTypeParam = function({ spec, operation, params }) {
  const consumes = getConsumes({ spec, operation })

  if (consumes === undefined) {
    return
  }

  const consumesA = filterFormDataMimes({ mimes: consumes, params })
  const value = { type: 'string', enum: consumesA }
  return { 'headers.content-type': value }
}

// But the Accept header is always the same
const getAcceptParam = function({ spec, operation }) {
  const produces = getProduces({ spec, operation })

  if (produces === undefined) {
    return
  }

  const accept = produces.join(',')
  const value = { type: 'string', enum: [accept] }
  return { 'headers.accept': value }
}

// Get OpenAPI `produces` property as a `Content-Type` response header
const getNegotiationsResponse = function({ spec, operation }) {
  const produces = getProduces({ spec, operation })

  if (produces === undefined) {
    return
  }

  return { 'content-type': { type: 'string', enum: produces } }
}

const getConsumes = function({
  spec: { consumes: specConsumes },
  operation: { consumes = specConsumes },
}) {
  return consumes
}

const getProduces = function({
  spec: { produces: specProduces },
  operation: { produces = specProduces },
}) {
  return produces
}

module.exports = {
  getNegotiationsParams,
  getNegotiationsResponse,
}