Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the architecture of the application #27

Closed
2 of 3 tasks
snakedye opened this issue May 27, 2024 · 0 comments · Fixed by #28
Closed
2 of 3 tasks

Document the architecture of the application #27

snakedye opened this issue May 27, 2024 · 0 comments · Fixed by #28
Assignees
@snakedye

Comments

@snakedye
Copy link
Contributor

snakedye commented May 27, 2024 •
edited
Loading

Add all the diagrams that will be shown in the wiki in the repo.

Task

  • Domain model
  • Deployment diagram
  • Database

Acceptance Criteria

  • Each diagram should have its .png generated
  • The image must match with diagram.
@snakedye snakedye mentioned this issue May 27, 2024
Merged
@snakedye snakedye self-assigned this May 30, 2024
@snakedye snakedye changed the title docs: complete architecture of the application Document the architecture of the application Jun 14, 2024
Endlessflow pushed a commit that referenced this issue Jun 25, 2024
@snakedye
Issue #27: Document the architecture (#28)
d643db2 
* fix: add .vscode to gitignore

* docs: add domain model

* docs: aggregation relations

* feat: add deployment diagram

output .png instead of .svg

* fix: remove unused import

* Issue #46: Support sending images with /analyze request (#57)

* feat: use basic authentication scheme

* auth.py in ./
* added domain_model.puml of the application

* doc: to-do user check

* feat: /upload now accepts multiple images at the same time

* fix: return label_id after analysis

* feat: /new_label route

- On /new_label a new label is created in the cache.
- Workflow diagram documenting how the user will proceed.

* docs: update workflow

* fix: lint errors

* fix: return only the form

* fix: only support one image per request for /upload

* feat: support sending images throught analyze

* test: set response format for GPT

* doc: display the new workflow in diagram

* fix: support json return format in GPT

* analyze is now a POST request
* log the analyzed label
* s/test_document_store/test_label

* doc: s/GET/POST in workflow

* fix: remove try/catch on generate_form

* remove logs

* fix: comment out logs

* fix: comment out dict and json

* lint: comment out unused code

* test: used default config llm

* Issue #59: Deprecate the legacy api (#60)

* feat: remove the routes

* fix: remove sessions

* doc: remove mentions of the upload route

* doc: update diagrams

* fix: remove commented code

* docs: add domain model

* docs: aggregation relations

* feat: add deployment diagram

output .png instead of .svg

* fix: remov eof

* fix: remove eof

* fix: add return at eof
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@snakedye snakedye

Labels
None yet
Projects
FertiScan
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue #27: Document the architecture ai-cfia/fertiscan-backend
1 participant
@snakedye