memos

Commit Graph

Author	SHA1	Message	Date
boojack	18fb02a1ec	chore: update swag docs (#2178 ) * chore: update swag docs * chore: update	2 years ago
boojack	35f2d399e2	chore: update api v1 docs (#2117 ) * chore: update apiv1 docs * chore: update	2 years ago
Lincoln Nogueira	4491c75135	feat: add SwaggerUI and v1 API docs (#2115 ) * - Refactor several API routes from anonymous functions to regular definitions. Required to add parseable documentation comments. - Add API documentation comments using Swag Declarative Comments Format - Add echo-swagger to serve Swagger-UI at /api/index.html - Fix error response from extraneous parameter resourceId to relatedMemoId in DELETE("/memo/:memoId/relation/:relatedMemoId/type/:relationType") - Add an auto-generated ./docs/api/v1.md for quick reference on repo (generated by swagger-markdown) - Add auxiliary scripts to generate docs.go and swagger.yaml * fix: golangci-lint errors * fix: go fmt flag in swag scripts	2 years ago

Author

SHA1

Message

Date

boojack

18fb02a1ec

chore: update swag docs (#2178 )

* chore: update swag docs

* chore: update

boojack

35f2d399e2

chore: update api v1 docs (#2117 )

* chore: update apiv1 docs

* chore: update

Lincoln Nogueira

4491c75135

feat: add SwaggerUI and v1 API docs (#2115 )

* - Refactor several API routes from anonymous functions to regular definitions. Required to add parseable documentation comments.

- Add API documentation comments using Swag Declarative Comments Format

- Add echo-swagger to serve Swagger-UI at /api/index.html

- Fix error response from extraneous parameter resourceId to relatedMemoId in DELETE("/memo/:memoId/relation/:relatedMemoId/type/:relationType")

- Add an auto-generated ./docs/api/v1.md for quick reference on repo (generated by swagger-markdown)

- Add auxiliary scripts to generate docs.go and swagger.yaml

* fix: golangci-lint errors

* fix: go fmt flag in swag scripts

3 Commits (89ef9b8531fd641c3f41c90da962b18ed4e91c4d)