aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 07:34:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

rebuilt swagger documentation

Browse Source
This commit is contained in:
Bernhard B
2024-06-18 19:50:09 +02:00
parent 8929326f5f
commit f444622397
3 changed files with 157 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
src/docs/docs.go
View File

@@ -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": {

59
src/docs/swagger.json
View File

@@ -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": {

39
src/docs/swagger.yaml
View File

@@ -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