File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11queries :
22 - uses : security-and-quality
3+
4+ paths-ignore :
5+ - ' **/docs/**'
6+ - ' **/*.html'
Original file line number Diff line number Diff line change @@ -424,6 +424,9 @@ gradle-app.setting
424424# Exclude Gradle build scans directory
425425.gradle-scans /
426426
427+ # Generated API documentation
428+ ** /docs /index.html
429+
427430# ## Ktor ###
428431# Specific to Ktor, if you use embeddedServer output
429432# These might be too broad if you have other important jars/zips/tars
Original file line number Diff line number Diff line change @@ -89,9 +89,13 @@ Retrieves a quote by its ID.
8989
9090## OpenAPI and Swagger
9191
92+ The API documentation is ** generated dynamically at runtime** by Ktor's OpenAPI and Swagger plugins:
93+
9294- OpenAPI specification: [ http://localhost:8080/openapi ] ( http://localhost:8080/openapi )
9395- Swagger UI: [ http://localhost:8080/swagger ] ( http://localhost:8080/swagger )
9496
97+ ** Note** : No static HTML documentation files are committed to the repository. The Swagger UI is served directly by the application when it's running.
98+
9599## Health Endpoint
96100
97101- ` GET /internal/health ` : Returns ` 200 OK ` and the string ` Application is healthy ` if the service is running.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments