From 4a18fba550c2265a2773073aa3702cc8d79da728 Mon Sep 17 00:00:00 2001 From: Gabriel Barberini Date: Tue, 15 Oct 2024 07:21:46 -0300 Subject: [PATCH 1/3] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b753926..ecabb80 100644 --- a/README.md +++ b/README.md @@ -137,23 +137,23 @@ sequenceDiagram participant API participant MongoDB - User ->> API: POST /rocketpy-model - API ->> MongoDB: Persist Rocketpy Model + User ->> API: POST /model + API ->> MongoDB: Persist API Model MongoDB -->> API: Model ID API -->> User: Model ID - User ->> API: GET /rocketpy-model/:id - API ->> MongoDB: Retrieve Rocketpy Model + User ->> API: GET /model/:id + API ->> MongoDB: Retrieve API Model MongoDB -->> API: Rocketpy Model API -->> User: Rocketpy Model - User ->> API: PUT /rocketpy-model/:id - API ->> MongoDB: Update Rocketpy Model + User ->> API: PUT /model/:id + API ->> MongoDB: Update API Model MongoDB -->> API: Updated Model API -->> User: Updated Model - User ->> API: DELETE /rocketpy-model/:id - API ->> MongoDB: Delete Rocketpy Model + User ->> API: DELETE /model/:id + API ->> MongoDB: Delete API Model MongoDB -->> API: Deletion Confirmation API -->> User: Deletion Confirmation @@ -168,9 +168,9 @@ sequenceDiagram participant Rocketpy lib User ->> API: POST /summary/rocketpy-model/:id - API -->> MongoDB: Retrieve Rocketpy Model - MongoDB -->> API: Rocketpy Model - API ->> Rocketpy lib: Simulate Rocketpy Model + API -->> MongoDB: Retrieve Rocketpy native class + MongoDB -->> API: Rocketpy native class + API ->> Rocketpy lib: Simulate Rocketpy native class Rocketpy lib -->> API: Simulation Results API -->> User: Simulation Results @@ -178,6 +178,6 @@ sequenceDiagram API -->> MongoDB: Retrieve Rocketpy Model MongoDB -->> API: Rocketpy Model API ->> Rocketpy lib: Rocketpy Model - Rocketpy lib -->> API: Rocketpy native class as json pickle string - API -->> User: Rocketpy native class as json pickle string + Rocketpy lib -->> API: Rocketpy native class as .dill binary + API -->> User: Rocketpy native class as .dill binary ``` From e10e7c964533f64b188a592972b8858168a51f1c Mon Sep 17 00:00:00 2001 From: Gabriel Barberini Date: Tue, 15 Oct 2024 07:40:10 -0300 Subject: [PATCH 2/3] Update README.md --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ecabb80..5d0bdd6 100644 --- a/README.md +++ b/README.md @@ -138,28 +138,27 @@ sequenceDiagram participant MongoDB User ->> API: POST /model - API ->> MongoDB: Persist API Model + API ->> MongoDB: Persist API Model as a document MongoDB -->> API: Model ID - API -->> User: Model ID + API -->> User: ModelCreated View User ->> API: GET /model/:id - API ->> MongoDB: Retrieve API Model - MongoDB -->> API: Rocketpy Model - API -->> User: Rocketpy Model + API ->> MongoDB: Read API Model document + MongoDB -->> API: API Model document + API -->> User: API ModelView User ->> API: PUT /model/:id - API ->> MongoDB: Update API Model - MongoDB -->> API: Updated Model - API -->> User: Updated Model + API ->> MongoDB: Update API Model document + API -->> User: ModelUpdated View User ->> API: DELETE /model/:id - API ->> MongoDB: Delete API Model + API ->> MongoDB: Delete API Model document MongoDB -->> API: Deletion Confirmation - API -->> User: Deletion Confirmation + API -->> User: ModelDeleted View ``` -### Simulating and extracting RocketPY native class +### Simulating and extracting RocketPY native classes ```mermaid sequenceDiagram participant User From 86e0d19c2c471a0287bf6a869d7f420d404526fc Mon Sep 17 00:00:00 2001 From: Gabriel Barberini Date: Tue, 15 Oct 2024 07:41:06 -0300 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d0bdd6..afd731b 100644 --- a/README.md +++ b/README.md @@ -166,14 +166,14 @@ sequenceDiagram participant MongoDB participant Rocketpy lib - User ->> API: POST /summary/rocketpy-model/:id + User ->> API: POST /summary/model/:id API -->> MongoDB: Retrieve Rocketpy native class MongoDB -->> API: Rocketpy native class API ->> Rocketpy lib: Simulate Rocketpy native class Rocketpy lib -->> API: Simulation Results API -->> User: Simulation Results - User ->> API: POST /rocketpy/rocketpy-model/:id + User ->> API: POST /rocketpy/model/:id API -->> MongoDB: Retrieve Rocketpy Model MongoDB -->> API: Rocketpy Model API ->> Rocketpy lib: Rocketpy Model