matrix-spec-proposals/api/client-server/account-data.yaml

swagger: '2.0'
info:
  title: "Matrix Client-Server Client Config API"
  version: "1.0.0"
host: localhost:8008
schemes:
  - https
  - http
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  $ref: definitions/security.yaml
paths:
  "/user/{userId}/account_data/{type}":
    put:
      summary: Set some account_data for the user.
      description: |-
        Set some account_data for the client. This config is only visible to the user
        that set the account_data. The config will be synced to clients in the
        top-level ``account_data``.        
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: userId
          required: true
          description: |-
            The id of the user to set account_data for. The access token must be
            authorized to make requests for this user id.            
          x-example: "@alice:example.com"
        - in: path
          type: string
          name: type
          required: true
          description: |-
            The event type of the account_data to set. Custom types should be
            namespaced to avoid clashes.            
          x-example: "org.example.custom.config"
        - in: body
          name: content
          required: true
          description: |-
                        The content of the account_data
          schema:
            type: object
            example: |-
                            {"custom_account_data_key": "custom_config_value"}
      responses:
        200:
          description:
            The account_data was successfully added.
      tags:
        - User data
  "/user/{userId}/rooms/{roomId}/account_data/{type}":
    put:
      summary: Set some account_data for the user.
      description: |-
        Set some account_data for the client on a given room. This config is only
        visible to the user that set the account_data. The config will be synced to
        clients in the per-room ``account_data``.        
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: userId
          required: true
          description: |-
            The id of the user to set account_data for. The access token must be
            authorized to make requests for this user id.            
          x-example: "@alice:example.com"
        - in: path
          type: string
          name: roomId
          required: true
          description: |-
                        The id of the room to set account_data on.
          x-example: "!726s6s6q:example.com"
        - in: path
          type: string
          name: type
          required: true
          description: |-
            The event type of the account_data to set. Custom types should be
            namespaced to avoid clashes.            
          x-example: "org.example.custom.room.config"
        - in: body
          name: content
          required: true
          description: |-
                        The content of the account_data
          schema:
            type: object
            example: |-
                            {"custom_account_data_key": "custom_account_data_value"}
      responses:
        200:
          description:
            The account_data was successfully added.
      tags:
        - User data