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.

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

Fix: update diagrams #29

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 33 additions & 17 deletions docs/detailed-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,6 @@ group /v1/content/apply POST

client -> apiserver: apply content configuration

activate externalservice
apiserver -> externalservice: request credentials validation
externalservice --> apiserver : validation result
deactivate externalservice

activate localstorage
apiserver -> localstorage: apply provided user configuration
localstorage -> apiserver: user configuration update result
Expand All @@ -105,43 +100,51 @@ deactivate localstorage

end group

group /v1/content/upload POST
group /v1/content/object/upload POST

client -> apiserver: upload object
client -> apiserver: upload content object

activate temporatestorage
apiserver ->> temporatestorage: schedule object upload
deactivate temporatestorage

end group

group /v1/content/download POST
group /v1/content/object/download POST

client -> apiserver: download selected object
client -> apiserver: download selected content object

alt if the object is still not processed
alt if the content object is still not processed

activate temporatestorage
apiserver -> temporatestorage: request object
temporatestorage --> apiserver : retrieved object
apiserver -> temporatestorage: request content object
temporatestorage --> apiserver : retrieved content object
deactivate temporatestorage

else

activate externalservice
apiserver -> externalservice: request object
externalservice --> apiserver : retrieved object
apiserver -> externalservice: request content object
externalservice --> apiserver : retrieved content object
deactivate externalservice

end

apiserver --> client: downloaded object
apiserver --> client: downloaded content object

end group

group /v1/content/backup/download POST

client -> apiserver: download selected content backup

apiserver --> client: downloaded content backup

end group

group /v1/content/clean DELETE
group /v1/content/object/clean DELETE

client -> apiserver: clean selected content
client -> apiserver: clean selected content object

opt if any object is still not processed

Expand Down Expand Up @@ -181,6 +184,19 @@ end group

end box

group /v1/secrets/acquire POST

client -> apiserver: create jwt token

activate externalservice
apiserver -> externalservice: verify given secrets
externalservice -> apiserver: result of verification
deactivate externalservice

apiserver --> client: created jwt token

end group

group /v1/health GET
client -> apiserver: retrieve health info
apiserver --> client: retrieved health info
Expand Down
Binary file modified docs/detailed-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/internal-database-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ entity "temporate" {
*provider : number <<FK>> # provider(id)
*secret : number <<FK>> # secret(id)
--
location : varchar
hash : varchar
created_at : number
}

content ||...|| secret #magenta : attached to
Expand Down
Binary file modified docs/internal-database-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading