Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Vorschlag zu Naming Conventions FIR/OpenApi. Bei Konsens bzw. Entscheidung kann diese Seite ggf. in den Dokumentationsbereich verschoben werden.

...

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.

...

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.

negativ Beispiele:

  • NumberOfVLANs
  • OpenAPI
  • NUMBEROFVLANS
  • numberofvlans