Refactor client.descriptionName to client.name

This commit is contained in:
2024-06-01 13:45:28 +02:00
parent 189c3ab273
commit 16d97ad08f
12 changed files with 356 additions and 87 deletions

View File

@@ -1981,6 +1981,64 @@
}
}
},
"/api/v2/users/{uid}/keys/current": {
"get": {
"description": "Can be done with keys of any permission - the returned key does not include its token.",
"tags": [
"API-v2"
],
"summary": "Get the key currently used by this request",
"operationId": "api-tokenkeys-get-current",
"parameters": [
{
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "string",
"description": "TokenKeyID",
"name": "kid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.KeyTokenWithTokenJSON"
}
},
"400": {
"description": "supplied values/parameters cannot be parsed / are invalid",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "user is not authorized / has missing permissions",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "message not found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api/v2/users/{uid}/keys/{kid}": {
"get": {
"description": "The request must be done with an ADMIN key, the returned key does not include its token.",
@@ -3039,10 +3097,10 @@
"client_type": {
"$ref": "#/definitions/models.ClientType"
},
"description_name": {
"fcm_token": {
"type": "string"
},
"fcm_token": {
"name": {
"type": "string"
}
}
@@ -3084,12 +3142,12 @@
"agent_version": {
"type": "string"
},
"client_name": {
"type": "string"
},
"client_type": {
"$ref": "#/definitions/models.ClientType"
},
"description_name": {
"type": "string"
},
"fcm_token": {
"type": "string"
},
@@ -3641,10 +3699,10 @@
"client_id": {
"type": "string"
},
"description_name": {
"fcm_token": {
"type": "string"
},
"fcm_token": {
"name": {
"type": "string"
},
"timestamp_created": {
@@ -3736,6 +3794,44 @@
}
}
},
"models.KeyTokenWithTokenJSON": {
"type": "object",
"properties": {
"all_channels": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"type": "string"
}
},
"keytoken_id": {
"type": "string"
},
"messages_sent": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_user_id": {
"type": "string"
},
"permissions": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"timestamp_lastused": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"models.MessageJSON": {
"type": "object",
"properties": {

View File

@@ -129,10 +129,10 @@ definitions:
type: string
client_type:
$ref: '#/definitions/models.ClientType'
description_name:
type: string
fcm_token:
type: string
name:
type: string
required:
- agent_model
- agent_version
@@ -163,10 +163,10 @@ definitions:
type: string
agent_version:
type: string
client_name:
type: string
client_type:
$ref: '#/definitions/models.ClientType'
description_name:
type: string
fcm_token:
type: string
no_client:
@@ -529,10 +529,10 @@ definitions:
type: string
client_id:
type: string
description_name:
type: string
fcm_token:
type: string
name:
type: string
timestamp_created:
type: string
type:
@@ -594,6 +594,31 @@ definitions:
timestamp_lastused:
type: string
type: object
models.KeyTokenWithTokenJSON:
properties:
all_channels:
type: boolean
channels:
items:
type: string
type: array
keytoken_id:
type: string
messages_sent:
type: integer
name:
type: string
owner_user_id:
type: string
permissions:
type: string
timestamp_created:
type: string
timestamp_lastused:
type: string
token:
type: string
type: object
models.MessageJSON:
properties:
channel_id:
@@ -2197,6 +2222,46 @@ paths:
summary: Update a key
tags:
- API-v2
/api/v2/users/{uid}/keys/current:
get:
description: Can be done with keys of any permission - the returned key does
not include its token.
operationId: api-tokenkeys-get-current
parameters:
- description: UserID
in: path
name: uid
required: true
type: string
- description: TokenKeyID
in: path
name: kid
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.KeyTokenWithTokenJSON'
"400":
description: supplied values/parameters cannot be parsed / are invalid
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: user is not authorized / has missing permissions
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: message not found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: Get the key currently used by this request
tags:
- API-v2
/api/v2/users/{uid}/subscriptions:
get:
description: |-