Docs: Convert usage example to OpenAPI v3 spec

fastify / fastify-swagger

Swagger documentation generator for Fastify

MIT License

889 stars 199 forks source link

Docs: Convert usage example to OpenAPI v3 spec #792

Closed melroy89 closed 4 months ago

melroy89 commented 4 months ago

Usage example updated to OpenAPI v3 specification. This is tested and validated.

Fixes: https://github.com/fastify/fastify-swagger/issues/790

Troubles reviewing?

GitHub Tip of the day, check the "Hide whitespaces" in the review window:

Checklist

[x] run npm run test and npm run benchmark
[ ] tests and/or benchmarks are included
[x] documentation is changed or added
[x] commit message and code follows the Developer's Certification of Origin and the Code of conduct

melroy89 commented 4 months ago

Could you fix the indentation?

Ah yes. Sorry about that. I needed to force push some changes with another editor. Since vscode tried to auto format this whole Readme markdown file. Lol

melroy89 commented 4 months ago

Indentation is fixed, please review again.