raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-01-24 20:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Swagger config to new naming

Browse Source 
Avoids deprecation warnings:

```
DEPRECATION WARNING: swagger_root= is deprecated and will be removed from rswag-api 3.0 (use openapi_root= instead) (called from block in <main> at config/initializers/rswag_api.rb:8)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:12)
DEPRECATION WARNING: Rswag::Ui: WARNING: The method will be renamed to "openapi_endpoint" in v3.0 (called from block in <main> at config/initializers/rswag_ui.rb:13)
```
This commit is contained in:
Maikel Linke
2023-12-21 16:23:27 +11:00
parent 589ae4db44
commit 82d3199cf0
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config/initializers/rswag_api.rb
View File

@@ -5,7 +5,7 @@ Rswag::Api.configure do |config|
# This is used by the Swagger middleware to serve requests for API descriptions
# NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
# that it's configured to generate files in the same folder
config.swagger_root = Rails.root.join("swagger").to_s
config.openapi_root = Rails.root.join("swagger").to_s
# Inject a lamda function to alter the returned Swagger prior to serialization
# The function will have access to the rack env for the current request

4
config/initializers/rswag_ui.rb
View File

@@ -9,8 +9,8 @@ Rswag::Ui.configure do |config|
# (under swagger_root) as JSON or YAML endpoints, then the list below should
# correspond to the relative paths for those endpoints.
config.swagger_endpoint 'v1.yaml', 'API V1 Docs'
config.swagger_endpoint 'dfc.yaml', 'OFN DFC API Docs'
config.openapi_endpoint 'v1.yaml', 'API V1 Docs'
config.openapi_endpoint 'dfc.yaml', 'OFN DFC API Docs'
# Add Basic Auth in case your API is private
# config.basic_auth_enabled = true