Rentberry User Settings API

User Settings

OpenAPI Specification

rentberry-user-settings-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Rentberry User Settings API
  description: Renting Done Right. Finally.
  version: 4
tags:
- name: User Settings
  description: User Settings
paths:
  /v{version}/user/settings:
    get:
      tags:
      - User Settings
      summary: Get user settings by keys.
      description: Available since API version 1. Returns user settings values for specified keys.
      operationId: get_api_v1_user_settings_get
      parameters:
      - name: keys
        in: query
        description: Comma-separated list of setting keys to retrieve
        required: true
        schema:
          type: string
          example: theme,language,notifications
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      responses:
        '200':
          description: Returns user settings as key-value pairs.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '400':
          description: Invalid keys parameter
      security:
      - XAuthToken: []
    post:
      tags:
      - User Settings
      summary: Set user settings.
      description: Available since API version 1. Sets user settings with provided key-value pairs.
      operationId: post_api_v1_user_settings_set
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              theme: dark
              language: en
              notifications: enabled
      responses:
        '204':
          description: Settings updated successfully.
        '401':
          description: Unauthorized
      security:
      - XAuthToken: []