diff --git a/README.md b/README.md index b753926..afd731b 100644 --- a/README.md +++ b/README.md @@ -137,29 +137,28 @@ 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 @@ -167,17 +166,17 @@ sequenceDiagram 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 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 ```