openapi: 3.2.0
info:
  title: Vng Realisatie Bestandsdelen API
  version: 1.5.0
  contact:
    email: standaarden.ondersteuning@vng.nl
    url: https://vng-realisatie.github.io/gemma-zaken
  license:
    name: EUPL 1.2
    url: https://opensource.org/licenses/EUPL-1.2
  description: 'Operations tagged bestandsdelen across 2 of this provider''s published API definitions: vng-realisatie-documenten-openapi.yml, vng-realisatie-documenten-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://documenten-api.vng.cloud/api/v1
  description: Productie Omgeving
tags:
- name: bestandsdelen
paths:
  /bestandsdelen/{uuid}:
    put:
      operationId: bestandsdeel_update
      description: based on DRF mixin but without partial_update
      summary: Upload een bestandsdeel
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      - in: header
        name: Content-Type
        schema:
          type: string
          enum:
          - application/x-www-form-urlencoded
          - multipart/form-data
        description: Content type van de verzoekinhoud.
        required: true
      tags:
      - bestandsdelen
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BestandsDeelRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BestandsDeelRequest'
        required: true
      security:
      - JWT-Claims:
        - documenten.bijwerken
      responses:
        '200':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestandsDeelResponse'
          description: OK
        '400':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidatieFout'
          description: Bad request
        '401':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Unauthorized
        '403':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Forbidden
        '404':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Not found
        '406':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Not acceptable
        '409':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Conflict
        '410':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Gone
        '415':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Unsupported media type
        '429':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Too many requests
        '500':
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Fout'
          description: Internal server error
    servers:
    - url: https://documenten-api.vng.cloud/api/v1
      description: Productie Omgeving
components:
  schemas:
    FieldValidationError:
      type: object
      description: Formaat van validatiefouten.
      properties:
        name:
          type: string
          description: Naam van het veld met ongeldige gegevens
          title: name
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
          title: code
        reason:
          type: string
          description: Uitleg wat er precies fout is met de gegevens
          title: reason
      required:
      - code
      - name
      - reason
    BestandsDeelRequest:
      type: object
      properties:
        inhoud:
          type: string
          format: binary
          writeOnly: true
          description: De (binaire) bestandsinhoud van dit specifieke bestandsdeel.
          title: inhoud
        lock:
          type: string
          minLength: 1
          description: Hash string, which represents id of the lock of related informatieobject
          title: lock
      required:
      - lock
    BestandsDeelResponse:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          title: url
          description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
          minLength: 1
          maxLength: 1000
        lock:
          type: string
          description: Hash string, which represents id of the lock of related informatieobject
          title: lock
        omvang:
          type: integer
          description: De grootte van dit specifieke bestandsdeel.
          title: omvang
        inhoud:
          type: string
          format: uri
          description: De URL naar de bestandsinhoud van dit specifieke bestandsdeel.
          title: inhoud
        voltooid:
          type: boolean
          description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.'
          title: voltooid
        volgnummer:
          type: integer
          description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft.
          title: volgnummer
      required:
      - lock
      - url
    Fout:
      type: object
      description: Formaat van HTTP 4xx en 5xx fouten.
      properties:
        type:
          type: string
          description: URI referentie naar het type fout, bedoeld voor developers
          title: type
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
          title: code
        title:
          type: string
          description: Generieke titel voor het type fout
          title: title
        status:
          type: integer
          description: De HTTP status code
          title: status
        detail:
          type: string
          description: Extra informatie bij de fout, indien beschikbaar
          title: detail
        instance:
          type: string
          description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
          title: instance
      required:
      - code
      - detail
      - instance
      - status
      - title
    ValidatieFout:
      type: object
      description: Formaat van HTTP 4xx en 5xx fouten.
      properties:
        type:
          type: string
          description: URI referentie naar het type fout, bedoeld voor developers
          title: type
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
          title: code
        title:
          type: string
          description: Generieke titel voor het type fout
          title: title
        status:
          type: integer
          description: De HTTP status code
          title: status
        detail:
          type: string
          description: Extra informatie bij de fout, indien beschikbaar
          title: detail
        instance:
          type: string
          description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
          title: instance
        invalidParams:
          type: array
          items:
            $ref: '#/components/schemas/FieldValidationError'
          title: invalidParams
      required:
      - code
      - detail
      - instance
      - invalidParams
      - status
      - title
  securitySchemes:
    JWT-Claims:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-refined-from:
- vng-realisatie-documenten-openapi.yml
- vng-realisatie-documenten-openapi.yml