1
0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-11-29 10:24:20 +01:00

fix openAPI documentation

This commit is contained in:
Sylvain 2020-06-15 17:44:56 +02:00
parent 5e8aeb928c
commit 0878ddb333

View File

@ -1,11 +1,15 @@
# frozen_string_literal: true
Apipie.configure do |config|
config.app_name = "Fab-manager"
config.api_base_url = "/open_api"
config.doc_base_url = "/open_api/doc"
config.app_name = 'Fab-manager'
config.api_base_url = '/open_api'
config.doc_base_url = '/open_api/doc'
# where is your API defined?
config.api_controllers_matcher = "#{Rails.root}/app/controllers/open_api/v1/*.rb"
config.validate = false
config.app_info['v1'] = <<-EOS
config.translate = false
config.default_locale = nil
config.app_info['v1'] = <<-RDOC
= Pagination
---
Pagination is done using headers. Following RFC-5988 standard for web linking.
@ -20,5 +24,5 @@ Apipie.configure do |config|
---
Depending on your client, you may have to set header <tt>Accept: application/json</tt> for every request,
otherwise some clients may request *html* by default which will result in error.
EOS
RDOC
end