get {locations_endpoint_url}/{location_id}[/{evse_uid}][/{connector_id}]

plugoinc · Oct 11, 2023 · 6dc4b6f · 6dc4b6f
1 parent 92f262b
commit 6dc4b6f
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 0 deletions.
diff --git a/openapi/components/responses/Location.yaml b/openapi/components/responses/Location.yaml
@@ -0,0 +1,9 @@
+description: Location
+content:
+  application/json:
+    schema:
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Location.yaml
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -65,6 +65,12 @@ paths:
     $ref: paths/credentials.yaml
   /locations:
     $ref: paths/locations.yaml
+  /locations/{location_id}:
+    $ref: paths/locations_{location_id}.yaml
+  /locations/{location_id}/{evse_uid}:
+    $ref: paths/locations_{location_id}_{evse_uid}.yaml
+  /locations/{location_id}/{evse_uid}/{connector_id}:
+    $ref: paths/locations_{location_id}_{evse_uid}_{connector_id}.yaml
 
 components:
   securitySchemes:

diff --git a/openapi/paths/locations_{location_id}.yaml b/openapi/paths/locations_{location_id}.yaml
@@ -0,0 +1,20 @@
+get:
+  tags:
+    - Locations
+  summary: Sender /locations/{location_id}
+  operationId: getLocation_by_location_id
+  security:
+    - tokenAuth: []
+  parameters:
+    - name: location_id
+      in: path
+      required: true
+      schema:
+        type: string
+  responses:
+    "200":
+      $ref: ../components/responses/Location.yaml
+    "400":
+      $ref: ../components/responses/BadRequest.yaml
+    "404":
+      $ref: ../components/responses/NotFound.yaml
diff --git a/openapi/paths/locations_{location_id}_{evse_uid}.yaml b/openapi/paths/locations_{location_id}_{evse_uid}.yaml
@@ -0,0 +1,25 @@
+get:
+  tags:
+    - Locations
+  summary: Sender /locations/{location_id}/{evse_uid}
+  operationId: getLocation_by_location_id_evse_uid
+  security:
+    - tokenAuth: []
+  parameters:
+    - name: location_id
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: evse_uid
+      in: path
+      required: true
+      schema:
+        type: string
+  responses:
+    "200":
+      $ref: ../components/responses/Location.yaml
+    "400":
+      $ref: ../components/responses/BadRequest.yaml
+    "404":
+      $ref: ../components/responses/NotFound.yaml
diff --git a/openapi/paths/locations_{location_id}_{evse_uid}_{connector_id}.yaml b/openapi/paths/locations_{location_id}_{evse_uid}_{connector_id}.yaml
@@ -0,0 +1,30 @@
+get:
+  tags:
+    - Locations
+  summary: Sender /locations/{location_id}/{evse_uid}]/[{connector_id}
+  operationId: getLocation_by_location_id_evse_uid_connector_id
+  security:
+    - tokenAuth: []
+  parameters:
+    - name: location_id
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: evse_uid
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: connector_id
+      in: path
+      required: true
+      schema:
+        type: string
+  responses:
+    "200":
+      $ref: ../components/responses/Location.yaml
+    "400":
+      $ref: ../components/responses/BadRequest.yaml
+    "404":
+      $ref: ../components/responses/NotFound.yaml