update object creation docstrings closes #106 (#200)

Author: lboeman

sfa_api/aggregates.py

@@ -68,7 +68,15 @@ def post(self, *args):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/AggregateMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created aggregate.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created aggregate.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401:

sfa_api/forecasts.py

@@ -70,7 +70,15 @@ def post(self, *args):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/ForecastMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created forecast.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created forecast.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401:
@@ -330,7 +338,15 @@ def post(self, *args):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/CDFForecastGroupMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created probabilistic forecast.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created probabilistic forecast.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401:

sfa_api/observations.py

@@ -67,7 +67,15 @@ def post(self, *args):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/ObservationMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created observation.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created observation.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401:

sfa_api/permissions.py

@@ -50,8 +50,20 @@ def post(self):
               schema:
                 $ref: '#/components/schemas/PermissionPostSchema'
         responses:
-          200:
+          201:
             description: Permission created successfully.
+            content:
+              application/json:
+                schema:
+                  type: string
+                  format: uuid
+                  description: The uuid of the created permission.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created permission.
           400:
             $ref: '#/components/responses/400-BadRequest'
           404:

sfa_api/reports.py

@@ -59,7 +59,15 @@ def post(self):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/ReportMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created report.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created report.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401:

sfa_api/roles.py

@@ -48,7 +48,15 @@ def post(self):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/RoleSchema'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created role.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created role.
           400:
             $ref: '#/components/responses/400-BadRequest'
           404:

sfa_api/sites.py

@@ -57,7 +57,15 @@ def post(self, *args):
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/SiteMetadata'
+                  type: string
+                  format: uuid
+                  description: The uuid of the created site.
+            headers:
+              Location:
+                schema:
+                  type: string
+                  format: uri
+                  description: Url of the created site.
           400:
             $ref: '#/components/responses/400-BadRequest'
           401: