Utrecht University notifications API

openapi: 3.2.0
x-method: searched
x-source-url: https://github.com/UtrechtUniversity/yoda-ruleset/blob/development/tools/api/generate-openapi.py
x-provenance: >-
  Utrecht University's own document. The Yoda OpenAPI is emitted by
  tools/api/generate-openapi.py in github.com/UtrechtUniversity/yoda-ruleset
  ('Copyright (c) 2020-2026, Utrecht University', GPLv3), which walks the ruleset's own
  function signatures and docstrings; --core yields 'Yoda core API' and --module <m> yields
  'Yoda <m> API'. Fetched and then split per tag by refine-openapis; the pristine sources are
  in openapi/_original/. Re-based off the upstream placeholder host portal.yoda.test onto the
  verified production host portal.yoda.uu.nl on 2026-08-30, and the refine title weld
  ('Yoda core admin <X> API' on 19 non-admin outputs) repaired at the same time.
x-generated: '2026-08-30'
info:
  description: >-
    Yoda core ruleset containing iRODS and Python rules and policies useful for all Yoda environments. Yoda is developed and operated by Utrecht University.
  contact:
    email: l.r.westerhof@uu.nl
  version: 2.1.0
  title: Yoda core Notifications API
servers:
- url: https://portal.yoda.uu.nl/api
  description: Utrecht University production Yoda portal (verified live 2026-08-30; API requires an
    authenticated session or a Yoda data access token)
- url: https://i-lab.yoda.uu.nl/api
  description: Utrecht University i-Lab Yoda portal (verified live 2026-08-30)
x-operator: institution
x-placeholder-removed: >-
  The upstream Yoda repository ships servers[] as https://portal.yoda.test/api,
  'Local Yoda development server'. .test is an RFC 2606 reserved TLD and is never a
  surface, so it is dropped from servers[] rather than carried as an unattributable
  host. It is recorded here so a later run does not read its absence as data loss.
x-operator-evidence: >-
  Yoda is authored by Utrecht University (github.com/UtrechtUniversity/yoda-ruleset, GPL-3.0,
  "Copyright (c) Utrecht University") and Utrecht runs its own production instance at
  portal.yoda.uu.nl. info.contact is l.r.westerhof@uu.nl, a uu.nl address. This is the
  institution's own engineering, not a vendor contract running under its name.
security:
- cookieAuth: []
- basicAuth: []
tags:
- name: notifications
paths:
  /notifications_load:
    post:
      tags:
      - notifications
      summary: 'Load user notifications.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sort_order:
                  type: string
                  description: Sort order of notifications on timestamp ("asc" or "desc", default "desc")
                  default: '''desc'''
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /notifications_dismiss:
    post:
      tags:
      - notifications
      summary: 'Dismiss user notification.

        :param identifier: Identifier of notification message'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - identifier
              properties:
                identifier:
                  type: string
                  description: Identifier of notification message
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /notifications_dismiss_all:
    post:
      tags:
      - notifications
      summary: 'Dismiss all user notifications.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
components:
  schemas:
    result_error:
      type: object
      properties:
        status:
          type: string
          description: Holds an error ID
        status_info:
          type: string
          description: Holds a human-readable error description
        data:
          description: empty
          type:
          - object
          - 'null'
  responses:
    status_500:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/result_error'
    status_400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/result_error'
  securitySchemes:
    cookieAuth:
      in: cookie
      type: apiKey
      name: yoda_session
    basicAuth:
      type: http
      scheme: basic