Terms & Definitions - Chrimle/openapi-to-java-records-mustache-templates GitHub Wiki
The following is a list of commonly used terms, along with their definition. The purpose is consistency throughout the project.
[!TIP] Inconsistencies may still appear, please inform about it.
| Terms | Context | Definition |
|---|---|---|
| Configuration | Maven pom.xml-file |
The <configuration> tag under openapi-generator-maven-plugin |
| Java class | Java .java-files |
Refers to a record and/or an enum class. Does not refer to a traditional class. |
| Schema | OpenAPI .yaml-file |
Refers to the components.schemas.{schema}-property, which is the basis of generated Java classes. |
| Field | Java .java-files |
Refers to the fields/members of a record class. |
| Properties | OpenAPI .yaml-file |
Refers to the {schema}.properties, which corresponds to the fields of an object. |
| Template | Mustache .mustache template file |
Refers to a .mustache-file. |