Skip to content

Generate Docs Report

This run refreshed the compact documentation set, using deterministic renderers where possible and falling back to model-backed updates only when needed.

Run Metadata

  • Report file: 2026-03-15-155748-generate_docs.md
  • Latest alias: latest-generate_docs.md
  • Script: generate_docs.py
  • Branch kind: feature
  • Branch: TYCHE-16-add-grafana-for-user-service
  • Raw git branch: feature_TYCHE-16-add-grafana-for-user-service
  • Started at: 2026-03-15T15:57:48.181050+00:00
  • Finished at: 2026-03-15T15:57:49.321253+00:00

Quick Read

  • Docs mode: full-repository
  • Source mode: full-repository
  • Updated pages: 11
  • Skipped items: 0
  • Simple model: deepseek-coder:6.7b
  • Complex model: deepseek-r1:8b

Changed Files

  • none

Pipeline Commits

  • not applicable in local mode

Target Documentation Pages

  • docs/knowledge/architecture/observability.md
  • docs/knowledge/architecture/system.md
  • docs/knowledge/database/overview.md
  • docs/knowledge/services/user-service/api.md
  • docs/knowledge/services/user-service/data-model.md
  • docs/knowledge/services/user-service/observability.md
  • docs/knowledge/services/user-service/overview.md
  • docs/knowledge/services/user-service/readme.md
  • docs/knowledge/services/user-service/runtime.md

Service Source Files Used

Area Files
Build Files 1
Wrapper and Tooling 1
Readme 1
Main Java 70
Main Resources 11
Test Java 28
Test Resources 9
Build Files (1) - `user-service/pom.xml`
Wrapper and Tooling (1) - `user-service/.mvn/wrapper/maven-wrapper.properties`
Readme (1) - `user-service/README.md`
Main Java (70) - `user-service/src/main/java/com/tychewealth/TycheWealthUserServiceApplication.java` - `user-service/src/main/java/com/tychewealth/config/AuthRateLimitProperties.java` - `user-service/src/main/java/com/tychewealth/config/RefreshRateLimitConfig.java` - `user-service/src/main/java/com/tychewealth/config/SecurityConfig.java` - `user-service/src/main/java/com/tychewealth/config/SwaggerConfig.java` - `user-service/src/main/java/com/tychewealth/constants/ApiConstants.java` - `user-service/src/main/java/com/tychewealth/constants/AuthConstants.java` - `user-service/src/main/java/com/tychewealth/constants/LogConstants.java` - `user-service/src/main/java/com/tychewealth/constants/MetricConstants.java` - `user-service/src/main/java/com/tychewealth/constants/ValidationConstants.java` - `user-service/src/main/java/com/tychewealth/controller/AuthApi.java` - `user-service/src/main/java/com/tychewealth/controller/UserApi.java` - `user-service/src/main/java/com/tychewealth/controller/impl/AuthApiController.java` - `user-service/src/main/java/com/tychewealth/controller/impl/UserApiController.java` - `user-service/src/main/java/com/tychewealth/dto/asset/AssetResponseDto.java` - `user-service/src/main/java/com/tychewealth/dto/asset/request/AssetCreateRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/asset/request/AssetUpdateRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/auth/LoginResponseDto.java` - `user-service/src/main/java/com/tychewealth/dto/auth/RefreshTokenResponseDto.java` - `user-service/src/main/java/com/tychewealth/dto/auth/request/LoginRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/auth/request/RefreshTokenRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/auth/request/RegisterRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/portfolio/PortfolioResponseDto.java` - `user-service/src/main/java/com/tychewealth/dto/portfolio/request/PortfolioCreateRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/portfolio/request/PortfolioUpdateRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/user/UserResponseDto.java` - `user-service/src/main/java/com/tychewealth/dto/user/request/UserPasswordUpdateRequestDto.java` - `user-service/src/main/java/com/tychewealth/dto/user/request/UserUpdateRequestDto.java` - `user-service/src/main/java/com/tychewealth/entity/AssetEntity.java` - `user-service/src/main/java/com/tychewealth/entity/PortfolioEntity.java` - `user-service/src/main/java/com/tychewealth/entity/RefreshTokenEntity.java` - `user-service/src/main/java/com/tychewealth/entity/UserEntity.java` - `user-service/src/main/java/com/tychewealth/enums/AssetTypeEnum.java` - `user-service/src/main/java/com/tychewealth/enums/CurrencyCodeEnum.java` - `user-service/src/main/java/com/tychewealth/enums/InvestmentHorizonEnum.java` - `user-service/src/main/java/com/tychewealth/enums/RiskProfileEnum.java` - `user-service/src/main/java/com/tychewealth/enums/StrategyTypeEnum.java` - `user-service/src/main/java/com/tychewealth/error/exception/AuthException.java` - `user-service/src/main/java/com/tychewealth/error/exception/UserException.java` - `user-service/src/main/java/com/tychewealth/error/handler/ErrorDefinition.java` - `user-service/src/main/java/com/tychewealth/error/handler/ErrorHandler.java` - `user-service/src/main/java/com/tychewealth/error/handler/ErrorResponse.java` - `user-service/src/main/java/com/tychewealth/mapper/GenericMapper.java` - `user-service/src/main/java/com/tychewealth/mapper/GenericMapperConfig.java` - `user-service/src/main/java/com/tychewealth/mapper/asset/AssetMapper.java` - `user-service/src/main/java/com/tychewealth/mapper/portfolio/PortfolioMapper.java` - `user-service/src/main/java/com/tychewealth/mapper/user/UserMapper.java` - `user-service/src/main/java/com/tychewealth/repository/AssetRepository.java` - `user-service/src/main/java/com/tychewealth/repository/PortfolioRepository.java` - `user-service/src/main/java/com/tychewealth/repository/RefreshTokenRepository.java` - `user-service/src/main/java/com/tychewealth/repository/UserRepository.java` - `user-service/src/main/java/com/tychewealth/service/AuthService.java` - `user-service/src/main/java/com/tychewealth/service/UserService.java` - `user-service/src/main/java/com/tychewealth/service/helper/AuthRefreshTokenHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/AuthTokenHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/TokenValidationHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/auth/AuthLoginHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/auth/AuthRegisterHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/auth/AuthValidationHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/user/UserHelper.java` - `user-service/src/main/java/com/tychewealth/service/helper/user/UserValidationHelper.java` - `user-service/src/main/java/com/tychewealth/service/impl/AuthServiceImpl.java` - `user-service/src/main/java/com/tychewealth/service/impl/UserServiceImpl.java` - `user-service/src/main/java/com/tychewealth/service/monitoring/AuthMetrics.java` - `user-service/src/main/java/com/tychewealth/service/monitoring/UserMetrics.java` - `user-service/src/main/java/com/tychewealth/service/token/AuthTokenPayload.java` - `user-service/src/main/java/com/tychewealth/utils/LogContextFactory.java` - `user-service/src/main/java/com/tychewealth/utils/Utils.java` - `user-service/src/main/java/com/tychewealth/web/AuthRateLimitInterceptor.java` - `user-service/src/main/java/com/tychewealth/web/RefreshRateLimitInterceptor.java`
Main Resources (11) - `user-service/src/main/resources/application.properties` - `user-service/src/main/resources/db.changelog/asset-changelog/asset-changelog-dll.xml` - `user-service/src/main/resources/db.changelog/asset-changelog/asset-changelog-master.xml` - `user-service/src/main/resources/db.changelog/changelog-master.xml` - `user-service/src/main/resources/db.changelog/portfolio-changelog/portfolio-changelog-dll.xml` - `user-service/src/main/resources/db.changelog/portfolio-changelog/portfolio-changelog-master.xml` - `user-service/src/main/resources/db.changelog/refresh-token-changelog/refresh-token-changelog-dll.xml` - `user-service/src/main/resources/db.changelog/refresh-token-changelog/refresh-token-changelog-master.xml` - `user-service/src/main/resources/db.changelog/user-changelog/user-changelog-dll.xml` - `user-service/src/main/resources/db.changelog/user-changelog/user-changelog-master.xml` - `user-service/src/main/resources/db.changelog/user-changelog/user-changelog-soft-delete.xml`
Test Java (28) - `user-service/src/test/java/com/tychewealth/TycheWealthUserServiceApplicationTests.java` - `user-service/src/test/java/com/tychewealth/config/AuthIntegrationTestConfig.java` - `user-service/src/test/java/com/tychewealth/config/AuthTestConfig.java` - `user-service/src/test/java/com/tychewealth/config/IntegrationTestConfig.java` - `user-service/src/test/java/com/tychewealth/config/TestDatabaseConfig.java` - `user-service/src/test/java/com/tychewealth/config/UserIntegrationTestConfig.java` - `user-service/src/test/java/com/tychewealth/constants/TestConstants.java` - `user-service/src/test/java/com/tychewealth/controller/AuthApiControllerIntegrationTest.java` - `user-service/src/test/java/com/tychewealth/controller/UserApiControllerIntegrationTest.java` - `user-service/src/test/java/com/tychewealth/liquibase/LiquibaseChangelogTest.java` - `user-service/src/test/java/com/tychewealth/mapper/AssetMapperTest.java` - `user-service/src/test/java/com/tychewealth/mapper/PortfolioMapperTest.java` - `user-service/src/test/java/com/tychewealth/mapper/UserMapperTest.java` - `user-service/src/test/java/com/tychewealth/repository/AssetRepositoryTest.java` - `user-service/src/test/java/com/tychewealth/repository/PortfolioRepositoryTest.java` - `user-service/src/test/java/com/tychewealth/repository/RefreshTokenRepositoryTest.java` - `user-service/src/test/java/com/tychewealth/repository/UserRepositoryTest.java` - `user-service/src/test/java/com/tychewealth/testdata/AuthTestData.java` - `user-service/src/test/java/com/tychewealth/testdata/EntityBuilder.java` - `user-service/src/test/java/com/tychewealth/testdata/UserTestData.java` - `user-service/src/test/java/com/tychewealth/testhelper/AuthTestHelper.java` - `user-service/src/test/java/com/tychewealth/testhelper/LiquibaseTestHelper.java` - `user-service/src/test/java/com/tychewealth/testhelper/MetricsTestHelper.java` - `user-service/src/test/java/com/tychewealth/testhelper/RateLimitWebTestHelper.java` - `user-service/src/test/java/com/tychewealth/testhelper/UserTestHelper.java` - `user-service/src/test/java/com/tychewealth/utils/FixtureLoader.java` - `user-service/src/test/java/com/tychewealth/web/AuthRateLimitInterceptorTest.java` - `user-service/src/test/java/com/tychewealth/web/RefreshRateLimitInterceptorTest.java`
Test Resources (9) - `user-service/src/test/resources/fixtures/asset/asset-create-request.json` - `user-service/src/test/resources/fixtures/asset/asset-response.json` - `user-service/src/test/resources/fixtures/asset/asset-update-request.json` - `user-service/src/test/resources/fixtures/portfolio/portfolio-create-request.json` - `user-service/src/test/resources/fixtures/portfolio/portfolio-response.json` - `user-service/src/test/resources/fixtures/portfolio/portfolio-update-request.json` - `user-service/src/test/resources/fixtures/user/user-create-request.json` - `user-service/src/test/resources/fixtures/user/user-response.json` - `user-service/src/test/resources/fixtures/user/user-update-request.json`

Updated Pages

  • updated docs\knowledge\architecture\observability.md using template
  • updated docs\knowledge\architecture\system.md using template
  • updated docs\knowledge\database\overview.md using template
  • updated docs\knowledge\services\user-service\api.md using template
  • updated docs\knowledge\services\user-service\data-model.md using template
  • updated docs\knowledge\services\user-service\observability.md using template
  • updated docs\knowledge\services\user-service\overview.md using template
  • updated docs\knowledge\services\user-service\readme.md using template
  • updated docs\knowledge\services\user-service\runtime.md using template
  • updated user-service\README.md using template
  • updated docs\knowledge\index.md using template

Skipped Items

  • none

Notes

  • This run updates the real docs/ structure instead of creating per-class documentation.
  • docs/knowledge/project-context.md is treated as read-only context by this script.
  • docs/knowledge/index.md and service README.md files are refreshed as part of the cycle.
  • Services are discovered from repository folders matching *-service.

Rollback Prompt

Usa el workspace actual. Quiero hacer rollback solo de los cambios introducidos por el reporte `2026-03-15-155748-generate_docs.md` del script `generate_docs.py`.
Revierte únicamente estos archivos si siguen coincidiendo con esa ejecución:
- `docs/knowledge/architecture/observability.md`
- `docs/knowledge/architecture/system.md`
- `docs/knowledge/database/overview.md`
- `docs/knowledge/services/user-service/api.md`
- `docs/knowledge/services/user-service/data-model.md`
- `docs/knowledge/services/user-service/observability.md`
- `docs/knowledge/services/user-service/overview.md`
- `docs/knowledge/services/user-service/readme.md`
- `docs/knowledge/services/user-service/runtime.md`
- `user-service/README.md`
- `docs/knowledge/index.md`
No toques cambios ajenos del usuario.
Si alguno de esos archivos ha cambiado después de este reporte, pregúntame antes de sobrescribirlo.