notificationservice_swagger.yaml

basePath: /api/notification-service
definitions:
  entities.Origin:
    properties:
      class:
        type: string
      name:
        type: string
      serviceID:
        description: read-only
        type: string
    type: object
  errorResponses.ErrorResponse:
    properties:
      details:
        type: string
      errors:
        additionalProperties:
          type: string
        type: object
      title:
        type: string
      type:
        type: string
    type: object
  filter.CompareOperator:
    enum:
    - beginsWith
    - doesNotBeginWith
    - contains
    - doesNotContain
    - textContains
    - isNumberEqualTo
    - isNumberNotEqualTo
    - isEqualTo
    - isNotEqualTo
    - isIpEqualTo
    - isIpNotEqualTo
    - isStringEqualTo
    - isStringNotEqualTo
    - isStringCaseInsensitiveEqualTo
    - isGreaterThan
    - isGreaterThanOrEqualTo
    - isLessThan
    - isLessThanOrEqualTo
    - beforeDate
    - afterDate
    - betweenDates
    - exists
    - doesNotExist
    - isEqualToRating
    - isNotEqualToRating
    - isLessThanRating
    - isLessThanOrEqualToRating
    - isGreaterThanRating
    - isGreaterThanOrEqualToRating
    type: string
    x-enum-varnames:
    - CompareOperatorBeginsWith
    - CompareOperatorDoesNotBeginWith
    - CompareOperatorContains
    - CompareOperatorDoesNotContain
    - CompareOperatorTextContains
    - CompareOperatorIsNumberEqualTo
    - CompareOperatorIsNumberNotEqualTo
    - CompareOperatorIsEqualTo
    - CompareOperatorIsNotEqualTo
    - CompareOperatorIsIpEqualTo
    - CompareOperatorIsIpNotEqualTo
    - CompareOperatorIsStringEqualTo
    - CompareOperatorIsStringNotEqualTo
    - CompareOperatorIsStringCaseInsensitiveEqualTo
    - CompareOperatorIsGreaterThan
    - CompareOperatorIsGreaterThanOrEqualTo
    - CompareOperatorIsLessThan
    - CompareOperatorIsLessThanOrEqualTo
    - CompareOperatorBeforeDate
    - CompareOperatorAfterDate
    - CompareOperatorBetweenDates
    - CompareOperatorExists
    - CompareOperatorDoesNotExist
    - CompareOperatorIsEqualToRating
    - CompareOperatorIsNotEqualToRating
    - CompareOperatorIsLessThanRating
    - CompareOperatorIsLessThanOrEqualToRating
    - CompareOperatorIsGreaterThanRating
    - CompareOperatorIsGreaterThanOrEqualToRating
  filter.ControlType:
    enum:
    - bool
    - enum
    - float
    - integer
    - string
    - dateTime
    - uuid
    - autocomplete
    type: string
    x-enum-varnames:
    - ControlTypeBool
    - ControlTypeEnum
    - ControlTypeFloat
    - ControlTypeInteger
    - ControlTypeString
    - ControlTypeDateTime
    - ControlTypeUuid
    - ControlTypeAutocomplete
  filter.LogicOperator:
    enum:
    - and
    - or
    type: string
    x-enum-varnames:
    - LogicOperatorAnd
    - LogicOperatorOr
  filter.ReadableValue-string:
    properties:
      label:
        description: Label is the human-readable form of the value
        type: string
      value:
        description: Value is the value for the backend
        type: string
    type: object
  filter.Request:
    properties:
      fields:
        items:
          $ref: '#/definitions/filter.RequestField'
        type: array
      operator:
        $ref: '#/definitions/filter.LogicOperator'
    required:
    - operator
    type: object
  filter.RequestField:
    properties:
      keys:
        items:
          type: string
        type: array
      name:
        type: string
      operator:
        $ref: '#/definitions/filter.CompareOperator'
      value:
        description: Value can be a list of values or a value
    required:
    - name
    - operator
    - value
    type: object
  filter.RequestOptionType:
    properties:
      type:
        allOf:
        - $ref: '#/definitions/filter.ControlType'
        enum:
        - string
        - float
        - integer
        - enum
        - bool
    type: object
  maildto.CheckMailServerEntityRequest:
    properties:
      domain:
        type: string
      isAuthenticationRequired:
        default: false
        type: boolean
      isTlsEnforced:
        default: false
        type: boolean
      password:
        type: string
      port:
        type: integer
      username:
        type: string
    type: object
  maildto.CheckMailServerRequest:
    properties:
      domain:
        type: string
      isAuthenticationRequired:
        default: false
        type: boolean
      isTlsEnforced:
        default: false
        type: boolean
      password:
        type: string
      port:
        type: integer
      username:
        type: string
    type: object
  maildto.MailNotificationChannelRequest:
    properties:
      channelName:
        type: string
      domain:
        type: string
      id:
        type: string
      isAuthenticationRequired:
        default: false
        type: boolean
      isTlsEnforced:
        default: false
        type: boolean
      maxEmailAttachmentSizeMb:
        type: integer
      maxEmailIncludeSizeMb:
        type: integer
      password:
        type: string
      port:
        type: integer
      senderEmailAddress:
        type: string
      username:
        type: string
    type: object
  mattermostdto.MattermostNotificationChannelRequest:
    properties:
      channelName:
        type: string
      description:
        type: string
      webhookUrl:
        type: string
    type: object
  models.Action:
    properties:
      channel:
        $ref: '#/definitions/models.ChannelReference'
      recipient:
        description: specific recipient if supported/required by the channel, e.g.
          for mail a comma separated list of mail adresses
        type: string
    required:
    - channel
    type: object
  models.ChannelReference:
    properties:
      id:
        type: string
      name:
        readOnly: true
        type: string
      type:
        allOf:
        - $ref: '#/definitions/models.ChannelType'
        readOnly: true
    required:
    - id
    type: object
  models.ChannelType:
    enum:
    - mail
    - mattermost
    - teams
    type: string
    x-enum-varnames:
    - ChannelTypeMail
    - ChannelTypeMattermost
    - ChannelTypeTeams
  models.Notification:
    properties:
      customFields:
        additionalProperties: {}
        description: can contain arbitrary structured information about the event
        type: object
      detail:
        type: string
      id:
        readOnly: true
        type: string
      level:
        allOf:
        - $ref: '#/definitions/notifications.Level'
        enum:
        - info
        - warning
        - error
        - urgent
      origin:
        description: name of the origin, e.g. `SBOM - React`
        type: string
      originClass:
        description: unique identifier for the class of origins, e.g. `/vi/SBOM`,
          for now optional for backwards compatibility, will be required in future
        type: string
      originResourceID:
        description: together with class it can be used to provide a link to the origin,
          e.g. `<id of react sbom object>`
        type: string
      timestamp:
        format: date-time
        type: string
      title:
        type: string
    required:
    - detail
    - level
    - origin
    - timestamp
    - title
    type: object
  models.NotificationChannel:
    properties:
      channelName:
        type: string
      channelType:
        $ref: '#/definitions/models.ChannelType'
      createdAt:
        readOnly: true
        type: string
      description:
        type: string
      domain:
        type: string
      id:
        readOnly: true
        type: string
      isAuthenticationRequired:
        type: boolean
      isTlsEnforced:
        type: boolean
      maxEmailAttachmentSizeMb:
        type: integer
      maxEmailIncludeSizeMb:
        type: integer
      password:
        type: string
      port:
        type: integer
      senderEmailAddress:
        type: string
      updatedAt:
        type: string
      username:
        type: string
      webhookUrl:
        type: string
    required:
    - channelType
    type: object
  models.Origin:
    properties:
      class:
        description: unique identifier
        type: string
      name:
        description: human readable name representation
        type: string
      serviceID:
        description: service in which this origin is defined
        readOnly: true
        type: string
    required:
    - class
    - name
    type: object
  models.OriginReference:
    properties:
      class:
        type: string
      name:
        readOnly: true
        type: string
      serviceID:
        readOnly: true
        type: string
    required:
    - class
    type: object
  models.Rule:
    properties:
      action:
        $ref: '#/definitions/models.Action'
      active:
        type: boolean
      errors:
        allOf:
        - $ref: '#/definitions/models.ValidationErrors'
        description: populated if the rule is invalid, this can be useful to highlight
          rules which need action from the user.
        readOnly: true
      id:
        readOnly: true
        type: string
      name:
        type: string
      trigger:
        $ref: '#/definitions/models.Trigger'
    required:
    - action
    - name
    - trigger
    type: object
  models.RuleOptions:
    properties:
      channels:
        items:
          $ref: '#/definitions/models.NotificationChannel'
        type: array
      levels:
        items:
          $ref: '#/definitions/notifications.Level'
        type: array
      origins:
        items:
          $ref: '#/definitions/entities.Origin'
        type: array
    type: object
  models.Trigger:
    properties:
      levels:
        items:
          $ref: '#/definitions/notifications.Level'
        type: array
      origins:
        items:
          $ref: '#/definitions/models.OriginReference'
        type: array
    required:
    - levels
    - origins
    type: object
  models.ValidationErrors:
    additionalProperties:
      type: string
    type: object
  notifications.Level:
    enum:
    - info
    - warning
    - error
    - urgent
    type: string
    x-enum-varnames:
    - LevelInfo
    - LevelWarning
    - LevelError
    - LevelUrgent
  paging.Request:
    properties:
      index:
        type: integer
      size:
        type: integer
    type: object
  paging.Response:
    properties:
      index:
        type: integer
      size:
        type: integer
      totalDisplayableResults:
        type: integer
      totalResults:
        type: integer
    required:
    - index
    - size
    - totalDisplayableResults
    type: object
  query.FilterOption:
    properties:
      control:
        $ref: '#/definitions/filter.RequestOptionType'
      multiSelect:
        type: boolean
      name:
        $ref: '#/definitions/filter.ReadableValue-string'
      operators:
        items:
          properties:
            label:
              description: Label is the human-readable form of the value
              type: string
            value:
              allOf:
              - $ref: '#/definitions/filter.CompareOperator'
              description: Value is the value for the backend
          type: object
        type: array
      values:
        items:
          type: string
        type: array
    required:
    - control
    - multiSelect
    - name
    - operators
    type: object
  query.Metadata:
    properties:
      filter:
        $ref: '#/definitions/filter.Request'
      paging:
        $ref: '#/definitions/paging.Response'
      sorting:
        $ref: '#/definitions/sorting.Request'
    type: object
  query.ResponseListWithMetadata-models_Notification:
    properties:
      data:
        items:
          $ref: '#/definitions/models.Notification'
        type: array
      metadata:
        $ref: '#/definitions/query.Metadata'
    required:
    - data
    - metadata
    type: object
  query.ResponseWithMetadata-array_query_FilterOption:
    properties:
      data:
        items:
          $ref: '#/definitions/query.FilterOption'
        type: array
      metadata:
        $ref: '#/definitions/query.Metadata'
    required:
    - data
    - metadata
    type: object
  query.ResponseWithMetadata-models_Notification:
    properties:
      data:
        $ref: '#/definitions/models.Notification'
      metadata:
        $ref: '#/definitions/query.Metadata'
    required:
    - data
    - metadata
    type: object
  query.ResultSelector:
    properties:
      filter:
        $ref: '#/definitions/filter.Request'
      paging:
        $ref: '#/definitions/paging.Request'
      sorting:
        $ref: '#/definitions/sorting.Request'
    type: object
  sorting.Request:
    properties:
      column:
        type: string
      direction:
        $ref: '#/definitions/sorting.SortDirection'
    type: object
  sorting.SortDirection:
    enum:
    - desc
    - asc
    - ""
    type: string
    x-enum-varnames:
    - DirectionDescending
    - DirectionAscending
    - NoDirection
  teamsdto.TeamsNotificationChannelRequest:
    properties:
      channelName:
        type: string
      description:
        type: string
      webhookUrl:
        type: string
    type: object
externalDocs:
  description: OpenAPI
  url: https://swagger.io/resources/open-api/
info:
  contact: {}
  description: HTTP API of the Notification service
  license:
    name: AGPL-3.0-or-later
  title: Notification Service API
  version: "1.0"
paths:
  /notification-channel/mail:
    get:
      description: List mail notification channels by type
      parameters:
      - description: Channel type
        in: query
        name: type
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/maildto.MailNotificationChannelRequest'
            type: array
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: List Mail Channels
      tags:
      - mail-channel
    post:
      consumes:
      - application/json
      description: Create a new mail notification channel
      parameters:
      - description: Mail channel to add
        in: body
        name: MailChannel
        required: true
        schema:
          $ref: '#/definitions/maildto.MailNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/maildto.MailNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Create Mail Channel
      tags:
      - mail-channel
  /notification-channel/mail/{id}:
    delete:
      description: Delete a mail notification channel
      parameters:
      - description: Mail channel ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: Deleted successfully
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Delete Mail Channel
      tags:
      - mail-channel
    put:
      consumes:
      - application/json
      description: Update an existing mail notification channel
      parameters:
      - description: Mail channel ID
        in: path
        name: id
        required: true
        type: string
      - description: Mail channel to update
        in: body
        name: MailChannel
        required: true
        schema:
          $ref: '#/definitions/maildto.MailNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/maildto.MailNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Update Mail Channel
      tags:
      - mail-channel
  /notification-channel/mail/{id}/check:
    post:
      consumes:
      - application/json
      description: Check if a mail server is reachable
      parameters:
      - description: Mail server to check
        in: body
        name: MailServerConfig
        required: true
        schema:
          $ref: '#/definitions/maildto.CheckMailServerEntityRequest'
      produces:
      - application/json
      responses:
        "204":
          description: Mail server reachable
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "422":
          description: Mail server error
      security:
      - KeycloakAuth: []
      summary: Check mail server
      tags:
      - mail-channel
  /notification-channel/mail/check:
    post:
      consumes:
      - application/json
      description: Check if a mail server is reachable
      parameters:
      - description: Mail server to check
        in: body
        name: MailServerConfig
        required: true
        schema:
          $ref: '#/definitions/maildto.CheckMailServerRequest'
      produces:
      - application/json
      responses:
        "204":
          description: Mail server reachable
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "422":
          description: Mail server error
      security:
      - KeycloakAuth: []
      summary: Check mail server
      tags:
      - mail-channel
  /notification-channel/mattermost:
    get:
      description: List mattermost notification channels
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/mattermostdto.MattermostNotificationChannelRequest'
            type: array
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: List Mattermost Channels
      tags:
      - mattermost-channel
    post:
      consumes:
      - application/json
      description: Create a new mattermost notification channel
      parameters:
      - description: Mattermost channel to add
        in: body
        name: MattermostChannel
        required: true
        schema:
          $ref: '#/definitions/mattermostdto.MattermostNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/mattermostdto.MattermostNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Create Mattermost Channel
      tags:
      - mattermost-channel
  /notification-channel/mattermost/{id}:
    delete:
      description: Delete a mattermost notification channel
      parameters:
      - description: Mattermost channel ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: Deleted successfully
        "404":
          description: Not Found
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Delete Mattermost Channel
      tags:
      - mattermost-channel
    put:
      consumes:
      - application/json
      description: Update an existing mattermost notification channel
      parameters:
      - description: Mattermost channel ID
        in: path
        name: id
        required: true
        type: string
      - description: Mattermost channel to update
        in: body
        name: MattermostChannel
        required: true
        schema:
          $ref: '#/definitions/mattermostdto.MattermostNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mattermostdto.MattermostNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "404":
          description: Not Found
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Update Mattermost Channel
      tags:
      - mattermost-channel
  /notification-channel/mattermost/check:
    post:
      consumes:
      - application/json
      description: Check if a mattermost server is able to send a test message
      produces:
      - application/json
      responses:
        "204":
          description: Mattermost server test message sent successfully
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Check mattermost server
      tags:
      - mattermost-channel
  /notification-channel/teams:
    get:
      description: List teams notification channels by type
      parameters:
      - description: Channel type
        in: query
        name: type
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/teamsdto.TeamsNotificationChannelRequest'
            type: array
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: List Teams Channels
      tags:
      - teams-channel
    post:
      consumes:
      - application/json
      description: Create a new teams notification channel
      parameters:
      - description: Teams channel to add
        in: body
        name: TeamsChannel
        required: true
        schema:
          $ref: '#/definitions/teamsdto.TeamsNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/teamsdto.TeamsNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Create Teams Channel
      tags:
      - teams-channel
  /notification-channel/teams/{id}:
    delete:
      description: Delete a teams notification channel
      parameters:
      - description: Teams channel ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: Deleted successfully
        "404":
          description: Not Found
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Delete Teams Channel
      tags:
      - teams-channel
    put:
      consumes:
      - application/json
      description: Update an existing teams notification channel
      parameters:
      - description: Teams channel ID
        in: path
        name: id
        required: true
        type: string
      - description: Teams channel to update
        in: body
        name: TeamsChannel
        required: true
        schema:
          $ref: '#/definitions/teamsdto.TeamsNotificationChannelRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/teamsdto.TeamsNotificationChannelRequest'
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
        "404":
          description: Not Found
          schema:
            additionalProperties:
              type: string
            type: object
        "500":
          description: Internal Server Error
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Update Teams Channel
      tags:
      - teams-channel
  /notification-channel/teams/check:
    post:
      consumes:
      - application/json
      description: Check if a Teams server is able to send a test message
      parameters:
      - description: Teams channel ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: Teams server test message sent successfully
        "400":
          description: Bad Request
          schema:
            additionalProperties:
              type: string
            type: object
      security:
      - KeycloakAuth: []
      summary: Check Teams server
      tags:
      - teams-channel
  /notifications:
    post:
      consumes:
      - application/json
      description: Create a new notification. It will always be stored by the notification
        service and it will possibly also trigger actions like sending mails, depending
        on the cofigured rules.
      parameters:
      - description: notification to add
        in: body
        name: Notification
        required: true
        schema:
          $ref: '#/definitions/models.Notification'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/query.ResponseWithMetadata-models_Notification'
      security:
      - KeycloakAuth: []
      summary: Create Notification
      tags:
      - notification
    put:
      consumes:
      - application/json
      description: Returns a list of notifications matching the provided filters
      parameters:
      - description: filters, paging and sorting
        in: body
        name: MatchCriterias
        required: true
        schema:
          $ref: '#/definitions/query.ResultSelector'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/query.ResponseListWithMetadata-models_Notification'
      security:
      - KeycloakAuth: []
      summary: List Notifications
      tags:
      - notification
  /notifications/options:
    get:
      description: Get filter options for listing notifications
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/query.ResponseWithMetadata-array_query_FilterOption'
      security:
      - KeycloakAuth: []
      summary: Notification filter options
      tags:
      - notification
  /origins/{serviceID}:
    put:
      consumes:
      - application/json
      description: Registers a set of origins in the given service. Replaces origins
        of this service if they already existed. The origins can be ulitized to set
        trigger conditions for actions.
      parameters:
      - description: serviceID of the calling service, needs to be unique among all
          services registering origins
        in: path
        name: serviceID
        required: true
        type: string
      - description: origins provided by the calling service
        in: body
        name: origins
        required: true
        schema:
          items:
            $ref: '#/definitions/models.Origin'
          type: array
      produces:
      - application/json
      responses:
        "204":
          description: origins registered
          headers:
            api-version:
              description: API version
              type: string
        "400":
          description: Bad Request
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
        "500":
          description: Internal Server Error
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
      security:
      - KeycloakAuth: []
      summary: Register Origins
      tags:
      - origin
  /rules:
    get:
      consumes:
      - application/json
      description: Returns a list of rules matching the provided filters.
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            items:
              $ref: '#/definitions/models.Rule'
            type: array
      security:
      - KeycloakAuth: []
      summary: List Rules
      tags:
      - rule
    post:
      consumes:
      - application/json
      description: Create a new rule. A rule determines on which conditions which
        action is triggered.
      parameters:
      - description: new rule
        in: body
        name: rule
        required: true
        schema:
          $ref: '#/definitions/models.Rule'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/models.Rule'
        "400":
          description: Bad Request
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
        "422":
          description: Unprocessable Entity
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
      security:
      - KeycloakAuth: []
      summary: Create Rule
      tags:
      - rule
  /rules/{id}:
    delete:
      description: Delete a rule.
      parameters:
      - description: unique ID of the rule
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: deleted
          headers:
            api-version:
              description: API version
              type: string
        "400":
          description: invalid id
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
      security:
      - KeycloakAuth: []
      summary: Delete Rule
      tags:
      - rule
    put:
      consumes:
      - application/json
      description: Update/replace a rule.
      parameters:
      - description: unique ID of the rule
        in: path
        name: id
        required: true
        type: string
      - description: updated rule
        in: body
        name: rule
        required: true
        schema:
          $ref: '#/definitions/models.Rule'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/models.Rule'
        "400":
          description: Bad Request
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
        "404":
          description: Not Found
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
      security:
      - KeycloakAuth: []
      summary: Update Rule
      tags:
      - rule
  /rules/ruleoptions:
    get:
      consumes:
      - application/json
      description: Returns all required options to create a new notification
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/models.RuleOptions'
      security:
      - KeycloakAuth: []
      summary: Options to create a new notification
      tags:
      - rule
  /rulse/{id}:
    get:
      description: Returns the rule
      parameters:
      - description: unique id of the rule
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/models.Rule'
        "400":
          description: invalid id
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
        "404":
          description: Not Found
          headers:
            api-version:
              description: API version
              type: string
          schema:
            $ref: '#/definitions/errorResponses.ErrorResponse'
      security:
      - KeycloakAuth: []
      summary: Get a rule by id
      tags:
      - rule
securityDefinitions:
  KeycloakAuth:
    authorizationUrl: '{{.KeycloakAuthUrl}}/realms/{{.KeycloakRealm}}/protocol/openid-connect/auth'
    flow: implicit
    type: oauth2
swagger: "2.0"