zustelldienst.yml

openapi: 3.0.0
info:
  version: 'API_VERSION'
  title: Einreichungsmanagement API für Antragsverfahren und Berichtspflichten
  description: >
    Die FIT-Connect API ermöglicht Anträge und Berichte, die aus vorgelagerten Systemen (z. B. Onlineantragsdienste, Fachportale
    oder Berichtssysteme) erstellt werden, in die unterschiedlichen Systeme der elektronischen Verfahrensbearbeitung
    (z. B. Fachverfahren, Dokumentenmanagementsystem oder Prozessplattformen) zu übergeben.
  contact:
    name: FITKO
    url: 'https://www.fitko.de/'
  license:
    url: 'https://creativecommons.org/licenses/by-sa/4.0/'
    name: Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)
  termsOfService: https://www.fitko.de/
servers:
  - url: 'https://api.fit-connect.example.org/'
    description: Example server
externalDocs:
  description: API Documentation
  url: https://docs.fitko.de/fit-connect
tags:
  - name: Zustellpunktverwaltung
    description: Unter dieser Gruppe sind alle Endpunkte organisiert, über welche Zustellpunkte verwaltet werden können.
  - name: Einreichungsübermittlung
    description: Diese Gruppe enthält alle Endpunkte, die für das Versenden von Einreichungen an einen Zustellpunkt notwendig sind.
    externalDocs:
      url: https://docs.fitko.de/fit-connect/getting-started/sending/overview
  - name: Einreichungsempfang
    description: Diese Gruppe umfasst alle Endpunkte, die für den Empfang und die Abfrage von Einreichungen notwendig sind.
    externalDocs:
      url: https://docs.fitko.de/fit-connect/getting-started/receiving/overview
  - name: Technisch
    description: Unter dieser Gruppe sind alle Endpunkte organisiert, die technische Informationen über die Instanz des Zustelldienstes liefern.
paths:
  /destinations:
    $ref: './endpoints/destinations/index.yml'

  /destinations/{destinationId}:
    $ref: './endpoints/destinations/uuid.yml'

  /destinations/{destinationId}/keys/{keyId}:
    $ref: './endpoints/destinations/keys/uuid.yml'

  /submissions:
    $ref: './endpoints/submissions/index.yml'

  /submissions/{submissionId}:
    $ref: './endpoints/submissions/uuid.yml'

  /submissions/{submissionId}/events:
    $ref: './endpoints/submissions/events/index.yml'

  /submissions/{submissionId}/attachments/{attachmentId}:
    $ref: './endpoints/attachments/uuid.yml'

  /info:
    $ref: './endpoints/info/get-info.yml'

components:
  securitySchemes:
    OAuth2:
      $ref: './security/oauth2.yml'

  parameters:
    submissionId:
      $ref: './parameters/submissionId.yml'
    destinationId:
      $ref: './parameters/destinationId.yml'
    destinationIdInQuery:
      $ref: './parameters/destinationIdInQuery.yml'
    attachmentId:
      $ref: './parameters/attachmentId.yml'

  schemas:
    AnnouncedContentStructure:
      $ref: './schemas/announced-content-structure.yml'
    Submission:
      $ref: './schemas/submission.yml'
    SubmissionCreated:
      $ref: './schemas/submission-created.yml'
    SubmissionSchema:
      $ref: './schemas/submission-schema.yml'
    Attachment:
      $ref: './schemas/attachment.yml'
    ContactInformation:
      $ref: './schemas/contact-information.yml'
    CreateSubmission:
      $ref: './schemas/create-submission.yml'
    CreateAttachment:
      $ref: './schemas/create-attachment.yml'
    CreateDestination:
      $ref: './schemas/create-destination.yml'
    Destination:
      $ref: './schemas/destination-any.yml'
    PrivateDestination:
      $ref: './schemas/destination-private.yml'
    PublicDestination:
      $ref: './schemas/destination-public.yml'
    DestinationList:
      $ref: './schemas/destination-list.yml'
    DestinationService:
      $ref: './schemas/destination-service.yml'
    EmptyBody:
      $ref: './schemas/empty-body.yml'
    Error:
      $ref: './schemas/error.yml'
    Info:
      $ref: './schemas/info.yml'
    JWK:
      $ref: './schemas/jwk.yml'
    JWKS:
      $ref: './schemas/jwks.yml'
    ListOfSubmissionIds:
      $ref: './schemas/list-of-submission-ids.yml'
    ServiceRegion:
      $ref: './schemas/service-region.yml'
    SubmissionForPickup:
      $ref: './schemas/submission-for-pickup.yml'
    SubmissionsForPickup:
      $ref: './schemas/submissions-for-pickup.yml'
    SubmitSubmission:
      $ref: './schemas/submit-submission.yml'
    UpdateDestination:
      $ref: './schemas/update-destination.yml'
    Version:
      $ref: './schemas/version.yml'
    ServiceType:
      $ref: './schemas/service-type.yml'
    SecurityEventToken:
      $ref: './schemas/security-event-token.yml'
    EventLog:
      $ref: './schemas/event-log.yml'

  examples:
    Submission:
      $ref: './examples/submission.yml'
    SubmissionCreated:
      $ref: './examples/submission-created.yml'
    CreateSubmission:
      $ref: './examples/create-submission.yml'
    CreateDestination:
      $ref: './examples/create-destination.yml'
    Destination:
      $ref: './examples/destination-any.yml'
    PrivateDestination:
      $ref: './examples/destination-private.yml'
    PublicDestination:
      $ref: './examples/destination-public.yml'
    DestinationList:
      $ref: './examples/destination-list.yml'
    EmptyBody:
      $ref: './examples/empty-body.yml'
    EncryptedMessage:
      $ref: './examples/encrypted-message.yml'
    Info:
      $ref: './examples/info.yml'
    JWK:
      $ref: './examples/jwk.yml'