memos/scripts/gen-api-v1-docs.cfg

# This file is used by gen-api-v1-docs.ps1 and gen-api-v1-docs.sh

# You should list aditional dirs here if the API grows
SWAG_API_DIRS=./server/route/api/v1

# Where general API info is documented
SWAG_GENERAL_INFO=./server/route/api/v1/v1.go

# Possible output files: go (docs.go), json (swagger.json), yaml (swagger.yaml)
SWAG_OUTPUT_TYPES=go,yaml

# Where generated files are outputted
SWAG_OUTPUT=./server/route/api/v1
chore: update api v1 docs (#2117) * chore: update apiv1 docs * chore: update 2023-08-09 22:30:27 +08:00			`# This file is used by gen-api-v1-docs.ps1 and gen-api-v1-docs.sh`
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 2023-08-09 10:53:06 -03:00
			`# You should list aditional dirs here if the API grows`
chore: tweak docs generate path 2024-03-03 15:05:42 +08:00			`SWAG_API_DIRS=./server/route/api/v1`
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 2023-08-09 10:53:06 -03:00
			`# Where general API info is documented`
chore: tweak docs generate path 2024-03-03 15:05:42 +08:00			`SWAG_GENERAL_INFO=./server/route/api/v1/v1.go`
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 2023-08-09 10:53:06 -03:00
			`# Possible output files: go (docs.go), json (swagger.json), yaml (swagger.yaml)`
			`SWAG_OUTPUT_TYPES=go,yaml`

			`# Where generated files are outputted`
chore: tweak docs generate path 2024-03-03 15:05:42 +08:00			`SWAG_OUTPUT=./server/route/api/v1`