TiMessengerContactManagement.yaml

openapi: 3.0.3
info:
  title: I_TiMessengerContactManagement
  description: |
    # Overview
    This is a TI-Messenger REST interface.
    It is used by TI-Messenger-Clients to manage the invite settings of contacts.
    Each mxid in an active contact setting has the right to invite the
    user who created the contact setting.
    # Context
    ## Authentication
    The TI-Messenger-Client uses a Matrix-OpenID-Token from his Messenger-Service for
    authentication on all REST operations. The bearer token can be obtained from the
    homeserver. (POST /_matrix/client/r0/user/{userId}/openid/request_token).


    TI-Messenger-Client ---> Messenger-Proxy ---> Homeserver
    ## REST operations
    The interface implements CRUD operations to manage the contact settings.

    TI-Messenger-Client ---> Messenger-Proxy

    # Contact
  version: 1.0.2
  ### 1.0.2
  # - raised patch number in server url due to bugfixing
  # - changed MXID description and example 
  #   changed format of mxid to normal identifier to support better handling in proxies 
  #   and avoid security issues like https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2007-0450  
  ### 1.0.1
  # - raised patch number in server url due to bugfixing
  # - removed pointless 404 response while createContactSetting
  # - added MXID description & example
  ### 1.0.0
  # - initial version
  contact:
    name: gematik GmbH
    email: software-development@gematik.de
    url: "https://www.gematik.de"
  license:
    name: Apache 2.0
    url: "https://www.apache.org/licenses/LICENSE-2.0"

externalDocs:
  description: TI-Messenger-API
  url: https://github.com/gematik/api-ti-messenger

servers:
  - url: https://localhost/tim-contact-mgmt/v1.0.2/
tags:
  - name: info
    description: This operation returns meta data about this interface and the status of available resources
  - name: contacts
    description: Operations for contact management

paths:
  /:
    get:
      tags:
        - info
      description: Returns the meta data of this interface.
      operationId: getInfo
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InfoObject"
        "403":
          $ref: "#/components/responses/Forbidden"
        default:
          $ref: "#/components/responses/DefaultResponse"

  /contacts:
    parameters:
      - $ref: "#/components/parameters/mxidHeader"

    get:
      tags:
        - getContacts
      description: "Returns the contacts with invite settings."
      operationId: getContacts
      responses:
        200:
          description: "List of all contact settings of the user"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Contacts"
        default:
          $ref: "#/components/responses/DefaultResponse"

    post:
      tags:
        - createContactSetting
      description: "Creates the setting for the contact {mxid}."
      operationId: createContactSetting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Contact"
      responses:
        "200":
          description: "Contact setting for {mxid} successfully created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Contact"
        "400":
          $ref: "#/components/responses/BadRequest"
        default:
          $ref: "#/components/responses/DefaultResponse"

    put:
      tags:
        - updateContactSetting
      description: "Updates the setting for the contact {mxid}."
      operationId: updateContactSetting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Contact"
      responses:
        "200":
          description: "Contact setting for {mxid} successfully updated"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Contact"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
        default:
          $ref: "#/components/responses/DefaultResponse"

  /contacts/{mxid}:
    parameters:
      - $ref: "#/components/parameters/mxidHeader"
      - $ref: "#/components/parameters/mxid"

    get:
      tags:
        - getContact
      description: "Returns the contacts with invite settings."
      operationId: getContact
      responses:
        200:
          description: "Retrieve the setting for the contact {mxid}."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Contact"
        default:
          $ref: "#/components/responses/DefaultResponse"

    delete:
      tags:
        - deleteContactSetting
      description: "Deletes the setting for the contact {mxid}."
      operationId: deleteContactSetting
      responses:
        "204":
          description: Deleted
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
        "404":
          $ref: "#/components/responses/NotFound"
        default:
          $ref: "#/components/responses/DefaultResponse"

# Descriptions of common components
components:

  parameters:

    mxidHeader:
      name: Mxid
      in: header
      description: MXID of the contact settings owner. MUST match with the
        MXID resolved from the Matrix-OpenID-Token.
      required: true
      schema:
        type: string
    mxid:
      name: mxid
      in: path
      description: "ID of the contact (mxid))."
      required: true
      schema:
        type: string

  responses:
    DefaultResponse:
      description: "The default error response"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    NotFound:
      description: "The specified resource was not found"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    Unauthorized:
      description: "Unauthorized"
    Forbidden:
      description: "Forbidden - you are not allowed to do this"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    BadRequest:
      description: "Bad Request"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"

  schemas:

    InfoObject:
      description: ""
      required:
        - title
        - version
      readOnly: true
      type: object
      properties:
        title:
          type: string
          description: "Der Titel der Anwendung"
          example: "Contact Management des TI-Messengers"
        description:
          type: string
          description: "Short description of the application"
          example: "Contact Management des TI-Messengers. Betreiber: <Betreibername>"
        contact:
          type: string
          description: "Contact information"
        version:
          type: string
          description: "Version der implementierten TiMessengerContactManagement.yaml Schnittstelle (Version der TiMessengerContactManagement.yaml Datei)"
          example: "1.0.0"

    Contact:
      description: "Contact settings."
      type: object
      properties:
        displayName:
          type: string
          description: "Name of the contact."
          example: "Musterfrau, Erika"
        mxid:
          type: string
          description: "MXID of the contact (@localpart:domain)). See "
          externalDocs:
            url: https://spec.matrix.org/v1.3/appendices/#user-identifiers
          example: "@testuser:tim.test.gematik.de" 
        inviteSettings:
          type: object
          properties:
            start:
              type: integer
              format: int64
              description: "start (Epoch Unix Timestamp, SECONDS SINCE JAN 01 1970. (UTC))"
              example: "1654159585"
            end:
              type: integer
              format: int64
              description: "end  (Epoch Unix Timestamp, SECONDS SINCE JAN 01 1970. (UTC))"
              example: "1654169585"
          required:
            - start
          description: "Invites from the mxid are granted between start and end date-time."
      required:
        - displayName
        - mxid
        - inviteSettings

    Contacts:
      description: "The list of contacts and their settings."
      type: object
      properties:
        contacts:
          description: "The list of contacts and their settings."
          type: array
          items:
            $ref: "#/components/schemas/Contact"
          readOnly: true

    Error:
      description: "Default error object with information about the occurred error"
      type: object
      properties:
        errorCode:
          description: "a code identifying this error"
          type: string
        errorMessage:
          description: "a readable message describing the error"
          type: string
      required:
        - errorCode
        - errorMessage

  securitySchemes:
    bearerMatrixOpenIdTokenAuth:            # arbitrary name for the security scheme
      type: http
      scheme: bearer
      bearerFormat: JWT    # optional, arbitrary value for documentation purposes

# the security applies to all operations
security:
  - bearerMatrixOpenIdTokenAuth: []         # use the same name as above