Improve checking for API spec calls for autocomplete

app/controllers/api_docs/services_controller.rb

@@ -41,7 +41,7 @@ def initialize(name, system_name)
 
     def json
       parsed_content = JSON.parse(file_content)
-      parsed_content['servers'] = [{ 'url' => backend_api? ? backend_base_host : '/' }]
+      parsed_content['servers'] = [{ 'url' => backend_base_host }] if backend_api?
 
       parsed_content
     end
@@ -115,7 +115,6 @@ def index
   def show
     system_name = params[:id].to_sym
     api_file = (api_files.fetch(system_name) { raise ActiveRecord::RecordNotFound }).dup
-    update_base_url(api_file)
     api_file['paths'] = exclude_forbidden_endpoints(api_file['paths']) if master_on_premises?
 
     render json: api_file
@@ -137,8 +136,4 @@ def allowed_api?(api)
       true
     end
   end
-
-  def update_base_url(api_spec)
-    api_spec['servers'] = [{ 'url' => helpers.base_url.gsub(%r{/$}, '') }] if api_spec['servers'][0]['url'] == '/'
-  end
 end

app/javascript/packs/active_docs.ts

@@ -2,17 +2,17 @@
 import SwaggerUI from 'swagger-ui'
 import 'swagger-ui/dist/swagger-ui.css'
 
-import { autocompleteInterceptor } from 'ActiveDocs/OAS3Autocomplete'
+import { autocompleteRequestInterceptor } from 'ActiveDocs/OAS3Autocomplete'
 
 import 'ActiveDocs/swagger-ui-3-patch.scss'
 
 const accountDataUrl = '/api_docs/account_data.json'
 
 window.SwaggerUI = (args: SwaggerUI.SwaggerUIOptions, serviceEndpoint: string) => {
-  const responseInterceptor = (response: SwaggerUI.Response) => autocompleteInterceptor(response, accountDataUrl, serviceEndpoint, args.url)
+  const requestInterceptor = (request: SwaggerUI.Request) => autocompleteRequestInterceptor(request, accountDataUrl, serviceEndpoint)
 
   SwaggerUI({
     ...args,
-    responseInterceptor
+    requestInterceptor
   } as SwaggerUI.SwaggerUIOptions)
 }

app/javascript/packs/service_active_docs.ts

@@ -1,7 +1,7 @@
 import SwaggerUI from 'swagger-ui'
 import 'swagger-ui/dist/swagger-ui.css'
 
-import { autocompleteInterceptor } from 'ActiveDocs/OAS3Autocomplete'
+import { autocompleteRequestInterceptor } from 'ActiveDocs/OAS3Autocomplete'
 
 import 'ActiveDocs/swagger-ui-3-provider-patch.scss'
 
@@ -16,12 +16,12 @@ document.addEventListener('DOMContentLoaded', () => {
   const { url = '', baseUrl = '', serviceEndpoint = '' } = container.dataset
   const accountDataUrl = `${baseUrl}${DATA_URL}`
 
-  const responseInterceptor: SwaggerUI.SwaggerUIOptions['responseInterceptor'] = (response) => autocompleteInterceptor(response, accountDataUrl, serviceEndpoint, url)
+  const requestInterceptor: SwaggerUI.SwaggerUIOptions['requestInterceptor'] = (request) => autocompleteRequestInterceptor(request, accountDataUrl, serviceEndpoint)
 
   SwaggerUI({
     url,
     // eslint-disable-next-line @typescript-eslint/naming-convention -- SwaggerUI API
     dom_id: `#${containerId}`,
-    responseInterceptor
+    requestInterceptor
   })
 })

app/javascript/src/ActiveDocs/OAS3Autocomplete.ts

@@ -12,7 +12,7 @@
 
 import { fetchData } from 'utilities/fetchData'
 
-import type { Response as SwaggerUIResponse } from 'swagger-ui'
+import type { Request as SwaggerUIRequest, Response as SwaggerUIResponse } from 'swagger-ui'
 import type { AccountData } from 'Types/SwaggerTypes'
 
 const X_DATA_ATTRIBUTE = 'x-data-threescale-name'
@@ -136,17 +136,16 @@ const autocompleteOAS3 = async (response: SwaggerUIResponse, accountDataUrl: str
 }
 
 /**
- * Intercept and process the response made by Swagger UI
- * Apply transformations (inject servers list and autocomplete data) to the response for OpenAPI spec requests, and
+ * Intercept the request, and if it fetches the OpenAPI specification, apply a custom responseInterceptor that applies
+ * transformations (inject servers list and autocomplete data) to the response
  * keep the responses to the actual API calls (made through 'Try it out') untouched
- * @param response response to the request made through Swagger UI
- * @param specUrl URL of the OpenAPI specification
+ * @param request request made through Swagger UI
  * @param accountDataUrl URL of the data for autocompletion
  * @param serviceEndpoint Public Base URL of the gateway, that will replace the  URL in the "servers" object
  */
-export const autocompleteInterceptor = (response: SwaggerUIResponse, accountDataUrl: string, serviceEndpoint: string, specUrl?: string): Promise<Response> | SwaggerUIResponse => {
-  if (specUrl !== response.url) {
-    return response
+export const autocompleteRequestInterceptor = (request: SwaggerUIRequest, accountDataUrl: string, serviceEndpoint: string): Promise<SwaggerUIRequest> | SwaggerUIRequest => {
+  if (request.loadSpec) {
+    request.responseInterceptor = (response: SwaggerUIResponse) => autocompleteOAS3(response, accountDataUrl, serviceEndpoint)
   }
-  return autocompleteOAS3(response, accountDataUrl, serviceEndpoint)
-}
+  return request
+}

app/javascript/src/ActiveDocs/ThreeScaleApiDocs.ts

@@ -1,7 +1,7 @@
 import SwaggerUI from 'swagger-ui'
 
 import { fetchData } from 'utilities/fetchData'
-import { autocompleteInterceptor } from 'ActiveDocs/OAS3Autocomplete'
+import { autocompleteRequestInterceptor } from 'ActiveDocs/OAS3Autocomplete'
 
 import type { ApiDocsServices } from 'Types/SwaggerTypes'
 
@@ -27,7 +27,7 @@ export const renderApiDocs = async (container: HTMLElement, apiDocsPath: string,
       url,
       // eslint-disable-next-line @typescript-eslint/naming-convention -- Swagger UI
       dom_id: `#${domId}`,
-      responseInterceptor: (response) => autocompleteInterceptor(response, apiDocsAccountDataPath, '', url),
+      requestInterceptor: (request) => autocompleteRequestInterceptor(request, apiDocsAccountDataPath, ''),
       tryItOutEnabled: true
     })
   })

test/integration/api_docs/services_controller_test.rb

@@ -74,13 +74,13 @@ def test_show_service_management
       assert_equal "https://#{backend_config[:host]}", json["servers"][0]["url"]
     end
 
-    test 'show the correct url for system APIs' do
+    test 'show the relative "/" path for system APIs' do
       system_apis = ApiDocs::ServicesController::API_SYSTEM_NAMES - [:service_management_api]
       system_apis.each do |system_name|
         get api_docs_service_path(format: :json, id: system_name)
         assert_response :success
-        json = JSON.parse(response.body)
-        assert_equal request.base_url, json["servers"][0]["url"]
+        servers = JSON.parse(response.body)["servers"]
+        assert_equal [{ 'url' => '/' }], servers
       end
     end