Vorschlag zu Naming Conventions FIR/OpenApi. Bei Konsens bzw. Entscheidung kann diese Seite ggf. in den Dokumentationsbereich verschoben werden.
Richtlinien
- Wir verwenden Camel case.´
- Oder eine an den Anwendungsfall angepasste Variante (Snake-, Title-, Pascal-, Kebab-case)
- Wir vermeiden bestimmte Anti-Pattern bei der Verwendung von Abkürzungen und Akronymen sowie ausschließliche Groß-/Kleinschreibung.
Was Wie Wo
[Entity] schema
Zur Definition von Entity (Model-Klassen) verwenden wir Pascal case.
Examples: TroubleTicket, QueryServiceQualification, CustomerBill
[Entity] Attributes
Zur definition von Entity Attributes ((Model-Properties)) verwenden wir Camel case.
Beispiel: givenName, familyName, homeId, numberOfVlans
Characteristics (Key/Value)
Zur Definition von Characteristics verwenden wir Snake case.
Beispiel: number_of_vlans, access_mode
Das Dient
- der besseren Unterscheidbarkeit (von Pascal/Camel case)
- der Vermeidung von Leerzeichen
URL-Pfade
TMF-630: Names in URI (tasks, individual resources, etc.) MUST be camel case or lowercase.
Beispiel: https://serverRoot/tmf-api/productOrdering/v4
Enumerations
Zur Definition von Enumerations verwenden wir Camel case.
Beispiel: pending, held, inProgress
Discriminator
Discriminator Werte sind identisch mit dem Namen der Entity (Pascal case).
Module (Git Repos, Datei-Archive, Artifact-Ids, ...)
Modul Bezeichner verwenden Kebab-case.
Beispiel: tmf622-product-order, tmf622-product-order-1.0.0.zip
Anti-Pattern
Die Vermeidung der aufgeführten Anti-Pattern sorgt dafür, das eine verlustfreie Transformation von einem in das andere Format möglich ist. Das ist insbesondere wichtig für Code Generatoren und andere Tools.
Beispiele:
NumberOfVLANsOpenAPINUMBEROFVLANSnumberofvlans