From 4bb458e8d62927b0988cb32abbdf4a55d08b5cf6 Mon Sep 17 00:00:00 2001 From: Fabrice Lecomte Date: Fri, 9 Apr 2021 00:20:58 +0200 Subject: [PATCH] Add developer documentation fo create action --- doc/CreateAction.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/CreateAction.md diff --git a/doc/CreateAction.md b/doc/CreateAction.md new file mode 100644 index 0000000..9a4b9b5 --- /dev/null +++ b/doc/CreateAction.md @@ -0,0 +1,30 @@ +Create Action +============ + +* [ ] Create [OpenApi](../src/main/resources/openapi.yaml) documentation +* [ ] Create route + * [ ] Create request with [Location](https://ktor.io/docs/features-locations.html) + * [ ] Create Validation of request with [Konform](https://www.konform.io) + * [ ] Test validation + * [ ] [Check auth](../src/main/kotlin/fr/dcproject/component/auth/CitizenContext.kt) on protected route + * [ ] [Create test for auth](../src/test/kotlin/integration/steps/given/Auth.kt) + * [ ] Return must not be an Entity + * [ ] Tests request: + * [ ] Route with these params + * [ ] Body of the request + * [ ] Success + * [ ] BadRequest + * [ ] Body and request params must [match with the openapi schema](../src/test/kotlin/integration/steps/then/schema.kt) +* [ ] Create [AccessControl](../src/main/kotlin/fr/dcproject/common/security/AccessControlModule.kt) + * [ ] Test [AccessControl](../src/test/kotlin/integration/steps/given/Auth.kt) + + +* [ ] Create Entity + + +* [ ] Create Repository +* [ ] Create SQL function in file + * [ ] Create Tests SQL + +* [ ] Tests + * [ ] Test BadRequest \ No newline at end of file