README.md

FIT-Connect API-Spezifikation

Für die Spezifikation der FIT-Connect-Schnittstellen gelten die folgenden Architekturregeln.

OpenAPI

• Wir verwenden OpenAPI 3.0
• Die Spezifikation ist als YAML geschrieben
• Wir verwenden keine Versionsnummern in Dateinamen, da das Repo als Ganzes versioniert wird
• Die Spezifikation wird mit Semantic-Versioning versioniert

Bezeichner

• Die Bezeichner werden camelCase geschrieben und beginnen mit einem Kleinbuchstaben
• Eine ID (Identifikator) wird als Id nicht ID geschrieben

Pfade

Multiple Ressourcen werden im Pfad durch eine Collection-Resource und einer nachfolgenden ID aufgenommen

Beispiel: /v1/submissions/{submissionId}

Tag API version

Run and follow the instructions:

sh tag.sh