components:
  parameters:
    sttrType:
      description: De regels worden geverifieerd op basis van het STTR type. Als er
        geen STTR type is meegegeven, dan wordt de standaardwaarde ("toepasbareRegels")
        gebruikt.
      in: query
      name: sttrType
      required: false
      schema:
        enum:
        - toepasbareRegels
        - toepasbareRegelsAansluitpunt
        - toepasbareRegelsStandaardAansluiting
        - toepasbareRegelsLokaleAansluiting
        type: string
    x_api_key:
      description: De api-key ter authenticatie, verkrijgbaar via het ontwikkelaarsportaal
      in: header
      name: x-api-key
      required: false
      schema:
        type: string
  responses:
    "400":
      content:
        application/json:
          schema:
            allOf:
            - properties:
                detail:
                  description: Meer detail informatie over de opgetreden fout
                  type: string
                instance:
                  description: Het unieke instance id van het request dat resulteerde
                    in de foutmelding.
                  type: string
                status:
                  description: De statuscode van de fout (= 400) overeenkomend met
                    de http-status code van de response.
                  format: int64
                  type: integer
                title:
                  description: Informatie over de opgetreden fout.
                  type: string
                type:
                  description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                    of ONVERWACHTE_FOUT.
                  type: string
              required:
              - type
              - title
              - status
            - properties:
                invalid-params:
                  items:
                    properties:
                      name:
                        description: '''Naam van de parameter die een fout bevat,
                          bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                        type: string
                      reason:
                        description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                          mag geen speciale karakters bevatten.'
                        type: string
                      type:
                        description: Een type van de fout, bijvoorbeeld 'Validatie
                          melding'
                        type: string
                    required:
                    - type
                    - name
                    - reason
                  type: array
      description: Fouten (missing parameter; niet bestaande parameter; invalide waarde
        voor parameter)
    "500":
      content:
        application/json:
          schema:
            properties:
              detail:
                description: Meer detail informatie over de opgetreden fout
                type: string
              instance:
                description: Het unieke instance id van het request dat resulteerde
                  in de foutmelding.
                type: string
              status:
                description: De statuscode (= 500) van de fout overeenkomend met de
                  http-status code van de response.
                format: int64
                type: integer
              title:
                description: Informatie over de opgetreden fout.
                type: string
              type:
                description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                  of ONVERWACHTE_FOUT.
                type: string
            required:
            - type
            - title
            - status
      description: Er is een onverwachte technische fout opgetreden
  schemas:
    verifierenResponse:
      properties:
        responseCode:
          description: Verificatie response code
          type: string
        responseMessage:
          description: Verificatie response message
          type: string
        validationMessages:
          description: Verificatie error messages
          items:
            type: string
          type: array
info:
  contact:
    name: Ontwikkelaarsportaal Omgevingswet
    url: https://developer.omgevingswet.overheid.nl/services/contact/
  description: Service voor het verifieren van STTR bestanden. De aangeboden STTR
    inhoud wordt gecontroleerd op XSD, DMN en Schematron. Voor het gebruik van de
    service is een x-api-key nodig.
  title: Regels verifieren service
  version: 2.0.3
openapi: 3.0.0
paths:
  /:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                example: '{"openapi": "3.0.0", ... }'
          description: OpenApi Specification Json
      summary: OpenApi Specification
      tags:
      - Meta
  /health:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    type: string
                required:
                - status
                type: object
          description: Health
        "503":
          content:
            application/json:
              schema:
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
                required:
                - status
                type: object
          description: Health
      summary: health info
      tags:
      - Meta
  /info:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Info
                properties:
                  app:
                    properties:
                      buildtime:
                        type: string
                      name:
                        type: string
                      version:
                        type: string
                      version2:
                        type: string
                    type: object
                required:
                - app
          description: Info
      summary: applicatie info
      tags:
      - Meta
  /verifieren:
    post:
      description: Verifieert een STTR bestand. Als de verificatie niet succesvol
        is wordt een lijst met verificatie fouten geretourneerd.
      parameters:
      - description: De regels worden geverifieerd op basis van het STTR type. Als
          er geen STTR type is meegegeven, dan wordt de standaardwaarde ("toepasbareRegels")
          gebruikt.
        in: query
        name: sttrType
        required: false
        schema:
          enum:
          - toepasbareRegels
          - toepasbareRegelsAansluitpunt
          - toepasbareRegelsStandaardAansluiting
          - toepasbareRegelsLokaleAansluiting
          type: string
      - description: De api-key ter authenticatie, verkrijgbaar via het ontwikkelaarsportaal
        in: header
        name: x-api-key
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/xml:
            schema:
              type: string
        description: Inhoud van het te verifieren STTR bestand
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  responseCode:
                    description: Verificatie response code
                    type: string
                  responseMessage:
                    description: Verificatie response message
                    type: string
                  validationMessages:
                    description: Verificatie error messages
                    items:
                      type: string
                    type: array
          description: Verifieren Response
        "400":
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    detail:
                      description: Meer detail informatie over de opgetreden fout
                      type: string
                    instance:
                      description: Het unieke instance id van het request dat resulteerde
                        in de foutmelding.
                      type: string
                    status:
                      description: De statuscode van de fout (= 400) overeenkomend
                        met de http-status code van de response.
                      format: int64
                      type: integer
                    title:
                      description: Informatie over de opgetreden fout.
                      type: string
                    type:
                      description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                        of ONVERWACHTE_FOUT.
                      type: string
                  required:
                  - type
                  - title
                  - status
                - properties:
                    invalid-params:
                      items:
                        properties:
                          name:
                            description: '''Naam van de parameter die een fout bevat,
                              bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                            type: string
                          reason:
                            description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                              mag geen speciale karakters bevatten.'
                            type: string
                          type:
                            description: Een type van de fout, bijvoorbeeld 'Validatie
                              melding'
                            type: string
                        required:
                        - type
                        - name
                        - reason
                      type: array
          description: Fouten (missing parameter; niet bestaande parameter; invalide
            waarde voor parameter)
        "500":
          content:
            application/json:
              schema:
                properties:
                  detail:
                    description: Meer detail informatie over de opgetreden fout
                    type: string
                  instance:
                    description: Het unieke instance id van het request dat resulteerde
                      in de foutmelding.
                    type: string
                  status:
                    description: De statuscode (= 500) van de fout overeenkomend met
                      de http-status code van de response.
                    format: int64
                    type: integer
                  title:
                    description: Informatie over de opgetreden fout.
                    type: string
                  type:
                    description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                      of ONVERWACHTE_FOUT.
                    type: string
                required:
                - type
                - title
                - status
          description: Er is een onverwachte technische fout opgetreden
      summary: Verifieren STTR file
      tags:
      - Verificatie
x-wso2-cors:
  accessControlAllowCredentials: false
  accessControlAllowHeaders:
  - authorization
  - Access-Control-Allow-Origin
  - Content-Type
  - SOAPAction
  accessControlAllowMethods:
  - GET
  - PUT
  - POST
  - DELETE
  - PATCH
  - OPTIONS
  accessControlAllowOrigins:
  - '*'
  corsConfigurationEnabled: true
