DocumentationAPI reference

Rust · 0.1.0

Get User Setting

GET /api/v1/users/{user}/settings/{setting}

UserService · UserService_GetUserSetting

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Public setting keys are limited

The exposed setting keys are GENERAL, TAGS and WEBHOOKS. Account token/session storage is not exposed as a setting. WEBHOOKS is read-only here; manage it through the dedicated webhook operations. Missing GENERAL settings are projected with defaults.

Request

GetUserSetting returns the user setting.

GET/api/v1/users/{user}/settings/{setting}

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
setting
path
string
Required
The setting id.

Request body

No request body is declared.

Responses

200 · OK

application/json · UserSetting

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "UserService"
  ],
  "description": "GetUserSetting returns the user setting.",
  "operationId": "UserService_GetUserSetting",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "setting",
      "in": "path",
      "description": "The setting id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UserSetting"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}