mirror of
https://github.com/openfoodfoundation/openfoodnetwork
synced 2026-02-25 01:23:23 +00:00
8368a6ccc9
We need to declare in each spec file for which endpoint the spec is because it was just choosing the first declared one by default. The first one was v1 and now it's dfc-v1.7.
120 lines
3.7 KiB
Ruby
120 lines
3.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.configure do |config|
|
|
config.include Devise::Test::IntegrationHelpers, type: :request
|
|
config.include OpenFoodNetwork::ApiHelper, type: :request
|
|
|
|
# Specify a root folder where Swagger JSON files are generated
|
|
# NOTE: If you're using the rswag-api to serve API descriptions, you'll need
|
|
# to ensure that it's configured to serve Swagger from the same folder
|
|
config.swagger_root = Rails.root.join('swagger').to_s
|
|
|
|
# Define one or more Swagger documents and provide global metadata for each one
|
|
# When you run the 'rswag:specs:swaggerize' rake task, the complete Swagger will
|
|
# be generated at the provided relative path under swagger_root
|
|
# By default, the operations defined in spec files are added to the first
|
|
# document below. You can override this behavior by adding a swagger_doc tag to the
|
|
# the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
|
|
config.swagger_docs = {
|
|
'dfc-v1.7/swagger.yaml' => {
|
|
openapi: '3.0.1',
|
|
info: {
|
|
title: 'OFN DFC API',
|
|
version: 'v0.1.7'
|
|
},
|
|
components: {
|
|
securitySchemes: {
|
|
oidc_token: {
|
|
type: :http,
|
|
scheme: :bearer,
|
|
bearerFormat: "JWT",
|
|
description: "OpenID Connect token from a trusted platform"
|
|
},
|
|
ofn_api_token: {
|
|
type: :apiKey,
|
|
in: :header,
|
|
name: 'X-Api-Token',
|
|
description: "API token of an authorized OFN user"
|
|
},
|
|
ofn_session: {
|
|
type: :apiKey,
|
|
in: :cookie,
|
|
name: '_ofn_session',
|
|
description: "Session cookie of a logged in OFN user"
|
|
},
|
|
}
|
|
},
|
|
security: [
|
|
{ oidc_token: [] },
|
|
{ ofn_api_token: [] },
|
|
{ ofn_session: [] },
|
|
],
|
|
paths: {},
|
|
servers: [
|
|
{ url: "/" },
|
|
]
|
|
},
|
|
'v1/swagger.yaml' => {
|
|
openapi: '3.0.1',
|
|
info: {
|
|
title: 'API V1',
|
|
version: 'v1'
|
|
},
|
|
components: {
|
|
schemas: {
|
|
error_response: ErrorsSchema.schema,
|
|
# only customer#show is with extra_fields: {name: :balance, required: true}
|
|
customer: CustomerSchema.schema(require_all: true),
|
|
customers_collection: CustomerSchema.collection(require_all: true, extra_fields: :balance)
|
|
},
|
|
securitySchemes: {
|
|
api_key_header: {
|
|
type: :apiKey,
|
|
name: 'X-Api-Token',
|
|
in: :header,
|
|
description: "Authenticates via API key passed in specified header"
|
|
},
|
|
api_key_param: {
|
|
type: :apiKey,
|
|
name: 'token',
|
|
in: :query,
|
|
description: "Authenticates via API key passed in specified query param"
|
|
},
|
|
session: {
|
|
type: :apiKey,
|
|
name: '_ofn_session',
|
|
in: :cookie,
|
|
description: "Authenticates using the current user's session if logged in"
|
|
},
|
|
}
|
|
},
|
|
paths: {},
|
|
servers: [
|
|
{ url: "/" }
|
|
]
|
|
},
|
|
'v0/swagger.yaml' => {
|
|
openapi: '3.0.1',
|
|
info: {
|
|
title: 'API V0',
|
|
version: 'v0'
|
|
}
|
|
}
|
|
}
|
|
|
|
# Specify the format of the output Swagger file when running 'rswag:specs:swaggerize'.
|
|
# The swagger_docs configuration option has the filename including format in
|
|
# the key, this may want to be changed to avoid putting yaml in json files.
|
|
# Defaults to json. Accepts ':json' and ':yaml'.
|
|
config.swagger_format = :yaml
|
|
end
|
|
|
|
module RswagExtension
|
|
def param(args, &block)
|
|
public_send(:let, args) { instance_eval(&block) }
|
|
end
|
|
end
|
|
Rswag::Specs::ExampleGroupHelpers.prepend RswagExtension
|