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

Update README.md #35

Merged
merged 3 commits into from
Oct 15, 2024
Merged

Update README.md #35

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a18fba
Update README.md
GabrielBarberini Oct 15, 2024
e10e7c9
Update README.md
GabrielBarberini Oct 15, 2024
86e0d19
Update README.md
GabrielBarberini Oct 15, 2024
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
43 changes: 21 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,47 +137,46 @@ sequenceDiagram
participant API
participant MongoDB

User ->> API: POST /rocketpy-model
API ->> MongoDB: Persist Rocketpy Model
User ->> API: POST /model
API ->> MongoDB: Persist API Model as a document
MongoDB -->> API: Model ID
API -->> User: Model ID
API -->> User: ModelCreated View

User ->> API: GET /rocketpy-model/:id
API ->> MongoDB: Retrieve Rocketpy Model
MongoDB -->> API: Rocketpy Model
API -->> User: Rocketpy Model
User ->> API: GET /model/:id
API ->> MongoDB: Read API Model document
MongoDB -->> API: API Model document
API -->> User: API ModelView

User ->> API: PUT /rocketpy-model/:id
API ->> MongoDB: Update Rocketpy Model
MongoDB -->> API: Updated Model
API -->> User: Updated Model
User ->> API: PUT /model/:id
API ->> MongoDB: Update API Model document
API -->> User: ModelUpdated View

User ->> API: DELETE /rocketpy-model/:id
API ->> MongoDB: Delete Rocketpy Model
User ->> API: DELETE /model/:id
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
participant API
participant MongoDB
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
User ->> API: POST /summary/model/:id
API -->> MongoDB: Retrieve Rocketpy native class
MongoDB -->> API: Rocketpy native class
API ->> Rocketpy lib: Simulate Rocketpy native class
GabrielBarberini marked this conversation as resolved.
Show resolved Hide resolved
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
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
```
Loading