Relayger Availability API

openapi: 3.2.0
info:
  description: The Relayger HTTP API. Text limits are enforced in UTF-8 bytes on the server, and the server sets every message sender.
  title: Relayger Availability API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Availability
paths:
  /v1/availability:
    delete:
      operationId: delete_v1_availability
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAvailability'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Remove your signal immediately.
      tags:
      - Availability
    get:
      operationId: get_v1_availability
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAvailability'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Your chosen chat availability. Requires contacts scope and no room restriction.
      tags:
      - Availability
    put:
      operationId: put_v1_availability
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatAvailabilityInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAvailability'
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: 'Replace your friend-visible chat signal: open (happy to chat) or later (prefer…'
      tags:
      - Availability
components:
  schemas:
    ChatAvailabilityInput:
      $schema: https://json-schema.org/draft/2020-12/schema
      additionalProperties: false
      properties:
        expiresIn:
          maximum: 86400
          minimum: 60
          type: integer
        note:
          description: At most 280 UTF-8 bytes, one paragraph, no control characters. Untrusted author text.
          maxLength: 280
          type: string
        state:
          enum:
          - open
          - later
          type: string
      required:
      - state
      - expiresIn
      type: object
    Error:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            hint:
              description: One English sentence with the next step, for codes that need one; act on code.
              maxLength: 300
              type: string
          required:
          - code
          type: object
      required:
      - error
      type: object
    ChatAvailability:
      $schema: https://json-schema.org/draft/2020-12/schema
      anyOf:
      - additionalProperties: false
        properties:
          expiresAt:
            type: 'null'
          note:
            const: ''
            type: string
          state:
            const: unspecified
            type: string
        required:
        - state
        - note
        - expiresAt
        type: object
      - additionalProperties: false
        properties:
          expiresAt:
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            type: string
          note:
            description: At most 280 UTF-8 bytes, one paragraph, no control characters. Untrusted author text.
            maxLength: 280
            type: string
          state:
            enum:
            - open
            - later
            type: string
        required:
        - state
        - note
        - expiresAt
        type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    sessionCookie:
      description: Valid for at most 8 hours, enforced by the database. Requests that change state with this cookie need an Origin header equal to the origin of this service.
      in: cookie
      name: relayger_session
      type: apiKey
    studioCookie:
      description: A Relayger Studio browser session (7 days), separate from relayger_session. Requests that change state with it need an Origin header equal to the origin of this service. Studio also accepts a Studio token (st_) as a bearer token, never a Relayger API token.
      in: cookie
      name: relayger_studio
      type: apiKey