update swaggerdoc

USACE · Dec 19, 2023 · e73b5c8 · e73b5c8
1 parent b1c257a
commit e73b5c8
Show file tree

Hide file tree

Showing 3 changed files with 191 additions and 32 deletions.
diff --git a/api/docs/docs.go b/api/docs/docs.go
@@ -964,7 +964,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview"
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview"
                         }
                     },
                     "400": {
@@ -1024,7 +1024,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview"
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview"
                         }
                     },
                     "400": {
@@ -1183,6 +1183,43 @@ const docTemplate = `{
                 }
             }
         },
+        "/domains/map": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "domain"
+                ],
+                "summary": "Get map with domain group as key",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainMap"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    }
+                }
+            }
+        },
         "/email_autocomplete": {
             "get": {
                 "produces": [
@@ -8156,27 +8193,27 @@ const docTemplate = `{
                 }
             }
         },
-        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview": {
+        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable": {
             "type": "object",
             "properties": {
-                "datalogger_table_id": {
+                "id": {
                     "type": "string"
                 },
-                "preview": {
-                    "$ref": "#/definitions/pgtype.JSON"
-                },
-                "update_date": {
+                "table_name": {
                     "type": "string"
                 }
             }
         },
-        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable": {
+        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview": {
             "type": "object",
             "properties": {
-                "id": {
+                "datalogger_table_id": {
                     "type": "string"
                 },
-                "table_name": {
+                "preview": {
+                    "$ref": "#/definitions/pgtype.JSON"
+                },
+                "update_date": {
                     "type": "string"
                 }
             }
@@ -8318,6 +8355,29 @@ const docTemplate = `{
                 }
             }
         },
+        "github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption": {
+            "type": "object",
+            "properties": {
+                "description": {
+                    "type": "string"
+                },
+                "id": {
+                    "type": "string"
+                },
+                "value": {
+                    "type": "string"
+                }
+            }
+        },
+        "github_com_USACE_instrumentation-api_api_internal_model.DomainMap": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "array",
+                "items": {
+                    "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption"
+                }
+            }
+        },
         "github_com_USACE_instrumentation-api_api_internal_model.EmailAutocompleteResult": {
             "type": "object",
             "properties": {

diff --git a/api/docs/swagger.json b/api/docs/swagger.json
@@ -956,7 +956,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview"
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview"
                         }
                     },
                     "400": {
@@ -1016,7 +1016,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview"
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview"
                         }
                     },
                     "400": {
@@ -1175,6 +1175,43 @@
                 }
             }
         },
+        "/domains/map": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "domain"
+                ],
+                "summary": "Get map with domain group as key",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainMap"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/echo.HTTPError"
+                        }
+                    }
+                }
+            }
+        },
         "/email_autocomplete": {
             "get": {
                 "produces": [
@@ -8148,27 +8185,27 @@
                 }
             }
         },
-        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview": {
+        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable": {
             "type": "object",
             "properties": {
-                "datalogger_table_id": {
+                "id": {
                     "type": "string"
                 },
-                "preview": {
-                    "$ref": "#/definitions/pgtype.JSON"
-                },
-                "update_date": {
+                "table_name": {
                     "type": "string"
                 }
             }
         },
-        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable": {
+        "github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview": {
             "type": "object",
             "properties": {
-                "id": {
+                "datalogger_table_id": {
                     "type": "string"
                 },
-                "table_name": {
+                "preview": {
+                    "$ref": "#/definitions/pgtype.JSON"
+                },
+                "update_date": {
                     "type": "string"
                 }
             }
@@ -8310,6 +8347,29 @@
                 }
             }
         },
+        "github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption": {
+            "type": "object",
+            "properties": {
+                "description": {
+                    "type": "string"
+                },
+                "id": {
+                    "type": "string"
+                },
+                "value": {
+                    "type": "string"
+                }
+            }
+        },
+        "github_com_USACE_instrumentation-api_api_internal_model.DomainMap": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "array",
+                "items": {
+                    "$ref": "#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption"
+                }
+            }
+        },
         "github_com_USACE_instrumentation-api_api_internal_model.EmailAutocompleteResult": {
             "type": "object",
             "properties": {

diff --git a/api/docs/swagger.yaml b/api/docs/swagger.yaml
@@ -227,20 +227,20 @@ definitions:
       updater_username:
         type: string
     type: object
-  github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview:
+  github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable:
     properties:
-      datalogger_table_id:
+      id:
         type: string
-      preview:
-        $ref: '#/definitions/pgtype.JSON'
-      update_date:
+      table_name:
         type: string
     type: object
-  github_com_USACE_instrumentation-api_api_internal_model.DataloggerTable:
+  github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview:
     properties:
-      id:
+      datalogger_table_id:
         type: string
-      table_name:
+      preview:
+        $ref: '#/definitions/pgtype.JSON'
+      update_date:
         type: string
     type: object
   github_com_USACE_instrumentation-api_api_internal_model.DataloggerWithKey:
@@ -333,6 +333,21 @@ definitions:
       value:
         type: string
     type: object
+  github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption:
+    properties:
+      description:
+        type: string
+      id:
+        type: string
+      value:
+        type: string
+    type: object
+  github_com_USACE_instrumentation-api_api_internal_model.DomainMap:
+    additionalProperties:
+      items:
+        $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainGroupOption'
+      type: array
+    type: object
   github_com_USACE_instrumentation-api_api_internal_model.EmailAutocompleteResult:
     properties:
       email:
@@ -1703,7 +1718,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview'
+            $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview'
         "400":
           description: Bad Request
           schema:
@@ -1742,7 +1757,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerPreview'
+            $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DataloggerTablePreview'
         "400":
           description: Bad Request
           schema:
@@ -1847,6 +1862,30 @@ paths:
       summary: lists all domains
       tags:
       - domain
+  /domains/map:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/github_com_USACE_instrumentation-api_api_internal_model.DomainMap'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/echo.HTTPError'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/echo.HTTPError'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/echo.HTTPError'
+      summary: Get map with domain group as key
+      tags:
+      - domain
   /email_autocomplete:
     get:
       parameters: