From cc1d1c496e268cb24ad40153b5d06ab302cb3d33 Mon Sep 17 00:00:00 2001 From: apidesigner Date: Sat, 23 Jun 2018 13:06:20 +0000 Subject: [PATCH] Updates general-guidelines/introduction.md Auto commit by GitBook Editor --- SUMMARY.md | 1 + general-guidelines/introduction.md | 6 ++++++ kafka/introduction.md | 2 ++ rest/introduction.md | 6 +++++- 4 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 general-guidelines/introduction.md diff --git a/SUMMARY.md b/SUMMARY.md index 15af596..291d4b9 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,6 +6,7 @@ ## General Guidelines +* [Introduction](general-guidelines/introduction.md) * [API First](general-guidelines/api-first.md) * [Contract](general-guidelines/contract.md) * [Robustness](general-guidelines/robustness.md) diff --git a/general-guidelines/introduction.md b/general-guidelines/introduction.md new file mode 100644 index 0000000..c917272 --- /dev/null +++ b/general-guidelines/introduction.md @@ -0,0 +1,6 @@ +# adidas General API Guidelines + +Set of general rules and recommendations that have to be followed along the entire API lifecycle of any API regardless of its type. + + + diff --git a/kafka/introduction.md b/kafka/introduction.md index 7805b7d..9191687 100644 --- a/kafka/introduction.md +++ b/kafka/introduction.md @@ -1,3 +1,5 @@ +# ![](/assets/adidas-logo.svg) + # adidas Kafka Guidelines diff --git a/rest/introduction.md b/rest/introduction.md index deea0b3..7c94d44 100644 --- a/rest/introduction.md +++ b/rest/introduction.md @@ -1,6 +1,10 @@ +# ![](/assets/adidas-logo.svg) + # adidas REST API Guidelines -The adidas REST API Guidelines defines standards and guidelines for building REST APIs at adidas. These Guidelines has to be followed in addition to the General Guidelines. +The adidas REST API Guidelines defines standards and guidelines for building REST APIs at adidas. + +> NOTE: These Guidelines has to be followed in addition to the General Guidelines. The REST API Guidelines are further split into the following parts: