[TT-13761] add batch request to the latest open api specs

[yurisasuke]

TT-13761

Summary	add batch request to the latest open api specs
Type	Story
Status	In Code Review
Points	N/A
Labels	-

---

When the new Gateway Open Api spec was created. The Batch request endpoint was left out .This should be added to the gateway OAS.

This pr also fixes an issue where the external OAS Url we were using now return error 404. This pr changes that to use a local copy of the external oas . I.e we have changed from : https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json to https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json

Link: https://tyk.io/docs/5.5/tyk-gateway-api/

TT-13761

[buger]

I'm a bot and I 👍 this PR title. 🤖

[github-actions]

Swagger Changes

  
  
  
  
  
  
  
  
  
  
  
  
    
    
    
    
    
    
    
    
    
    
     _        __  __
    /{listen_path}/tyk/batch:
    BatchReplyUnit:
    BatchRequestStructure:
    RequestDefinition:
   _| |_   _ / _|/ _|  between swagger-prev.yml
  + one list entry added:
  + one list entry added:
  + one list entry added:
  + one list entry added:
  + one list entry added:
  + one map entry added:
  + three map entries added:
  - one list entry removed:
  - one list entry removed:
  - one list entry removed:
  - one list entry removed:
  ± value change
  ± value change
 / _' | | | | |_| |_       and swagger-current.yml
 \__,_|\__, |_| |_|   returned nine differences
components.schemas
paths
paths./tyk/apis/oas.get.responses.200.content.application/json.schema.items.allOf
paths./tyk/apis/oas.post.requestBody.content.application/json.schema.allOf
paths./tyk/apis/oas/import.post.requestBody.content.application/json.schema.$ref
paths./tyk/apis/oas/{apiID}.get.responses.200.content.application/json.schema.allOf
paths./tyk/apis/oas/{apiID}.patch.requestBody.content.application/json.schema.$ref
paths./tyk/apis/oas/{apiID}.put.requestBody.content.application/json.schema.allOf
tags
| (_| | |_| |  _|  _|

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Documentation Clarity The added documentation for the "Batch requests" feature is comprehensive but could benefit from clearer formatting and consistency, especially in the sample request and response sections. Ensure the examples are easy to follow and free of redundancy. Endpoint Definition The new endpoint /{listen_path}/tyk/batch is defined, but its parameters and responses should be thoroughly validated to ensure they align with the intended functionality and do not introduce inconsistencies or errors.

[github-actions]

API Changes

no api changes detected

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	Fix a typo in the batch request documentation for improved accuracy Correct the typo in the phrase "The response will will be" to ensure professional and accurate documentation. swagger.yml [133] -The response will will be a structured reply that encapsulates the responses for each of the outbound requests. +The response will be a structured reply that encapsulates the responses for each of the outbound requests. Suggestion importance[1-10]: 8 Why: Correcting the typo improves the professionalism and accuracy of the documentation. This is a straightforward and necessary fix for maintaining high-quality documentation.	8
	Eliminate redundant sentences in the batch request description for better clarity Remove the duplicate sentence about the usefulness of batch requests to avoid confusion and improve documentation clarity. swagger.yml [91] -This is especially handy if clients have complex requests that have multiple synchronous dependencies and do not wish to have the entire request / response cycle running for each event. +This is especially handy if clients have complex requests that have multiple synchronous dependencies and do not wish to have the entire request / response cycle running for each event. To enable batch request support, set the `enable_batch_request_support` value to `true`. Suggestion importance[1-10]: 6 Why: The suggestion improves documentation clarity by removing a redundant sentence. While it does not affect functionality, it enhances readability and avoids potential confusion.	6
Security	Add clarification or validation for the lack of authentication on the batch request endpoint to prevent misuse Ensure that the Batch requests endpoint explicitly defines the required authentication mechanism or clarifies if no authentication is needed to prevent potential misuse or security vulnerabilities. swagger.yml [101] -Batch requests are created by POSTing to the `/{listen_path}/tyk/batch/` endpoint. These requests **do not require a valid key**, but their request list does. +Batch requests are created by POSTing to the `/{listen_path}/tyk/batch/` endpoint. These requests **do not require a valid key**, but their request list does. Ensure proper validation mechanisms are in place to prevent unauthorized access. Suggestion importance[1-10]: 7 Why: The suggestion highlights a potential security concern by recommending clarification or validation for the lack of authentication on the batch request endpoint. This is a valid and impactful improvement, though it does not provide a concrete implementation.	7

[buger]

I'm a bot and I 👍 this PR title. 🤖

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.8% Coverage on New Code
0.2% Duplication on New Code

See analysis details on SonarQube Cloud

[lghiur]

/release to release-5.7

[lghiur]

/release to release-5.7.1

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@lghiur Seems like there is conflict and it require manual merge.

[tykbot]

@lghiur Seems like there is conflict and it require manual merge.