Skip to content

Commit b9cb114

Browse files
committed
chore: remove generated docs pages from git
1 parent 08ead67 commit b9cb114

4 files changed

Lines changed: 11 additions & 3385 deletions

File tree

.github/codeql/codeql-config.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
queries:
22
- uses: security-and-quality
3+
4+
paths-ignore:
5+
- '**/docs/**'
6+
- '**/*.html'

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff 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

quotes-backend/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff 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.

quotes-backend/docs/index.html

Lines changed: 0 additions & 3385 deletions
This file was deleted.

0 commit comments

Comments
 (0)