rebuilt swagger documentation

bbernhard · Jun 18, 2024 · f444622 · f444622
1 parent 8929326
commit f444622
Show file tree

Hide file tree

Showing 3 changed files with 157 additions and 0 deletions.
diff --git a/src/docs/docs.go b/src/docs/docs.go
@@ -484,6 +484,36 @@ var doc = `{
             }
         },
         "/v1/contacts/{number}": {
+            "get": {
+                "description": "List all contacts for the given number.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Contacts"
+                ],
+                "summary": "List Contacts",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Registered Phone Number",
+                        "name": "number",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/client.ListContactsResponse"
+                            }
+                        }
+                    }
+                }
+            },
             "put": {
                 "description": "Updates the info associated to a number on the contact list.",
                 "consumes": [
@@ -2464,6 +2494,35 @@ var doc = `{
                 }
             }
         },
+        "client.ListContactsResponse": {
+            "type": "object",
+            "properties": {
+                "blocked": {
+                    "type": "boolean"
+                },
+                "color": {
+                    "type": "string"
+                },
+                "message_expiration": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "number": {
+                    "type": "string"
+                },
+                "profile_name": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string"
+                },
+                "uuid": {
+                    "type": "string"
+                }
+            }
+        },
         "client.ListInstalledStickerPacksResponse": {
             "type": "object",
             "properties": {

diff --git a/src/docs/swagger.json b/src/docs/swagger.json
@@ -468,6 +468,36 @@
             }
         },
         "/v1/contacts/{number}": {
+            "get": {
+                "description": "List all contacts for the given number.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Contacts"
+                ],
+                "summary": "List Contacts",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Registered Phone Number",
+                        "name": "number",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/client.ListContactsResponse"
+                            }
+                        }
+                    }
+                }
+            },
             "put": {
                 "description": "Updates the info associated to a number on the contact list.",
                 "consumes": [
@@ -2448,6 +2478,35 @@
                 }
             }
         },
+        "client.ListContactsResponse": {
+            "type": "object",
+            "properties": {
+                "blocked": {
+                    "type": "boolean"
+                },
+                "color": {
+                    "type": "string"
+                },
+                "message_expiration": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "number": {
+                    "type": "string"
+                },
+                "profile_name": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string"
+                },
+                "uuid": {
+                    "type": "string"
+                }
+            }
+        },
         "client.ListInstalledStickerPacksResponse": {
             "type": "object",
             "properties": {

diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml
@@ -332,6 +332,25 @@ definitions:
       status:
         type: string
     type: object
+  client.ListContactsResponse:
+    properties:
+      blocked:
+        type: boolean
+      color:
+        type: string
+      message_expiration:
+        type: string
+      name:
+        type: string
+      number:
+        type: string
+      profile_name:
+        type: string
+      username:
+        type: string
+      uuid:
+        type: string
+    type: object
   client.ListInstalledStickerPacksResponse:
     properties:
       author:
@@ -664,6 +683,26 @@ paths:
       tags:
       - General
   /v1/contacts/{number}:
+    get:
+      description: List all contacts for the given number.
+      parameters:
+      - description: Registered Phone Number
+        in: path
+        name: number
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/client.ListContactsResponse'
+            type: array
+      summary: List Contacts
+      tags:
+      - Contacts
     put:
       consumes:
       - application/json