[TT-13716]change external oas ref to a local copy in gateway

[yurisasuke]

User description

TT-13716

Summary	The external OAS we use for tyk oas api return 404 in tyk gateway
Type	Story
Status	In Code Review
Points	N/A
Labels	-

---

TT-13716

The external ref https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json returns error 404.

To fix this we have changed from an external ref to a local schema that is saved in the gateway. This will help us have control of the schema.
We have changed 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

---

PR Type

Bug fix

---

Description

• Fixed an issue where the external OpenAPI schema reference URL returned a 404 error by replacing it with a local schema URL.
• Updated .redocly.lint-ignore.yaml to use the new local schema URL.
• Modified swagger.yml to replace all instances of the external schema reference with the local schema URL across multiple API paths.
• Ensured consistent usage of the local schema URL to improve reliability and control over the schema.

---

Changes walkthrough 📝

Relevant files

Bug fix

.redocly.lint-ignore.yaml Replace external OpenAPI schema reference with local schema URL .redocly.lint-ignore.yaml Updated the external OpenAPI schema reference URL to a local schema URL. Ensured the new local schema URL is used consistently in the file. +1/-1      swagger.yml Update OpenAPI schema references in API definitions            swagger.yml Replaced multiple instances of the external OpenAPI schema reference URL with a local schema URL. Updated schema references in various API paths to use the local schema. +6/-6

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[buger]

Let's make that PR title a 💯 shall we? 💪

Your PR title and story title look slightly different. Just checking in to know if it was intentional!

Story Title	The external OAS we use for tyk oas api return 404 in tyk gateway
PR Title	[TT-13716]change external oas ref to a local copy

Check out this guide to learn more about PR best-practices.

[github-actions]

Swagger Changes

  
  
  
  
  
  
  
  
  
  
    
    
    
    
    
    
    
    
     _        __  __
   _| |_   _ / _|/ _|  between swagger-prev.yml
  + one list entry added:
  + one list entry added:
  + one list entry added:
  + one list entry 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 six differences
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
| (_| | |_| |  _|  _|

[github-actions]

API Changes

no api changes detected

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review URL Validation Ensure that the new URL for the OAS schema is accessible and valid as it replaces the previous URL which was returning a 404 error. Schema Consistency Verify that the new local OAS schema is consistent with the previously used external schema to avoid potential discrepancies in API behavior.

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud