Skip to content

Commit

Permalink
Merge pull request #55 from France-ioi/archDecisionsEnv
Browse files Browse the repository at this point in the history
Add architecture decision about environment and tests
  • Loading branch information
GeoffreyHuck authored Jun 18, 2024
2 parents 7cd245a + f35deb2 commit 2059a38
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
---
layout: page
title: "Architecture Decisions: Services & Code Style"
title: "Architecture Decisions: App & Code"
nav_order: 1000
parent: Backend
---

# Architecture Decisions: Services & Code Style
# Architecture Decisions: App & Code


## The environment is forced to `test` in the tests, can never be `test` when running the application, and the `test` environment only read its configuration from `config.yaml.test`, and never from `config.yaml`

Date: 05/06/2024

Why?
- We want to make sure tests are never run on a live database because they erase all the data.

More info and discussion: https://github.com/France-ioi/AlgoreaBackend/pull/1085


## Fields that are not visible to the user due to access rights must not appear in the response at all

Expand Down
2 changes: 1 addition & 1 deletion backend/dev-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ parent: Backend
- [ ] it renders correctly. Verify locally with the command: "**make serve-swagger**".
- [ ] the fields of the request and response have the correct annotations (required, Nullable, ...).

See [Architecture Decisions: Services & Code Style]({{ site.baseurl }}/backend/decisions-services-code-style/).
See [Architecture Decisions: App & Code]({{ site.baseurl }}/backend/decisions-app-code/).

**Swagger tip:** You need to have 2 empty lines between paragraphs, otherwise the generated documentation will have everything on the same line.

Expand Down

0 comments on commit 2059a38

Please sign in to comment.