From edd820388e1f6d40ca888a37bec7b9509d768f70 Mon Sep 17 00:00:00 2001 From: apidesigner Date: Sat, 23 Jun 2018 13:12:30 +0000 Subject: [PATCH] Updates SUMMARY.md Auto commit by GitBook Editor --- README.md | 4 ++-- SUMMARY.md | 4 ++-- kafka/README.md | 6 ++++++ kafka/introduction.md | 6 ------ rest/README.md | 47 +++++++++++++++++++++++++++++++++++++++++ rest/introduction.md | 49 ------------------------------------------- 6 files changed, 57 insertions(+), 59 deletions(-) create mode 100644 kafka/README.md diff --git a/README.md b/README.md index 25a7b95..e437eae 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ The API Guidelines are split into two main parts: * [General Guidelines](/general-guidelines/README.md) * API type-specific Guidelines - * [REST APIs Guidelines](/rest/introduction.md) - * [Kafka Guidelines](/kafka/introduction.md) + * [REST APIs Guidelines](/rest/README.md) + * [Kafka Guidelines](/kafka/README.md) The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique \(such as REST, Kafka or GraphQL API\). diff --git a/SUMMARY.md b/SUMMARY.md index c73448c..ecc82e7 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -18,7 +18,7 @@ ## REST API Guidelines -* [Introduction](rest/introduction.md) +* [Introduction](rest/README.md) * [Core Principles](rest/core-principles/README.md) * [OpenAPI Specification](rest/core-principles/openapi-specification.md) * [API Design Platform](rest/core-principles/apiary.md) @@ -66,5 +66,5 @@ ## Kafka Guidelines -* [Introduction](kafka/introduction.md) +* [Introduction](kafka/README.md) diff --git a/kafka/README.md b/kafka/README.md new file mode 100644 index 0000000..9191687 --- /dev/null +++ b/kafka/README.md @@ -0,0 +1,6 @@ +# ![](/assets/adidas-logo.svg) + +# adidas Kafka Guidelines + + + diff --git a/kafka/introduction.md b/kafka/introduction.md index 9191687..e69de29 100644 --- a/kafka/introduction.md +++ b/kafka/introduction.md @@ -1,6 +0,0 @@ -# ![](/assets/adidas-logo.svg) - -# adidas Kafka Guidelines - - - diff --git a/rest/README.md b/rest/README.md index e69de29..b5f7415 100644 --- a/rest/README.md +++ b/rest/README.md @@ -0,0 +1,47 @@ +# ![](/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 adidas **[**General API Guidelines.**](/general-guidelines/README.md) + +The REST API Guidelines are further split into the following parts: + +* **Core Principles** + + REST API Guidelines Core Principles defines the rules that **MUST** be followed at throughout the full API lifecycle. + +* **Functionality Guidelines** + + * [**Protocol level**](https://adidas-group.gitbooks.io/api-guidelines/content/protocol/) + + Protocol guidelines define the protocols used within the organization. + + * [**Message level**](https://adidas-group.gitbooks.io/api-guidelines/content/message/) + + The Message guidelines define the structure and semantics of messages used to exchange information. + + * [**Application level**](https://adidas-group.gitbooks.io/api-guidelines/content/application/) + + The Application guidelines define the definition and use of application-specific semantics. + +* **Quality Guidelines** + + Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems. + + * [**Evolution**](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/) + + Evolution qualities governance, such as testability, maintainability, extensibility, and scalability. + + * [**Execution**](https://adidas-group.gitbooks.io/api-guidelines/content/execution/) + + Execution qualities governance, such as security and usability. + +* **Guides** + Guides and materials supporting the REST API Guidelines + +* **API Clients** + + Section dedicated to consumers of adidas APIs + + + diff --git a/rest/introduction.md b/rest/introduction.md index 7c94d44..e69de29 100644 --- a/rest/introduction.md +++ b/rest/introduction.md @@ -1,49 +0,0 @@ -# ![](/assets/adidas-logo.svg) - -# adidas REST API 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: - -* **Core Principles** - - REST API Guidelines Core Principles defines the rules that **MUST** be followed at throughout the full API lifecycle. - -* **Functionality Guidelines** - - * [**Protocol level**](https://adidas-group.gitbooks.io/api-guidelines/content/protocol/) - - Protocol guidelines define the protocols used within the organization. - - * [**Message level**](https://adidas-group.gitbooks.io/api-guidelines/content/message/) - - The Message guidelines define the structure and semantics of messages used to exchange information. - - * [**Application level**](https://adidas-group.gitbooks.io/api-guidelines/content/application/) - - The Application guidelines define the definition and use of application-specific semantics. - -* **Quality Guidelines** - - Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems. - - * [**Evolution**](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/) - - Evolution qualities governance, such as testability, maintainability, extensibility, and scalability. - - * [**Execution**](https://adidas-group.gitbooks.io/api-guidelines/content/execution/) - - Execution qualities governance, such as security and usability. - -* **Guides** - Guides and materials supporting the REST API Guidelines - -* **API Clients** - - Section dedicated to consumers of adidas APIs - - -