mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-22 19:56:39 +00:00
[chore] fix + update swagger docs (#1622)
This commit is contained in:
parent
19e058466d
commit
d5529d6c9f
|
@ -16,7 +16,7 @@ definitions:
|
||||||
type: object
|
type: object
|
||||||
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
||||||
Link:
|
Link:
|
||||||
description: See https://webfinger.net/
|
description: See https://webfinger.net/ and https://www.rfc-editor.org/rfc/rfc6415.html#section-3.1
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
|
@ -1119,6 +1119,20 @@ definitions:
|
||||||
type: object
|
type: object
|
||||||
x-go-name: Field
|
x-go-name: Field
|
||||||
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
||||||
|
hostmeta:
|
||||||
|
description: 'See: https://www.rfc-editor.org/rfc/rfc6415.html#section-3'
|
||||||
|
properties:
|
||||||
|
Link:
|
||||||
|
items:
|
||||||
|
$ref: '#/definitions/Link'
|
||||||
|
type: array
|
||||||
|
XMLNS:
|
||||||
|
type: string
|
||||||
|
XMLName: {}
|
||||||
|
title: HostMeta represents a hostmeta document.
|
||||||
|
type: object
|
||||||
|
x-go-name: HostMeta
|
||||||
|
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
||||||
instanceConfigurationAccounts:
|
instanceConfigurationAccounts:
|
||||||
properties:
|
properties:
|
||||||
allow_custom_css:
|
allow_custom_css:
|
||||||
|
@ -1481,7 +1495,7 @@ definitions:
|
||||||
translation:
|
translation:
|
||||||
$ref: '#/definitions/instanceV2ConfigurationTranslation'
|
$ref: '#/definitions/instanceV2ConfigurationTranslation'
|
||||||
urls:
|
urls:
|
||||||
$ref: '#/definitions/instanceV1URLs'
|
$ref: '#/definitions/instanceV2URLs'
|
||||||
title: Configured values and limits for this instance.
|
title: Configured values and limits for this instance.
|
||||||
type: object
|
type: object
|
||||||
x-go-name: InstanceV2Configuration
|
x-go-name: InstanceV2Configuration
|
||||||
|
@ -1588,6 +1602,17 @@ definitions:
|
||||||
type: object
|
type: object
|
||||||
x-go-name: InstanceV2ThumbnailVersions
|
x-go-name: InstanceV2ThumbnailVersions
|
||||||
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
||||||
|
instanceV2URLs:
|
||||||
|
properties:
|
||||||
|
streaming:
|
||||||
|
description: Websockets address for status and notification streaming.
|
||||||
|
example: wss://example.org
|
||||||
|
type: string
|
||||||
|
x-go-name: Streaming
|
||||||
|
title: InstanceV2URLs models instance-relevant URLs for client application consumption.
|
||||||
|
type: object
|
||||||
|
x-go-name: InstanceV2URLs
|
||||||
|
x-go-package: github.com/superseriousbusiness/gotosocial/internal/api/model
|
||||||
instanceV2Usage:
|
instanceV2Usage:
|
||||||
properties:
|
properties:
|
||||||
users:
|
users:
|
||||||
|
@ -2513,6 +2538,20 @@ info:
|
||||||
title: GoToSocial Swagger documentation.
|
title: GoToSocial Swagger documentation.
|
||||||
version: REPLACE_ME
|
version: REPLACE_ME
|
||||||
paths:
|
paths:
|
||||||
|
/.well-known/host-meta:
|
||||||
|
get:
|
||||||
|
description: 'See: https://www.rfc-editor.org/rfc/rfc6415.html'
|
||||||
|
operationId: hostMetaGet
|
||||||
|
produces:
|
||||||
|
- application/xrd+xml"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: ""
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/hostmeta'
|
||||||
|
summary: Returns a compliant hostmeta response to web host metadata queries.
|
||||||
|
tags:
|
||||||
|
- .well-known
|
||||||
/.well-known/nodeinfo:
|
/.well-known/nodeinfo:
|
||||||
get:
|
get:
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -3102,6 +3141,12 @@ paths:
|
||||||
in: formData
|
in: formData
|
||||||
name: enable_rss
|
name: enable_rss
|
||||||
type: boolean
|
type: boolean
|
||||||
|
- description: Profile fields to be added to this account's profile
|
||||||
|
in: formData
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
name: fields_attributes
|
||||||
|
type: array
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
responses:
|
responses:
|
||||||
|
|
|
@ -122,7 +122,7 @@ type InstanceV2ThumbnailVersions struct {
|
||||||
|
|
||||||
// InstanceV2URLs models instance-relevant URLs for client application consumption.
|
// InstanceV2URLs models instance-relevant URLs for client application consumption.
|
||||||
//
|
//
|
||||||
// swagger:model instanceV1URLs
|
// swagger:model instanceV2URLs
|
||||||
type InstanceV2URLs struct {
|
type InstanceV2URLs struct {
|
||||||
// Websockets address for status and notification streaming.
|
// Websockets address for status and notification streaming.
|
||||||
// example: wss://example.org
|
// example: wss://example.org
|
||||||
|
|
Loading…
Reference in a new issue