raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-03-06 02:51:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12032 from mkllnk/swagger

Browse Source 
Show DFC API first in documentation
This commit is contained in:
David Cook
2024-01-11 16:45:16 +11:00
committed by GitHub
parent d197251262 3425be4ded
commit ef82925710
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
config/initializers/rswag_ui.rb
View File

@@ -6,11 +6,11 @@ Rswag::Ui.configure do |config|
# host) to the corresponding endpoint and the second is a title that will be
# displayed in the document selector.
# NOTE: If you're using rspec-api to expose Swagger files
# (under swagger_root) as JSON or YAML endpoints, then the list below should
# (under openapi_root) as JSON or YAML endpoints, then the list below should
# correspond to the relative paths for those endpoints.
config.openapi_endpoint 'v1.yaml', 'API V1 Docs'
config.openapi_endpoint 'dfc.yaml', 'OFN DFC API Docs'
config.openapi_endpoint 'v1.yaml', 'API V1 Docs'
# Add Basic Auth in case your API is private
# config.basic_auth_enabled = true

2
engines/dfc_provider/spec/swagger_helper.rb
View File

@@ -5,7 +5,7 @@ require_relative "spec_helper"
RSpec.configure do |config|
# Override swagger docs to generate only this file:
config.swagger_docs = {
config.openapi_specs = {
'dfc.yaml' => {
openapi: '3.0.1',
info: {

8
spec/swagger_helper.rb
View File

@@ -9,15 +9,15 @@ RSpec.configure do |config|
# 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
config.openapi_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
# be generated at the provided relative path under openapi_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 = {
config.openapi_specs = {
'v1.yaml' => {
openapi: '3.0.1',
info: {
@@ -70,7 +70,7 @@ RSpec.configure do |config|
# 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
config.openapi_format = :yaml
end
module RswagExtension