GitBook: [master] 69 pages modified

rest-api-guidelines/application/README.md

@@ -0,0 +1,6 @@
+# Application
+
+Every API **SHOULD** use company terms for resource names, relation names and representation message field names.
+
+Also, every API **MUST** follow the [naming conventions](../evolution/naming-conventions.md).
+

rest-api-guidelines/application/common-data-types.md

@@ -0,0 +1,45 @@
+# Common Data Types
+
+## Date and Time Format
+
+Date and Time **MUST** always conform to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format e.g.: `2017-06-21T14:07:17Z` \(date time\) or `2017-06-21` \(date\), it **MUST** use the UTC \(without time offsets\).
+
+## Duration Format
+
+Duration format **MUST** conform to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard e.g.: `P3Y6M4DT12H30M5S` \(three years, six months, four days, twelve hours, thirty minutes, and five seconds\).
+
+## Time Interval Format
+
+Time Interval format **MUST** conform to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard e.g.: `2007-03-01T13:00:00Z/2008-05-11T15:30:00Z`.
+
+## Standard Time Stamps
+
+Where applicable, a resource representation **SHOULD** contain the standard timestamps:
+
+* `createdAt`
+* `updatedAt`
+* `finishedAt`
+
+### Example
+
+```javascript
+{
+    "createdAt": "2017-01-01T12:00:00Z",
+    "updatedAt": "2017-01-01T13:00:00Z",
+
+    ...
+}
+```
+
+## Language Code Format
+
+Language codes **MUST** conform to the [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) e.g.: `en` for English.
+
+## Country Code Format
+
+Country codes **MUST** conform to the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) e.g.: `DE` for Germany.
+
+## Currency Format
+
+Currency codes **MUST** conform to the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) e.g.: `EUR` for Euro.
+

rest-api-guidelines/application/harmonize-data.md

@@ -0,0 +1,10 @@
+# Corporate Data Model
+
+The design of application data model **MUST** consider the application use cases, as well as the upstream and downstream systems, use cases.
+
+The design of the data model of an application **MUST** consider the [adidas Corporate Data Model](https://collaboration.adidas-group.com/sites/CS-GDM/Corporate%20Data%20Dictionary/Data%20Dictionary.htm) \(internal link\).
+
+Different names for entities and attributes **MAY** be used **ONLY** if the **CDM** is not including them. If a different name is introduced then it **MUST** be included in the **CDM**.
+
+The consistency of the names of entities and attributes across the whole application **MUST** be maintained.
+