Merge pull request #42 from adidas/changes/API-165

application/problem+json added as possible media type in successful responses

Author: jesusjavierdediego

.gitignore

@@ -105,3 +105,5 @@ dist
 
 # SSHFS
 ._*
+
+.DS_Store

.spectral.yml

@@ -244,24 +244,40 @@ rules:
         match: "/^https:/"
 
   adidas-oas3-response-success-hal:
-    description: "All success responses MUST be of media type `application/hal+json`"
+    description: "All success responses MUST be of media type `application/hal+json` "
     severity: error
-    given: $.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~
+    given: $.paths..responses[?( @property >= 201 && @property < 300 && @property != 204)].content[*]~
     recommended: true
     # type: "style"
     formats:
       - oas3
-    message: "Response documents MUST be of application/hal+json media type: {{error}}"
+    message: "Response documents MUST be of application/hal+json media types: {{error}}"
+    then:
+      function: enumeration
+      functionOptions:
+        values:
+          - application/hal+json
+  
+  # sync and async patterns that can return hal OR problem+json
+  adidas-oas3-response-success-OK:
+    description: "All success responses MUST be of media type `application/hal+json` or `application/problem+json`"
+    severity: error
+    given: $.paths..responses[?( @property == 200 )].content[*]~
+    recommended: true
+    formats:
+      - oas3
+    message: "Response documents MUST be of application/hal+json or application/problem+json media types: {{error}}"
     then:
       function: enumeration
       functionOptions:
         values:
           - application/hal+json
+          - application/problem+json
 
   adidas-oas3-response-success-hal-body: # schemes and/or produces
     description: "All success responses MUST follow `application/hal+json` schema"
     severity: error
-    given: $.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[?(@property === "application/hal+json")]
+    given: $.paths..responses[?( @property == 200 && @property < 300 && @property != 204)].content[?(@property === "application/hal+json")]
     recommended: true
     type: "style"
     formats:

README.md

@@ -4,7 +4,7 @@ description: Guidelines for the API design and development at adidas
 
 # adidas API Guidelines
 
-![adidas logo](https://adidas-group.gitbooks.io/api-guidelines/content/assets/adidas-logo.svg)
+![adidas logo](adidaslogo.jpg)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -23,7 +23,7 @@ The API Guidelines are split into two main parts:
 * [General Guidelines](general-guidelines/general-guidelines.md)
 * API type-specific Guidelines
   * [REST APIs Guidelines](rest-api-guidelines/rest.md)
-  * [Kafka Guidelines](kafka-guidelines/kafka.md)
+  * [Asynchronous APIs Guidelines](asynchronous-api-guidelines/asyncapi.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 APIs\).
 
@@ -61,14 +61,18 @@ For further documentation on Spectral refer to their [documentation](https://sto
 
 ### Questions & Comments
 
-_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com), [[email protected]_](mailto:[email protected]) or [_samir.amzani@adidas.com_](mailto:samir.amzani@adidas.com) _in case of questions._
+_Please contact_ [_samir.amzani@adidas.com_](mailto:samir.amzani@adidas.com) or [_jesusjavier.dediego@adidas.com_](mailto:jesusjavier.dediego@adidas.com) _in case of questions._
 
 ## Intended Use Cases
 
 This project is intended to provide the guidelines for design & development of APIs at adidas.
 
 adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases.
 
+## Last Review
+
+February 2021
+
 ## License and Software Information
 
 © adidas AG
@@ -83,5 +87,5 @@ For further information open the [adidas terms and conditions](https://github.co
 
 ### License
 
-[MIT](https://github.com/adidas-group/api-guidelines/tree/657bc6fd49f1499f10c30ab18420f4bdb7cd841b/LICENSE/README.md)
+[MIT](https://github.com/adidas/api-guidelines/blob/master/LICENSE)
 

SUMMARY.md

@@ -39,7 +39,10 @@
   * [Common Data Types](rest-api-guidelines/application/common-data-types.md)
 * [Execution](rest-api-guidelines/execution/README.md)
   * [Pagination](rest-api-guidelines/execution/pagination.md)
-  * [Asynchronous Tasks](rest-api-guidelines/execution/asynchronous-tasks.md)
+  * [Long Running Tasks](rest-api-guidelines/execution/long-running-tasks/README.md)
+    * [Polling](rest-api-guidelines/execution/long-running-tasks/polling.md)
+    * [Callback](rest-api-guidelines/execution/long-running-tasks/callback.md)
+    * [Files Upload](rest-api-guidelines/execution/long-running-tasks/files-upload.md)
   * [Batch Operations](rest-api-guidelines/execution/batch-operations.md)
   * [Search Requests](rest-api-guidelines/execution/search-requests.md)
   * [Query Requests with Large Inputs](rest-api-guidelines/execution/query-requests-with-large-inputs.md)
@@ -61,7 +64,7 @@
   * [Loose Coupling](rest-api-guidelines/clients/loose-coupling.md)
 * [Further References](rest-api-guidelines/miscellaneous.md)
 
-## Kafka Guidelines
+## Asynchronous API Guidelines
 
-* [Introduction](kafka-guidelines/kafka.md)
+* [Introduction](asynchronous-api-guidelines/asyncapi.md)
 

adidaslogo.jpg

@@ -0,0 +1,6 @@
+# Introduction
+
+## adidas Asynchronous APIs Guidelines
+
+
+