## **User description**
This pull request contains :
1. The new gateway swagger
2. A new linter
3. And a readme of how to generate the swagger
.
.This provides the documentation on how you can generate the gateway
Open Api specification. It contains a read me with all the steps to
generate the OAS.
The OAS code is in this pr :
#6123
[TT-13109]
___
## **Type**
Documentation
___
## **Description**
- Added a comprehensive README.md in the `tyk-api-documentation`
directory.
- The documentation includes details on the version of OAS used, the
tooling (Redocly), and the library (`openapi-go`) for OAS generation.
- Step-by-step instructions are provided for generating the Swagger.yml
file using a make command in the specified repository branch.
- Describes the file structure within the Swagger directory, explaining
the organization of files by OAS tags and the roles of various files in
the generation process.
___
## **Changes walkthrough**
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation
</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>README.md</strong><dd><code>Add Documentation for
Generating Tyk API Swagger File</code>
</dd></summary>
<hr>
tyk-api-documentation/README.md
<li>Introduced a new README.md for Tyk API Documentation.<br> <li>
Detailed the process and tools used to generate the Open API
<br>Specification (OAS).<br> <li> Provided step-by-step instructions on
how to generate the Swagger.yml <br>file.<br> <li> Explained the file
structure within the Swagger directory.<br>
</details>
</td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6231/files#diff-25581cb9574ab0d44d58541ab1ead676194ddcb9dfe7ba4687197f9673df6093">+33/-0</a>
</td>
</tr>
</table></td></tr></tr></tbody></table>
___
> ✨ **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools
and their descriptions
[DX-1272]:
https://tyktech.atlassian.net/browse/DX-1272?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[TT-13109]:
https://tyktech.atlassian.net/browse/TT-13109?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
---------
Co-authored-by: Yaara <yaara@tyk.io>
(cherry picked from commit ec893f8)