Modoboa User Calendars API

openapi: 3.2.0
info:
  title: Modoboa User Calendars API
  version: v2
servers:
- url: https://demo.modoboa.org/api/schema-v2/
  description: Remote Demo server
- url: https://localhost:5000/api/schema-v2/
  description: Local server
tags:
- name: user-calendars
paths:
  /api/v2/user-calendars/:
    get:
      operationId: user_calendars_list
      description: Calendar viewset.
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserCalendar'
          description: ''
      summary: User calendars list
      x-summary-source: derived
    post:
      operationId: user_calendars_create
      description: Calendar viewset.
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCalendar'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserCalendar'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserCalendar'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCalendar'
          description: ''
      summary: User calendars create
      x-summary-source: derived
  /api/v2/user-calendars/{calendar_pk}/accessrules/:
    get:
      operationId: user_calendars_accessrules_list
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessRule'
          description: ''
      summary: User calendars accessrules list
      x-summary-source: derived
    post:
      operationId: user_calendars_accessrules_create
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccessRule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccessRule'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRule'
          description: ''
      summary: User calendars accessrules create
      x-summary-source: derived
  /api/v2/user-calendars/{calendar_pk}/accessrules/{id}/:
    get:
      operationId: user_calendars_accessrules_retrieve
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this access rule.
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRule'
          description: ''
      summary: User calendars accessrules retrieve
      x-summary-source: derived
    put:
      operationId: user_calendars_accessrules_update
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this access rule.
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccessRule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccessRule'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRule'
          description: ''
      summary: User calendars accessrules update
      x-summary-source: derived
    patch:
      operationId: user_calendars_accessrules_partial_update
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this access rule.
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAccessRule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAccessRule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAccessRule'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRule'
          description: ''
      summary: User calendars accessrules partial update
      x-summary-source: derived
    delete:
      operationId: user_calendars_accessrules_destroy
      description: AccessRule viewset, nested under a user calendar.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this access rule.
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: User calendars accessrules destroy
      x-summary-source: derived
  /api/v2/user-calendars/{calendar_pk}/events/:
    get:
      operationId: user_calendars_events_list
      description: Get a list of event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ROEvent'
          description: ''
      summary: User calendars events list
      x-summary-source: derived
    post:
      operationId: user_calendars_events_create
      description: Create new event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableEvent'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WritableEvent'
          description: ''
      summary: User calendars events create
      x-summary-source: derived
  /api/v2/user-calendars/{calendar_pk}/events/{id}/:
    get:
      operationId: user_calendars_events_retrieve
      description: Get a specific event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-zA-Z\-\.@]+$
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ROEvent'
          description: ''
      summary: User calendars events retrieve
      x-summary-source: derived
    put:
      operationId: user_calendars_events_update
      description: Update existing event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-zA-Z\-\.@]+$
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableEvent'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WritableEvent'
          description: ''
      summary: User calendars events update
      x-summary-source: derived
    patch:
      operationId: user_calendars_events_partial_update
      description: Update existing event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-zA-Z\-\.@]+$
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWritableEvent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWritableEvent'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWritableEvent'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WritableEvent'
          description: ''
      summary: User calendars events partial update
      x-summary-source: derived
    delete:
      operationId: user_calendars_events_destroy
      description: Destroy a specific event.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-zA-Z\-\.@]+$
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: User calendars events destroy
      x-summary-source: derived
  /api/v2/user-calendars/{calendar_pk}/events/import_from_file/:
    post:
      operationId: user_calendars_events_import_from_file_create
      description: Import events from file.
      parameters:
      - in: path
        name: calendar_pk
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WritableEvent'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableEvent'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WritableEvent'
          description: ''
      summary: User calendars events import from file create
      x-summary-source: derived
  /api/v2/user-calendars/{id}/:
    get:
      operationId: user_calendars_retrieve
      description: Calendar viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCalendar'
          description: ''
      summary: User calendars retrieve
      x-summary-source: derived
    put:
      operationId: user_calendars_update
      description: Calendar viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCalendar'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserCalendar'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserCalendar'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCalendar'
          description: ''
      summary: User calendars update
      x-summary-source: derived
    patch:
      operationId: user_calendars_partial_update
      description: Calendar viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUserCalendar'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUserCalendar'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUserCalendar'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCalendar'
          description: ''
      summary: User calendars partial update
      x-summary-source: derived
    delete:
      operationId: user_calendars_destroy
      description: Calendar viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - user-calendars
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: User calendars destroy
      x-summary-source: derived
  /api/v2/user-calendars/check_token/:
    post:
      operationId: user_calendars_check_token_create
      description: Check token validity.
      tags:
      - user-calendars
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckToken'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CheckToken'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CheckToken'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckToken'
          description: ''
      summary: User calendars check token create
      x-summary-source: derived
components:
  schemas:
    Domain:
      type: object
      description: Domain serializer for v2 API.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The domain name
          maxLength: 253
        quota:
          type: string
          description: Quota shared between mailboxes. Can be expressed in KB, MB (default) or GB. A value of 0 means no quota.
        default_mailbox_quota:
          type: string
          description: Default quota in MB applied to mailboxes. A value of 0 means no quota.
        enabled:
          type: boolean
          description: Check to activate this domain
        type:
          type: string
          maxLength: 20
        enable_dkim:
          type: boolean
          title: Enable DKIM signing
          description: If you activate this feature, a DKIM key will be generated for this domain.
        dkim_key_selector:
          type: string
          maxLength: 30
        dkim_key_length:
          title: Key length
          minimum: 0
          maximum: 9223372036854775807
          oneOf:
          - $ref: '#/components/schemas/DkimKeyLengthEnum'
          - $ref: '#/components/schemas/NullEnum'
        dkim_public_key:
          type: string
          readOnly: true
        dkim_private_key_path:
          type: string
          readOnly: true
        mailbox_count:
          type: integer
          readOnly: true
        mbalias_count:
          type: integer
          readOnly: true
        domainalias_count:
          type: integer
          readOnly: true
        dns_global_status:
          type: string
          description: Return global DNS status.
          readOnly: true
        message_limit:
          type:
          - integer
          - 'null'
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          title: Message sending limit
          description: Number of messages this domain can send per day
        creation:
          type: string
          format: date-time
          readOnly: true
        last_modification:
          type: string
          format: date-time
          readOnly: true
        allocated_quota_in_percent:
          type: string
          readOnly: true
        enable_dns_checks:
          type: boolean
          description: Check to enable DNS checks for this domain
        domain_admin:
          allOf:
          - $ref: '#/components/schemas/CreateDomainAdmin'
          writeOnly: true
        transport:
          $ref: '#/components/schemas/Transport'
        opened_alarms_count:
          type: integer
          description: Number of alarms currently opened for this domain.
          readOnly: true
        sent_messages:
          type: string
          readOnly: true
        sent_messages_in_percent:
          type:
          - integer
          - 'null'
          description: Return number of sent messages as a percentage.
          readOnly: true
        last_dns_check_execution:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - allocated_quota_in_percent
      - creation
      - dkim_private_key_path
      - dkim_public_key
      - dns_global_status
      - domainalias_count
      - last_modification
      - mailbox_count
      - mbalias_count
      - name
      - opened_alarms_count
      - pk
      - sent_messages
      - sent_messages_in_percent
    CreateDomainAdmin:
      type: object
      description: Sub serializer for domain administrator creation.
      properties:
        username:
          type: string
        password:
          type: string
        with_mailbox:
          type: boolean
          default: false
        with_aliases:
          type: boolean
          default: false
      required:
      - username
    DkimKeyLengthEnum:
      enum:
      - 1024
      - 2048
      - 4096
      type: integer
      description: '* `1024` - 1024

        * `2048` - 2048

        * `4096` - 4096'
    ROEvent:
      type: object
      description: Event serializer for read operations.
      properties:
        id:
          type: string
          readOnly: true
        title:
          type: string
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        allDay:
          type: boolean
          default: false
        color:
          type: string
          readOnly: true
        description:
          type: string
        attendees:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        calendar:
          $ref: '#/components/schemas/SharedCalendar'
      required:
      - calendar
      - color
      - id
      - title
    Attendee:
      type: object
      description: Attendee serializer.
      properties:
        display_name:
          type: string
        email:
          type: string
          format: email
      required:
      - display_name
      - email
    Transport:
      type: object
      description: Serializer for Transport model.
      properties:
        service:
          type: string
          maxLength: 30
        settings:
          type: object
          additionalProperties: {}
      required:
      - service
      - settings
    WritableEvent:
      type: object
      description: Event serializer for write operations.
      properties:
        id:
          type: string
          readOnly: true
        title:
          type: string
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        allDay:
          type: boolean
          default: false
        color:
          type: string
          readOnly: true
        description:
          type: string
        attendees:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        calendar:
          type: integer
        new_calendar_type:
          type: string
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
      required:
      - calendar
      - color
      - id
      - title
    PatchedAccessRule:
      type: object
      description: AccessRule serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        mailbox:
          $ref: '#/components/schemas/Mailbox'
        calendar:
          type: integer
          readOnly: true
        read:
          type: boolean
        write:
          type: boolean
    Mailbox:
      type: object
      description: Base mailbox serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        full_address:
          type: string
          format: email
        use_domain_quota:
          type: boolean
        quota:
          type: string
        message_limit:
          type:
          - integer
          - 'null'
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          title: Message sending limit
          description: Number of messages this mailbox can send per day
        quota_usage:
          type: integer
          readOnly: true
        is_send_only:
          type: boolean
        sent_messages_in_percent:
          type:
          - integer
          - 'null'
          description: Return number of sent messages as a percentage.
          readOnly: true
      required:
      - full_address
      - pk
      - quota_usage
      - sent_messages_in_percent
    PatchedUserCalendar:
      type: object
      description: User calendar serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          pattern: ^[^/\\\r\n\u0000]+$
          maxLength: 200
        color:
          type: string
          maxLength: 7
        path:
          type: string
          readOnly: true
        full_url:
          type: string
          readOnly: true
        share_url:
          type: string
          readOnly: true
    CheckToken:
      type: object
      description: Serializer for the check_token action.
      properties:
        calendar:
          type: string
        token:
          type: string
      required:
      - calendar
      - token
    UserCalendar:
      type: object
      description: User calendar serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          pattern: ^[^/\\\r\n\u0000]+$
          maxLength: 200
        color:
          type: string
          maxLength: 7
        path:
          type: string
          readOnly: true
        full_url:
          type: string
          readOnly: true
        share_url:
          type: string
          readOnly: true
      required:
      - full_url
      - name
      - path
      - pk
      - share_url
    NullEnum:
      enum:
      - null
    SharedCalendar:
      type: object
      description: Shared calendar serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          pattern: ^[^/\\\r\n\u0000]+$
          maxLength: 200
        color:
          type: string
          maxLength: 7
        path:
          type: string
          readOnly: true
        domain:
          $ref: '#/components/schemas/Domain'
        full_url:
          type: string
          readOnly: true
        share_url:
          type: string
          readOnly: true
      required:
      - domain
      - full_url
      - name
      - path
      - pk
      - share_url
    PatchedWritableEvent:
      type: object
      description: Event serializer for write operations.
      properties:
        id:
          type: string
          readOnly: true
        title:
          type: string
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        allDay:
          type: boolean
          default: false
        color:
          type: string
          readOnly: true
        description:
          type: string
        attendees:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        calendar:
          type: integer
        new_calendar_type:
          type: string
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
    AccessRule:
      type: object
      description: AccessRule serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        mailbox:
          $ref: '#/components/schemas/Mailbox'
        calendar:
          type: integer
          readOnly: true
        read:
          type: boolean
        write:
          type: boolean
      required:
      - calendar
      - mailbox
      - pk
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"