update-api-reference

To regenerate OpenAPI documentation from Go swag annotations, this skill parses your Go code to update API endpoint definitions and outputs a current openapi.yml file. It ensures your API documentation reflects recent code modifications.

Converting Swagger 2.0 to OpenAPI 3.0 is handled automatically during the documentation generation process. The skill parses Go code annotations and applies the necessary conversion to produce an updated OpenAPI 3.0 specification.

Keeping API documentation in sync with code changes requires running this skill after modifying endpoints. It updates the openapi.yml and docs.go files to accurately reflect any new, modified, or removed API endpoints.

Yes, generating the OpenAPI spec includes applying necessary security schemes and patches. This ensures the final reference documentation is accurate and properly secured after the conversion from Swagger 2.0.

You should regenerate OpenAPI docs for your sandbox-api immediately after adding, modifying, or removing endpoint code. Running the update command ensures the API reference documentation is current and prevents outdated information for developers.