openapi: 3.2.0
info:
  title: Logius Domains API
  version: 0.1.5
  license:
    name: EUPL 1.2
    url: https://opensource.org/licenses/EUPL-1.2
  description: 'Operations tagged domains across 2 of this provider''s published API definitions: logius-notificatieservices-openapi.yml, logius-notificatieservices-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v1
security:
- JWT-Claims: []
tags:
- name: Domains
paths:
  /domains:
    parameters: []
    get:
      operationId: domains_list
      summary: List domains
      description: Returns a list with information about all domains.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Name of the domain.
      responses:
        '200':
          description: OK
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/json:
              schema:
                required:
                - count
                - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    format: uri
                  previous:
                    type: string
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Domain'
        '400':
          description: Bad request
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Not acceptable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '410':
          description: Gone
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Unsupported media type
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: Not Implemented
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Domains
      security:
      - JWT-Claims:
        - (events.publish | events.consume)
    post:
      operationId: domains_post
      summary: Define a domain
      description: Defines a new domain with its basis properties and filter attributes.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Domain'
        required: true
      responses:
        '201':
          description: Created
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
            Location:
              schema:
                type: string
                format: uri
              description: Uri to the created instance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '400':
          description: Bad request
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Not acceptable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '410':
          description: Gone
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Unsupported media type
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: Not Implemented
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Domains
      security:
      - JWT-Claims:
        - events.publish
    servers:
    - url: /api/v1
  /domains/{uuid}:
    get:
      operationId: domains_get
      summary: Request domain info
      description: Returns information about the specified domain.
      parameters:
      - in: path
        name: uuid
        description: Identifier for the domain.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '400':
          description: Bad request
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Not acceptable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '410':
          description: Gone
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '412':
          description: Precondition failed
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Unsupported media type
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: Not Implemented
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          headers:
            API-version:
              schema:
                type: string
              description: 'Version of the API. For example: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Domains
      security:
      - JWT-Claims:
        - (events.publish | events.consume)
    servers:
    - url: /api/v1
components:
  schemas:
    FieldValidationError:
      required:
      - name
      - code
      - reason
      type: object
      properties:
        name:
          title: Name
          description: Naam van het veld met ongeldige gegevens
          type: string
          minLength: 1
        code:
          title: Code
          description: Systeemcode die het type Error aangeeft
          type: string
          minLength: 1
        reason:
          title: Reason
          description: Uitleg wat er precies Error is met de gegevens
          type: string
          minLength: 1
    ValidationError:
      required:
      - code
      - title
      - status
      - detail
      - instance
      - invalidParams
      type: object
      properties:
        type:
          title: Type
          description: URI referentie naar het type Error, bedoeld voor developers
          type: string
        code:
          title: Code
          description: Systeemcode die het type Error aangeeft
          type: string
          minLength: 1
        title:
          title: Title
          description: Generieke titel voor het type Error
          type: string
          minLength: 1
        status:
          title: Status
          description: De HTTP status code
          type: integer
        detail:
          title: Detail
          description: Extra informatie bij de Error, indien beschikbaar
          type: string
          minLength: 1
        instance:
          title: Instance
          description: URI met referentie naar dit specifiek voorkomen van de Error. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
          type: string
          minLength: 1
        invalidParams:
          type: array
          items:
            $ref: '#/components/schemas/FieldValidationError'
    Error:
      required:
      - code
      - title
      - status
      - detail
      - instance
      type: object
      properties:
        type:
          title: Type
          description: URI referentie naar het type Error, bedoeld voor developers
          type: string
        code:
          title: Code
          description: Systeemcode die het type Error aangeeft
          type: string
          minLength: 1
        title:
          title: Title
          description: Generieke titel voor het type Error
          type: string
          minLength: 1
        status:
          title: Status
          description: De HTTP status code
          type: integer
        detail:
          title: Detail
          description: Extra informatie bij de Error, indien beschikbaar
          type: string
          minLength: 1
        instance:
          title: Instance
          description: URI met referentie naar dit specifiek voorkomen van de Error. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
          type: string
          minLength: 1
    Domain:
      required:
      - name
      type: object
      properties:
        url:
          title: URL
          description: URL reference to this resource. This link is generated automatically.
          type: string
          format: uri
          maxLength: 2042
          minLength: 1
          readOnly: true
          example: https://example.com
        uuid:
          title: uuid
          description: Identifier for the domain.
          type: string
          format: uuid
          readOnly: true
          example: 7a22eb38-bca6-463f-9955-54ab040287cb
        name:
          title: name
          description: Name of the domain.
          type: string
          minLength: 1
          example: nl.vng.zgw.zaken
        documentationLink:
          title: documentationLink
          description: Link to human readable information about the domain and its notifications
          type:
          - string
          - 'null'
          format: url
          minLength: 1
          example: https://www.vngrealisatie.nl/ZaakSysteem/Notificaties.html
        filterAttributes:
          title: filterAttributes
          description: Filter attributes offered by the domain.
          type: array
          items:
            type: string
            minLength: 1
  securitySchemes:
    JWT-Claims:
      bearerFormat: JWT
      scheme: bearer
      type: http
x-refined-from:
- logius-notificatieservices-openapi.yml
- logius-notificatieservices-openapi.yml