Skip to content

Commit

Permalink
Fix doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenyu committed Dec 11, 2023
1 parent c039b6c commit 95f40a6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/app/database/database-access-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document describes the best practices and patterns for how the application

## Client Initialization and Configuration

The database client is initialized when the application starts (see [src/\_\_main\_\_.py](../../../app/src/app.py). The database engine that is used to create acquire connections to the database is initialized using the database configuration defined in [db_config.py](../../../app/src/db/db_config.py), which is configured through environment variables. The initialized database client is then stored on the Flask app's [\`extensions\` dictionary](https://flask.palletsprojects.com/en/2.2.x/src/#flask.Flask.extensions) to be used throughout the lifetime of the application.
The database client is initialized when the application starts (see [src/\_\_main\_\_.py](../../../app/src/app.py). The database engine that is used to create acquire connections to the database is initialized using the database configuration defined in [postgres_config.py](app/src/adapters/db/clients/postgres_config.py), which is configured through environment variables. The initialized database client is then stored on the Flask app's [\`extensions\` dictionary](https://flask.palletsprojects.com/en/2.3.x/api/#flask.Flask.extensions) to be used throughout the lifetime of the application.

## Session Management

Expand Down
18 changes: 9 additions & 9 deletions docs/app/technical-overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Technical Overview

- [Key Technologies](#key-technologies)
- [Request operations](#request-operations)
- [Authentication](#authentication)
- [Authorization](#authorization)
- [Running In Hosted Environments](#running-in-hosted-environments)
- [ECS](#ecs)
- [Technical Overview](#technical-overview)
- [Key Technologies](#key-technologies)
- [Request operations](#request-operations)
- [Authentication](#authentication)
- [Authorization](#authorization)
- [Database diagram](#database-diagram)

## Key Technologies

Expand All @@ -21,12 +21,11 @@ generally preferred.
- [OpenAPI Specification][oas-docs]
- [API Flask][apiflask-home] ([source code][apiflask-src])
- [SQLAlchemy][sqlalchemy-home] ([source code][sqlalchemy-src])
- [Alembic][alembic-home] ([source code](alembic-src))
- [Alembic][alembic-home] ([source code][alembic-src])
- [pydantic][pydantic-home] ([source code][pydantic-src])
- [poetry](https://python-poetry.org/docs/) - Python dependency management

[oas-docs]: http://spec.openapis.org/oas/v3.0.3
[oas-swagger-docs]: https://swagger.io/docs/specification/about/

[apiflask-home]: https://apiflask.com/
[apiflask-src]: https://github.com/apiflask/apiflask
Expand All @@ -38,6 +37,7 @@ generally preferred.
[sqlalchemy-src]: https://github.com/sqlalchemy/sqlalchemy

[alembic-home]: https://alembic.sqlalchemy.org/en/latest/
[alembic-src]: https://github.com/sqlalchemy/alembic

## Request operations

Expand All @@ -58,4 +58,4 @@ function that is run to do the authentication.
n/a - Specific user authorization is not yet implemented for this API.

### Database diagram
n/a - Database diagrams are not yet available for this application.
n/a - Database diagrams are not yet available for this application.

0 comments on commit 95f40a6

Please sign in to comment.