From 3f1391d8da653bfbd40e24ba16a3ec3d70cab281 Mon Sep 17 00:00:00 2001 From: dediejes Date: Mon, 15 Feb 2021 11:24:54 +0100 Subject: [PATCH] Sum of the first phase of updates --- README.md | 6 +++++- SUMMARY.md | 4 ---- .../execution/long-running-tasks/files-upload.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7dfdfb8..d10386d 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ 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), [_andrzej.jarzyna@adidas.com_](mailto:andrzej.jarzyna@adidas.com) 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 @@ -69,6 +69,10 @@ This project is intended to provide the guidelines for design & development of A 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 diff --git a/SUMMARY.md b/SUMMARY.md index 109db51..ca86068 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -21,7 +21,6 @@ * [OpenAPI Specification](rest-api-guidelines/core-principles/openapi-specification.md) * [API Design Platform](rest-api-guidelines/core-principles/design-platform.md) * [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md) - * [HATEOAS](rest-api-guidelines/core-principles/HATEOAS.md) * [Testing](rest-api-guidelines/core-principles/testing.md) * [Protocol](rest-api-guidelines/protocol/README.md) * [HTTP](rest-api-guidelines/protocol/http.md) @@ -68,7 +67,4 @@ ## Asynchronous API Guidelines * [Introduction](asynchronous-api-guidelines/asyncapi.md) -* [Core Principles](asynchronous-api-guidelines/core-principles/README.md) -* [Platforms](asynchronous-api-guidelines/platforms/README.md) -* [Types](asynchronous-api-guidelines/types/README.md) diff --git a/rest-api-guidelines/execution/long-running-tasks/files-upload.md b/rest-api-guidelines/execution/long-running-tasks/files-upload.md index 11413cd..1bb2755 100644 --- a/rest-api-guidelines/execution/long-running-tasks/files-upload.md +++ b/rest-api-guidelines/execution/long-running-tasks/files-upload.md @@ -47,7 +47,7 @@ It is also recommended to compress the file to be uploaded, then using these MIM > You can find a complete reference about the MIME types [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). -### Set Maximum Size Limit +### Set Maximum Size Limit in the API Producer Side The maximum size of the whole file **MUST** be set for the given endpoint/s in the APi upstream/backend service side. @@ -72,7 +72,7 @@ spring.http.multipart.max-request-size=128KB # the total request size for a mult Load tests should give you metrics about the average latency of the operations. Use these metrics to calcuate the best value for the timeout settings in the upstream/backend service. The API Gateway timeout settings have to be considered for the expected timeout values, aligned with the values in the upstream/backend service. Al other components in the infrastructure **MUST** be considered for the calculation of the final metrics. - +git commit ``` |API Consumer/Client Timeout| ---> |External Load Balancer| ---> |API Gateway Timeout| ---> |Internal Load Balancer| ---> |Upstream/Backend Service Tiemout| ```