submission-api.yaml

openapi: 3.0.0

info:
  version: 'API_VERSION'
  title: Submission API für Antragsverfahren und Berichtspflichten
  description: >
    Die FIT-Connect Submission API ermöglicht das Einreichen von Anträgen und Berichten aus vorgelagerten Systemen (z. B. Onlineantragsdiensten, Fachportalen oder Berichtssystemen) an die Systeme der Verwaltung zur elektronischen Verfahrensbearbeitung (z. B. Fachverfahren, Dokumentenmanagementsysteme oder Prozessplattformen).
  contact:
    name: FITKO
    url: https://docs.fitko.de/fit-connect/contact
  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://docs.fitko.de/fit-connect/docs/details/terms-of-use-testing/

servers:
  - url: 'https://submission-api-testing.fit-connect.fitko.dev'
    description: "FIT-Connect Testumgebung"

externalDocs:
  description: FIT-Connect-Dokumentationsportal mit Dokumentation zur API-Nutzung
  url: https://docs.fitko.de/fit-connect

tags:
  - name: Zustellpunktverwaltung
    description: >-
      **DEPRECATED**: Die gesamte Gruppe wird durch die Self-Service API ersetzt.


      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/docs/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/docs/getting-started/receiving/overview
  - name: Technisch
    description: Unter dieser Gruppe sind alle Endpunkte organisiert, die technische Informationen über die Instanz des Zustelldienstes liefern.
  - name: Internal
    description: Unter dieser Gruppe werden Endpunkte gelistet, die FIT-Connect intern sind und API-Clients nicht zur Verfügung stehen.
paths:
  /v1/destinations:
    $ref: './endpoints/destinations/index.yaml'

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

  /v1/destinations/{destinationId}/keys:
    $ref: './endpoints/destinations/keys/index.yaml'

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

  /v1/cases/{caseId}/events:
    $ref: './endpoints/cases/events/index.yaml'

  /v1/submissions:
    $ref: './endpoints/submissions/index.yaml'

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

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

  /v1/info:
    $ref: './endpoints/info/get-info.yaml'

  /.well-known/jwks.json:
    $ref: './endpoints/well-known/jwks.json/index.yaml'

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

  parameters:
    submissionId:
      $ref: './parameters/submissionId.yaml'
    destinationId:
      $ref: './parameters/destinationId.yaml'
    destinationIdInQuery:
      $ref: './parameters/destinationIdInQuery.yaml'
    attachmentId:
      $ref: './parameters/attachmentId.yaml'
    limit:
      $ref: './parameters/pagination/limit.yaml'
    offset:
      $ref: './parameters/pagination/offset.yaml'

    # Callback Headers need to be defined in the parameters section of a callback which requires
    # an 'in' key that is incompatible with the headers section here where it is disallowed. Solution:
    # define them here in the parameteters with 'in' key
    Callback-Authentication:
      $ref: './headers/hmac-cb-authentication.yaml'
    Callback-Timestamp:
      $ref: './headers/hmac-cb-timestamp.yaml'

  schemas:
    Submission:
      $ref: './schemas/submission.yaml'
    SubmissionReduced:
      $ref: './schemas/submission-reduced.yaml'
    SubmissionCreated:
      $ref: './schemas/submission-created.yaml'
    SubmissionSchema:
      $ref: './schemas/submission-schema.yaml'
    Attachment:
      $ref: './schemas/attachment.yaml'
    ContactInformation:
      $ref: './schemas/contact-information.yaml'
    CreateSubmission:
      $ref: './schemas/create-submission.yaml'
    CreateAttachment:
      $ref: './schemas/create-attachment.yaml'
    CreateDestination:
      $ref: './schemas/create-destination.yaml'
    Destination:
      $ref: './schemas/destination-any.yaml'
    PrivateDestination:
      $ref: './schemas/destination-private.yaml'
    PublicDestination:
      $ref: './schemas/destination-public.yaml'
    DestinationList:
      $ref: './schemas/destination-list.yaml'
    DestinationService:
      $ref: './schemas/destination-service.yaml'
    Error:
      $ref: './schemas/error.yaml'
    Info:
      $ref: './schemas/info.yaml'
    JWK:
      $ref: './schemas/jwk.yaml'
    JWKS:
      $ref: './schemas/jwks.yaml'
    CallbackNewSubmissions:
      $ref: './schemas/callback-new-submissions.yaml'
    CallbackNewEvents:
      $ref: './schemas/callback-new-events.yaml'
    PatchDestination:
      $ref: './schemas/patch-destination.yaml'
    ServiceRegion:
      $ref: './schemas/service-region.yaml'
    SubmissionForPickup:
      $ref: './schemas/submission-for-pickup.yaml'
    SubmissionForNewEvents:
      $ref: './schemas/submission-for-new-events.yaml'
    SubmissionsForPickup:
      $ref: './schemas/submissions-for-pickup.yaml'
    SubmitSubmission:
      $ref: './schemas/submit-submission.yaml'
    UpdateDestination:
      $ref: './schemas/update-destination.yaml'
    Version:
      $ref: './schemas/version.yaml'
    ServiceType:
      $ref: './schemas/service-type-get.yaml'
    SecurityEventToken:
      $ref: './schemas/security-event-token.yaml'
    EventLog:
      $ref: './schemas/event-log.yaml'
    ReplyChannel:
      $ref: './schemas/reply-channels.yaml'
    Callback:
      $ref: './schemas/callback-url.yaml'
    SupportedMetadataVersions:
      $ref: './schemas/supported-metadata-versions.yaml'
    CreateCallback:
      $ref: './schemas/create-callback.yaml'

  examples:
    Submission:
      $ref: './examples/submission.yaml'
    SubmissionCreated:
      $ref: './examples/submission-created.yaml'
    CreateSubmission:
      $ref: './examples/create-submission.yaml'
    CreateDestination:
      $ref: './examples/create-destination.yaml'
    Destination:
      $ref: './examples/destination-any.yaml'
    PrivateDestination:
      $ref: './examples/destination-private.yaml'
    PublicDestination:
      $ref: './examples/destination-public.yaml'
    DestinationList:
      $ref: './examples/destination-list.yaml'
    EncryptedMessage:
      $ref: './examples/encrypted-message.yaml'
    Info:
      $ref: './examples/info.yaml'
    JWKVerify:
      $ref: './examples/jwk-verify.yaml'
    JWKWrapKey:
      $ref: './examples/jwk-wrapKey.yaml'
    UpdateDestination:
      $ref: './examples/update-destination.yaml'
    PatchDestinationStatus:
      $ref: './examples/patch-destination-status.yaml'
    PatchDestinationContact:
      $ref: './examples/patch-destination-contact.yaml'

  callbacks:
    NewEvents:
      $ref: './callbacks/new-events.yaml'
    NewSubmissions:
      $ref: './callbacks/new-submissions.yaml'

  headers:
    Cache-Control-No-Cache:
      $ref: './headers/cache-control-no-cache.yaml'