components:
  parameters:
    OIN:
      description: Het OIN van het bevoegd gezag.
      in: path
      name: oin
      required: true
      schema:
        pattern: ^\d{20}$
        type: string
  schemas:
    "401":
      allOf:
      - properties:
          instance:
            type: string
          status:
            format: int64
            type: integer
          title:
            type: string
          type:
            type: string
        required:
        - type
        - title
        - status
      example:
        detail: U bent niet geautoriseerd voor deze configuratie.
        instance: 539f14d69f2fba81
        status: 401
        title: Authenticatiegegevens ontbreken of zijn onjuist.
        type: https://content.omgevingswet.overheid.nl/id/concept/Ongeautoriseerd
      properties:
        detail:
          type: string
    "404":
      allOf:
      - properties:
          instance:
            type: string
          status:
            format: int64
            type: integer
          title:
            type: string
          type:
            type: string
        required:
        - type
        - title
        - status
      example:
        detail: Ideeverkenningconfiguratie niet gevonden.
        instance: 539f14d69f2fba81
        status: 404
        title: Niet gevonden.
        type: https://content.omgevingswet.overheid.nl/id/concept/BestaatNiet
      properties:
        detail:
          type: string
    "500":
      allOf:
      - properties:
          instance:
            type: string
          status:
            format: int64
            type: integer
          title:
            type: string
          type:
            type: string
        required:
        - type
        - title
        - status
      example:
        detail: Er is iets mis gegaan.
        instance: 539f14d69f2fba81
        status: 500
        title: Interne serverfout
        type: https://content.omgevingswet.overheid.nl/id/concept/ServerFout
      properties:
        detail:
          type: string
    Fout:
      properties:
        instance:
          type: string
        status:
          format: int64
          type: integer
        title:
          type: string
        type:
          type: string
      required:
      - type
      - title
      - status
    Health:
      description: Health
      example:
        groups:
        - downstreamServices
        - self
        status: UP
      properties:
        groups:
          items:
            type: string
          type: array
        status:
          enum:
          - UP
          - DOWN
          - OUT_OF_SERVICE
          type: string
    IdeeVerkenningConfiguratie:
      properties:
        oin:
          description: het OIN van het bevoegd gezag
          pattern: ^\d{20}$
          type: string
        toegestaan:
          description: true als ideeverkenning is toegestaan, anders false
          type: boolean
        toelichting:
          description: De toelichting welke in het omgevingsloket getoond kan worden,
            in MarkDown.
          maxLength: 6144
          minLength: 1
          type: string
      required:
      - oin
      - toegestaan
      - toelichting
    Info:
      description: Info
      example:
        name: Verzoekconfiguratie-Beheren
        stamVersion:
        - "5"
        - "6"
        version: 1.1.0
      properties:
        name:
          type: string
        stamVersion:
          items:
            type: string
          type: array
        version:
          type: string
      required:
      - name
      - version
      - stamVersion
    InvalidParams:
      properties:
        name:
          type: string
        reason:
          type: string
        type:
          type: string
      required:
      - type
      - name
      - reason
    NotificatieversieConfiguratie:
      properties:
        oin:
          description: het OIN van het bevoegd gezag
          pattern: ^\d{20}$
          type: string
        versie:
          description: de notificatieversie die wordt ondersteund.
          example: 6
          pattern: ^\d{1,5}$
          type: string
      required:
      - oin
      - versie
      type: object
    ValidatieFout:
      allOf:
      - properties:
          instance:
            type: string
          status:
            format: int64
            type: integer
          title:
            type: string
          type:
            type: string
        required:
        - type
        - title
        - status
      example:
        invalid-params:
        - name: exampleField
          reason: example reason
          type: https://content.omgevingswet.overheid.nl/id/concept/validatie/Verplicht
        status: 400
        title: Validatie mislukt
        type: https://content.omgevingswet.overheid.nl/id/concept/ValidatieMislukt
      properties:
        invalid-params:
          items:
            properties:
              name:
                type: string
              reason:
                type: string
              type:
                type: string
            required:
            - type
            - name
            - reason
          type: array
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
info:
  contact:
    name: DSO Ontwikkelaarsportaal
    url: https://developer.omgevingswet.overheid.nl/services/contact/
  description: Services voor het beheren van ideeverkenningconfiguraties en notificatieversieconfiguraties.
  license:
    name: DSO Copyright
    url: https://developer.omgevingswet.overheid.nl/site/copyright/
  title: Verzoekconfiguratie-Beheren
  version: 1.0.7
openapi: 3.0.3
paths:
  /:
    get:
      operationId: specification
      responses:
        "200":
          content:
            application/json:
              schema:
                example: '{"openapi": "3.0.3", ... }'
          description: OpenApi Specification Json
      security: []
      summary: OpenApi Specification
      tags:
      - Meta
  /app-health:
    get:
      operationId: app-health
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Health
                example:
                  groups:
                  - downstreamServices
                  - self
                  status: UP
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
          description: Health
        "503":
          content:
            application/json:
              schema:
                description: Health
                example:
                  groups:
                  - downstreamServices
                  - self
                  status: UP
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
          description: Health
      security: []
      summary: health info endpoint heeft een voorkeur boven de /health endpoint.
      tags:
      - Meta
  /app-info:
    get:
      operationId: app-info
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Info
                example:
                  name: Verzoekconfiguratie-Beheren
                  stamVersion:
                  - "5"
                  - "6"
                  version: 1.1.0
                properties:
                  name:
                    type: string
                  stamVersion:
                    items:
                      type: string
                    type: array
                  version:
                    type: string
                required:
                - name
                - version
                - stamVersion
          description: Info
      security: []
      summary: applicatie info endpoint heeft een voorkeur boven de /info endpoint.
      tags:
      - Meta
  /health:
    get:
      operationId: health
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Health
                example:
                  groups:
                  - downstreamServices
                  - self
                  status: UP
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
          description: Health
        "503":
          content:
            application/json:
              schema:
                description: Health
                example:
                  groups:
                  - downstreamServices
                  - self
                  status: UP
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
          description: Health
      security: []
      summary: Deprecated health info, gebruik /app-health.
      tags:
      - Meta
  /ideeverkenningConfiguraties/{oin}:
    put:
      description: Deze service creëert / wijzigt een ideeverkenningconfiguratie.
      operationId: ideeverkenningConfiguratiePost
      parameters:
      - description: Het OIN van het bevoegd gezag.
        in: path
        name: oin
        required: true
        schema:
          pattern: ^\d{20}$
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                oin:
                  description: het OIN van het bevoegd gezag
                  pattern: ^\d{20}$
                  type: string
                toegestaan:
                  description: true als ideeverkenning is toegestaan, anders false
                  type: boolean
                toelichting:
                  description: De toelichting welke in het omgevingsloket getoond
                    kan worden, in MarkDown.
                  maxLength: 6144
                  minLength: 1
                  type: string
              required:
              - oin
              - toegestaan
              - toelichting
        description: De ideeverkenningconfiguratie
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  oin:
                    description: het OIN van het bevoegd gezag
                    pattern: ^\d{20}$
                    type: string
                  toegestaan:
                    description: true als ideeverkenning is toegestaan, anders false
                    type: boolean
                  toelichting:
                    description: De toelichting welke in het omgevingsloket getoond
                      kan worden, in MarkDown.
                    maxLength: 6144
                    minLength: 1
                    type: string
                required:
                - oin
                - toegestaan
                - toelichting
          description: De ideeverkenningconfiguratie
        "400":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  invalid-params:
                  - name: exampleField
                    reason: example reason
                    type: https://content.omgevingswet.overheid.nl/id/concept/validatie/Verplicht
                  status: 400
                  title: Validatie mislukt
                  type: https://content.omgevingswet.overheid.nl/id/concept/ValidatieMislukt
                properties:
                  invalid-params:
                    items:
                      properties:
                        name:
                          type: string
                        reason:
                          type: string
                        type:
                          type: string
                      required:
                      - type
                      - name
                      - reason
                    type: array
          description: Validatiefout
        "401":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  detail: U bent niet geautoriseerd voor deze configuratie.
                  instance: 539f14d69f2fba81
                  status: 401
                  title: Authenticatiegegevens ontbreken of zijn onjuist.
                  type: https://content.omgevingswet.overheid.nl/id/concept/Ongeautoriseerd
                properties:
                  detail:
                    type: string
          description: Gebruiker heeft geen toestemming om deze actie uit te voeren.
        "500":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  detail: Er is iets mis gegaan.
                  instance: 539f14d69f2fba81
                  status: 500
                  title: Interne serverfout
                  type: https://content.omgevingswet.overheid.nl/id/concept/ServerFout
                properties:
                  detail:
                    type: string
          description: Interne serverfout
      summary: Creëren / wijzigen ideeverkenningconfiguratie.
  /info:
    get:
      operationId: info
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Info
                example:
                  name: Verzoekconfiguratie-Beheren
                  stamVersion:
                  - "5"
                  - "6"
                  version: 1.1.0
                properties:
                  name:
                    type: string
                  stamVersion:
                    items:
                      type: string
                    type: array
                  version:
                    type: string
                required:
                - name
                - version
                - stamVersion
          description: Info
      security: []
      summary: Deprecated applicatie info, gebruik /app-info.
      tags:
      - Meta
  /notificatieversieConfiguraties/{oin}:
    put:
      description: Deze service creëert / wijzigt een notificatieversieconfiguratie.
      operationId: notificatieversieConfiguratiePost
      parameters:
      - description: Het OIN van het bevoegd gezag.
        in: path
        name: oin
        required: true
        schema:
          pattern: ^\d{20}$
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                oin:
                  description: het OIN van het bevoegd gezag
                  pattern: ^\d{20}$
                  type: string
                versie:
                  description: de notificatieversie die wordt ondersteund.
                  example: 6
                  pattern: ^\d{1,5}$
                  type: string
              required:
              - oin
              - versie
              type: object
        description: De notificatieversieconfiguratie
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  oin:
                    description: het OIN van het bevoegd gezag
                    pattern: ^\d{20}$
                    type: string
                  versie:
                    description: de notificatieversie die wordt ondersteund.
                    example: 6
                    pattern: ^\d{1,5}$
                    type: string
                required:
                - oin
                - versie
                type: object
          description: De notificatieversieconfiguratie
        "400":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  invalid-params:
                  - name: exampleField
                    reason: example reason
                    type: https://content.omgevingswet.overheid.nl/id/concept/validatie/Verplicht
                  status: 400
                  title: Validatie mislukt
                  type: https://content.omgevingswet.overheid.nl/id/concept/ValidatieMislukt
                properties:
                  invalid-params:
                    items:
                      properties:
                        name:
                          type: string
                        reason:
                          type: string
                        type:
                          type: string
                      required:
                      - type
                      - name
                      - reason
                    type: array
          description: |-
            Validatiefout. Mogelijk foutsituaties:
              - Opgegeven versie is onjuist. Alleen de volgende versies zijn toegestaan...
              - De organisatie waarvoor u deze actie wilt uitvoeren accepteert ideeverkenning. Dit is alleen mogelijke met notificatieversie 5 of hoger.
              - https://content.omgevingswet.overheid.nl/id/concept/validatie/Swagger
                - De wijziging voldoet niet aan de swagger specificatie.
        "401":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  detail: U bent niet geautoriseerd voor deze configuratie.
                  instance: 539f14d69f2fba81
                  status: 401
                  title: Authenticatiegegevens ontbreken of zijn onjuist.
                  type: https://content.omgevingswet.overheid.nl/id/concept/Ongeautoriseerd
                properties:
                  detail:
                    type: string
          description: Gebruiker heeft geen toestemming om deze actie uit te voeren.
        "500":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    instance:
                      type: string
                    status:
                      format: int64
                      type: integer
                    title:
                      type: string
                    type:
                      type: string
                  required:
                  - type
                  - title
                  - status
                example:
                  detail: Er is iets mis gegaan.
                  instance: 539f14d69f2fba81
                  status: 500
                  title: Interne serverfout
                  type: https://content.omgevingswet.overheid.nl/id/concept/ServerFout
                properties:
                  detail:
                    type: string
          description: Interne serverfout
      summary: Creëren / wijzigen notificatieversieconfiguratie.
security:
- bearerAuth: []
servers:
- url: /api/beheren/v1
tags:
- description: Verzoekgerelateerde configuraties
  name: Configuratie
