diff options
| author |  Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com> | 2021-07-31 17:49:59 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2021-07-31 17:49:59 +0200 |
| commit | 58dddd86e0ddbb0c6aa54506dcef162321babfbb (patch) | |
| tree | ee83cec11f05dfe1e397b9303fe5cd7c2273d4f3 /internal/api/model/relationship.go | |
| parent | Password change (#123) (diff) | |
| download | gotosocial-58dddd86e0ddbb0c6aa54506dcef162321babfbb.tar.xz | |
Swagger (#124)
* start experimenting with swagger documentation
* further adventures in swagger
* do a few more api paths
* account paths documented
* go fmt
* fix up some models
* bit o lintin'
Diffstat (limited to 'internal/api/model/relationship.go')
| -rw-r--r-- | internal/api/model/relationship.go | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/internal/api/model/relationship.go b/internal/api/model/relationship.go index 6e71023e2..647ff7a91 100644 --- a/internal/api/model/relationship.go +++ b/internal/api/model/relationship.go @@ -18,31 +18,34 @@ package model -// Relationship represents a relationship between accounts. See https://docs.joinmastodon.org/entities/relationship/ +// Relationship represents a relationship between accounts. +// +// swagger:model accountRelationship type Relationship struct { // The account id. + // example: 01FBW9XGEP7G6K88VY4S9MPE1R ID string `json:"id"` - // Are you following this user? + // You are following this account. Following bool `json:"following"` - // Are you receiving this user's boosts in your home timeline? + // You are seeing reblogs/boosts from this account in your home timeline. ShowingReblogs bool `json:"showing_reblogs"` - // Have you enabled notifications for this user? + // You are seeing notifications when this account posts. Notifying bool `json:"notifying"` - // Are you followed by this user? + // This account follows you. FollowedBy bool `json:"followed_by"` - // Are you blocking this user? + // You are blocking this account. Blocking bool `json:"blocking"` - // Is this user blocking you? + // This account is blocking you. BlockedBy bool `json:"blocked_by"` - // Are you muting this user? + // You are muting this account. Muting bool `json:"muting"` - // Are you muting notifications from this user? + // You are muting notifications from this account. MutingNotifications bool `json:"muting_notifications"` - // Do you have a pending follow request for this user? + // You have requested to follow this account, and the request is pending. Requested bool `json:"requested"` - // Are you blocking this user's domain? + // You are blocking this account's domain. DomainBlocking bool `json:"domain_blocking"` - // Are you featuring this user on your profile? + // You are featuring this account on your profile. Endorsed bool `json:"endorsed"` // Your note on this account. Note string `json:"note"` |