openapi: 3.2.0
info:
  title: Operations Hub Notifications.events API
  version: 0.1.1
  description: ''
servers: []
tags:
- name: notifications.events
paths:
  /api/notifications/v1/events:
    post:
      operationId: announce_notification_event
      summary: Announce Event
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: 'Announce one event from the menu, saying whether it produced an entry.


        ``announced`` is False when the event was already announced, or when it had

        nobody to tag. Both are ordinary outcomes for a caller that retries or that

        reports a milestone whose role has no members yet, so neither is an error.'
      tags:
      - notifications.events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventRequest'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    Error:
      additionalProperties: false
      description: Error response schema.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: Error
      type: object
    EventRequest:
      additionalProperties: false
      description: An event id off the menu in ``EVENTS``, plus that event's parameters.
      properties:
        event:
          title: Event
          type: string
        params:
          default: {}
          title: Params
          type: object
      required:
      - event
      title: EventRequest
      type: object
    ErrorCode:
      description: Error codes for API errors.
      enum:
      - validation
      - server
      - auth
      - unknown
      - external
      - generic
      title: ErrorCode
      type: string
    EventResult:
      additionalProperties: false
      description: '``announced`` is False for an event that produced nothing this time.'
      properties:
        announced:
          title: Announced
          type: boolean
      required:
      - announced
      title: EventResult
      type: object
  securitySchemes:
    APIKeyAuth:
      type: http
      scheme: bearer
    CookieAuth:
      type: apiKey
      in: cookie
      name: opshub_prod_sessionid
    AuthBearer:
      type: http
      scheme: bearer