gitlab-acebase/src/routes/data-set.yaml

AceBase realtime database server (webserver endpoint to allow remote connections)

/data/{dbname}/{path}:
  put:
    tags:
      - data
    summary: Sets the value of a path
    description: Sets the stored value of a path in the database, overwriting existing data and its children
    parameters:
      - name: dbname
        in: path
        description: name of the database
        required: true
        schema:
          type: string
          example: mydb
      - name: path
        in: path
        description: database path
        required: true
        schema:
          type: string
          example: collection/child/property
      - name: AceBase-Context
        in: header
        description: Contextual info about the database operation (must be valid JSON). This info is included in event notifications sent to clients watching data at this or child paths
        schema:
          type: string
          example: '{}'
    requestBody:
      description: serialized value to store in the database
      content:
        'application/json':
          schema:
            $ref: '#/components/schemas/SerializedValue'
    responses:
      200:
        description: Returns "200 OK" when the database operation succeeded
        content:
          'application/json':
            headers:
              'AceBase-Context':
                description: Returns contextual information, such as the `acebase_cursor` if transaction logging is enabled on the server.
                schema:
                  type: string
                  example: '{ "acebase_cursor": "l3lf2iwd000109mgdn0d6pqt" }'
            schema:
              type: object
              properties:
                success:
                  type: boolean
                  example: true
      400:
        description: Returns "400 Bad Request if the sent value is incorrect
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/Error'
            example:
              code: invalid_serialized_value
              message: The sent value is not properly serialized
      403:
        description: Returns "403 Forbidden" if the signed in user is not allowed to write to the target path
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/RuleValidationError'
      422:
        description: Returns "422 Unprocessable Entity" if schema validation for the sent value failed.
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/SchemaValidationError'
      500:
        description: An unexpected error occurred
        content:
          'application/json':
            schema:
              $ref: '#/components/schemas/UnexpectedError'