[TT-13564] Add classic to OAS translation guide

[jeffy-mathew]

User description

Description

Add classic API def to OAS API def translation guide

Related Issue

https://tyktech.atlassian.net/browse/TT-13564

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

• I ensured that the documentation is up to date
• I explained why this PR updates go.mod in detail with reasoning why it's required
• I would like a code coverage CI quality gate exception and have explained why

---

PR Type

Documentation

---

Description

• Added a detailed guide for translating Tyk OAS API definitions to Tyk Classic API definitions and vice versa.
• Included step-by-step instructions for struct definitions, field handling, and method implementation.
• Provided patterns for Fill and ExtractTo methods to ensure proper conversion.
• Added guidance for writing and updating tests for conversion functions.
• Included instructions for maintaining and updating the JSON schema for x-tyk-api-gateway.

---

Changes walkthrough 📝

Relevant files

Documentation

apidef-oas.md Add translation guide for Tyk OAS and Classic API definitions. docs/dev/apidef-oas.md Added a comprehensive guide for translating Tyk OAS API definitions to Tyk Classic API definitions and vice versa. Included detailed steps for struct definitions, field handling, and method implementation. Provided patterns for Fill and ExtractTo methods with examples. Added instructions for updating tests and JSON schema. +86/-0

---

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

[buger]

A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

Your branch: chores/oas-feature-parity-guide

Your PR title: Add classic to OAS translation guide

Your PR description:

Description

Add classic API def to OAS API def translation guide

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

• I ensured that the documentation is up to date
• I explained why this PR updates go.mod in detail with reasoning why it's required
• I would like a code coverage CI quality gate exception and have explained why

If this is your first time contributing to this repository - welcome!

---

Please refer to jira-lint to get started.

Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

Valid sample branch names:

‣ feature/shiny-new-feature--mojo-10'
‣ 'chore/changelogUpdate_mojo-123'
‣ 'bugfix/fix-some-strange-bug_GAL-2345'

[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 Documentation Clarity Ensure that the instructions provided for implementing Fill and ExtractTo methods are clear and unambiguous, especially for developers unfamiliar with the conventions mentioned. Test Coverage Verify that the guidance for writing tests and updating the TestOAS_ExtractTo_ResetAPIDefinition test is comprehensive and aligns with the actual testing requirements. JSON Schema Updates Confirm that the instructions for updating the JSON schema for x-tyk-api-gateway are accurate and provide sufficient detail for developers to follow.

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[github-actions]

API Changes

no api changes detected

[sonarqubecloud]

Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarQube Cloud