feat(docs): add usage statistics to nodeinfo specs

Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2629>
environments/review-docs-nodei-atesoo/deployments/18713
Ciarán Ainsworth 2023-11-14 16:29:08 +00:00 zatwierdzone przez Marge
rodzic 7ac6447308
commit 3d5381760f
3 zmienionych plików z 19 dodań i 13 usunięć

Wyświetl plik

@ -0,0 +1 @@
Updated nodeinfo spec to include usage statistics.

Wyświetl plik

@ -37,15 +37,9 @@ The NodeInfo endpoint must contain all mandatory elements listed in the specific
`longDescription` (String)
: A longer description of the pod
`rules` (String)
: A collection of rules users of the pod must abide by
`contactEmail` (Email address)
: The email address of the pod administrator
`terms` (String)
: The terms of use associated with the pod
`nodeName`(String)
: The name of the pod
@ -140,16 +134,19 @@ Example response:
"activeMonth": 0
},
"localPosts": 0,
"localComments": 0
"localComments": 0,
"listenings": 0,
"downloads": 0,
"favorites": {
"tracks": 0
}
},
"metadata": {
"actorId": "string",
"private": true,
"shortDescription": "string",
"longDescription": "string",
"rules": "string",
"contactEmail": "user@example.com",
"terms": "string",
"nodeName": "string",
"banner": "string",
"defaultUploadQuota": 0,

Wyświetl plik

@ -444,6 +444,18 @@ components:
localComments:
type: integer
minimum: 0
listenings:
type: integer
minimum: 0
downloads:
type: integer
minimum: 0
favorites:
type: object
properties:
tracks:
type: integer
minimum: 0
metadata:
type: object
properties:
@ -456,13 +468,9 @@ components:
type: string
longDescription:
type: string
rules:
type: string
contactEmail:
type: string
format: email
terms:
type: string
nodeName:
type: string
banner: