From 5f97343ea8fab5db3cf1584322a75d25d583406f Mon Sep 17 00:00:00 2001 From: Thomas Duval Date: Tue, 17 Apr 2018 10:02:42 +0200 Subject: Update documentation to show which parameter is mandatory or not. Change-Id: I903c0ec1329ca29fb9dd88644d067d6b6f6bd147 --- moon_manager/moon_manager/api/models.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'moon_manager/moon_manager/api/models.py') diff --git a/moon_manager/moon_manager/api/models.py b/moon_manager/moon_manager/api/models.py index 8a5f229c..2dec13dc 100644 --- a/moon_manager/moon_manager/api/models.py +++ b/moon_manager/moon_manager/api/models.py @@ -59,14 +59,14 @@ class Models(Resource): :param uuid: uuid of the model (not used here) :param user_id: user ID who do the request :request body: { - "name": "...", - "description": "... (optional)", + "name": "name of the model (mandatory)", + "description": "description of the model (optional)", "meta_rules": ["meta_rule_id1", ] } :return: { "model_id1": { - "name": "...", - "description": "... (optional)", + "name": "name of the model", + "description": "description of the model (optional)", "meta_rules": ["meta_rule_id1", ] } } @@ -82,7 +82,7 @@ class Models(Resource): return {"models": data} @check_auth - def delete(self, uuid=None, user_id=None): + def delete(self, uuid, user_id=None): """Delete a model :param uuid: uuid of the model to delete @@ -102,14 +102,14 @@ class Models(Resource): return {"result": True} @check_auth - def patch(self, uuid=None, user_id=None): + def patch(self, uuid, user_id=None): """Update a model :param uuid: uuid of the model to update :param user_id: user ID who do the request :return: { "model_id1": { - "name": "...", + "name": "name of the model", "description": "... (optional)", "meta_rules": ["meta_rule_id1", ] } -- cgit 1.2.3-korg