Docs for individual submission or entity geojson endpoints (#1674)

Author: brontolosone

docs/api.yaml

@@ -6060,6 +6060,58 @@ paths:
                   <name>Alice</name>
                   <age>32</age>
                 </data>
+  /v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}.geojson:
+    get:
+      tags:
+      - Submissions
+      summary: Retrieving Submission GeoJSON
+      description: To retrieve the GeoJSON representation of the `Submission`, just append `.geojson` to
+        the end of the request URL.
+      operationId: Retrieving Submission GeoJSON
+      parameters:
+      - name: projectId
+        in: path
+        description: The numeric ID of the Project
+        required: true
+        schema:
+          type: number
+        example: "16"
+      - name: xmlFormId
+        in: path
+        description: The `xmlFormId` of the Form being referenced.
+        required: true
+        schema:
+          type: string
+        example: simple
+      - name: instanceId
+        in: path
+        description: The `instanceId` of the Submission being referenced.
+        required: true
+        schema:
+          type: string
+        example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              example: |
+                {
+                  "type": "FeatureCollection",
+                  "features": [
+                    {
+                      "type": "Feature",
+                      "id": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44",
+                      "geometry": {
+                        "type": "Point",
+                        "coordinates": [4.7871262893819555, 52.24107555748181, 0]
+                      },
+                      "properties": {
+                        "fieldpath": "/singular/input_geopoint"
+                      }
+                    }
+                  ]
+                }
   /v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}/edit:
     get:
       tags:
@@ -7110,6 +7162,65 @@ paths:
                   <name>Alice</name>
                   <age>32</age>
                 </data>
+  /v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}/versions/{versionId}.geojson:
+    get:
+      tags:
+      - Submission Versions
+      summary: Getting Version GeoJSON
+      description: Returns the GeoJSON of a particular version of the submission.
+      operationId: Getting Version GeoJSON
+      parameters:
+      - name: projectId
+        in: path
+        description: The numeric ID of the Project
+        required: true
+        schema:
+          type: number
+        example: "16"
+      - name: xmlFormId
+        in: path
+        description: The `xmlFormId` of the Form being referenced.
+        required: true
+        schema:
+          type: string
+        example: simple
+      - name: instanceId
+        in: path
+        description: The `instanceId` of the Submission being referenced.
+        required: true
+        schema:
+          type: string
+        example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44
+      - name: versionId
+        in: path
+        description: The `instanceId` of the particular version of this submission
+          in question.
+        required: true
+        schema:
+          type: string
+        example: uuid:b1628661-65ed-4cab-8e30-19c17fef2de0
+      responses:
+        "200":
+          description: OK
+          content:
+            application/xml:
+              example: |
+                {
+                  "type": "FeatureCollection",
+                  "features": [
+                    {
+                      "type": "Feature",
+                      "id": "uuid:b1628661-65ed-4cab-8e30-19c17fef2de0",
+                      "geometry": {
+                        "type": "Point",
+                        "coordinates": [4.7871262893819555, 52.24107555748181, 0]
+                      },
+                      "properties": {
+                        "fieldpath": "/singular/input_geopoint"
+                      }
+                    }
+                  ]
+                }
   /v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}/versions/{versionId}/attachments:
     get:
       tags:
@@ -9098,6 +9209,58 @@ paths:
                 action: entity.create
                 acteeId: 85cb9aff-005e-4edd-9739-dc9c1a829c44
                 loggedAt: 2018-04-18T23:19:14.802Z
+  /v1/projects/{projectId}/datasets/{name}/entities/{uuid}/geojson:
+    get:
+      tags:
+      - Entity Management
+      summary: Entity GeoJSON representation
+      description: Returns the GeoJSON representation of an Entity's `geometry` attribute, if available.
+      operationId: Entity GeoJSON representation
+      parameters:
+      - name: projectId
+        in: path
+        description: The numeric ID of the Project
+        required: true
+        schema:
+          type: number
+        example: "16"
+      - name: name
+        in: path
+        description: Name of the Dataset
+        required: true
+        schema:
+          type: string
+        example: people
+      - name: uuid
+        in: path
+        description: UUID of the Entity
+        required: true
+        schema:
+          type: string
+        example: 54a405a0-53ce-4748-9788-d23a30cc3afa
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                description: GeoJSON FeatureCollection, with one Feature.
+                type: object
+              example: |
+                {
+                  "type": "FeatureCollection",
+                  "features": [
+                    {
+                      "type": "Feature",
+                      "id": "54a405a0-53ce-4748-9788-d23a30cc3afa",
+                      "properties": null,
+                      "geometry": {
+                        "type": "Point",
+                        "coordinates": [1.087337169764714, 40.007726575882074, 44.93365478515625]
+                      }
+                    }
+                  ]
+                }
   /v1/projects/{projectId}/datasets/{name}/entities/bulk-delete:
     post:
       tags: