api-guidelines/SUMMARY.md

# Table of contents

* [adidas API Guidelines](README.md)

## General Guidelines

* [Introduction](general-guidelines/general-guidelines.md)
* [API First](general-guidelines/api-first.md)
* [Contract](general-guidelines/contract.md)
* [Immutability](general-guidelines/c\_immutability.md)
* [Robustness](general-guidelines/robustness.md)
* [Common Data Types](general-guidelines/d\_data\_types.md)
* [Version Control System](general-guidelines/version-control-system.md)
* [Minimal API Surface](general-guidelines/minimal-api-surface.md)
* [Rules for Extending](general-guidelines/rules-for-extending.md)
* [JSON](general-guidelines/json.md)
* [Security](general-guidelines/security.md)
* [Tooling](general-guidelines/n\_tooling.md)

## REST API Guidelines

* [Introduction](rest-api-guidelines/rest.md)
* [Core REST Principles](rest-api-guidelines/core-principles/README.md)
  * [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)
  * [Testing](rest-api-guidelines/core-principles/testing.md)
* [Protocol](rest-api-guidelines/protocol/README.md)
  * [HTTP](rest-api-guidelines/protocol/http.md)
  * [TLS](rest-api-guidelines/protocol/tls.md)
  * [Separate Concerns](rest-api-guidelines/protocol/separate-concerns.md)
  * [Request Methods](rest-api-guidelines/protocol/use-appropriate-methods.md)
  * [Status Codes](rest-api-guidelines/protocol/use-appropriate-status-codes.md)
* [Message](rest-api-guidelines/message/README.md)
  * [Message Formats](rest-api-guidelines/message/message-formats.md)
  * [Content Negotiation](rest-api-guidelines/message/content-negotiation.md)
  * [HAL](rest-api-guidelines/message/hal.md)
  * [Problem Detail](rest-api-guidelines/message/error-reporting.md)
  * [Foreign Key Relations](rest-api-guidelines/message/foreign-key-relations.md)
* [Application](rest-api-guidelines/application/README.md)
  * [Corporate Data Model](rest-api-guidelines/application/harmonize-data.md)
  * [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)
  * [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)
  * [Choosing Fields and Embedded Resources](rest-api-guidelines/execution/choosing-fields-and-embedded-resoruces.md)
  * [Localization](rest-api-guidelines/execution/localization.md)
  * [Rate Limiting](rest-api-guidelines/execution/rate-limiting.md)
  * [Caching](rest-api-guidelines/execution/caching.md)
  * [Testing Enviroments](rest-api-guidelines/execution/testing-enviroments.md)
* [Evolution](rest-api-guidelines/evolution/README.md)
  * [Naming Conventions](rest-api-guidelines/evolution/naming-conventions.md)
  * [Reserved Identifiers](rest-api-guidelines/evolution/reserved-identifiers.md)
  * [URI Structure](rest-api-guidelines/evolution/uri-structure.md)
  * [Changes and Versioning](rest-api-guidelines/evolution/versioning.md)
  * [Phasing out Old Versions](rest-api-guidelines/evolution/phasing-out-old-versions.md)
* [Guides](rest-api-guidelines/guides/README.md)
  * [API Testing CI Environment](rest-api-guidelines/guides/api-testing-ci-environment.md)
  * [Complete API Development](rest-api-guidelines/guides/complete-api-development.md)
* [API Clients](rest-api-guidelines/clients/README.md)
  * [Loose Coupling](rest-api-guidelines/clients/loose-coupling.md)
* [Further References](rest-api-guidelines/miscellaneous.md)

## Asynchronous API Guidelines

* [Introduction](asynchronous-api-guidelines/01\_introduction/a\_introduction.md)
* [Core Asynchronous Principles](asynchronous-api-guidelines/core-asynchronous-principles/README.md)
  * [Event Driven Architectures](asynchronous-api-guidelines/core-asynchronous-principles/b\_basic\_concepts\_edas.md)
  * [Messages](asynchronous-api-guidelines/core-asynchronous-principles/messages/README.md)
    * [Commands](asynchronous-api-guidelines/core-asynchronous-principles/messages/commands.md)
    * [Queries](asynchronous-api-guidelines/core-asynchronous-principles/messages/query.md)
    * [Events](asynchronous-api-guidelines/core-asynchronous-principles/messages/d\_basic\_concepts\_events/README.md)
      * [Events as Notifications](asynchronous-api-guidelines/core-asynchronous-principles/messages/d\_basic\_concepts\_events/events-as-notifications.md)
      * [Events to Replicate Data](asynchronous-api-guidelines/core-asynchronous-principles/messages/d\_basic\_concepts\_events/events-to-replicate-data.md)
  * [Protocols](asynchronous-api-guidelines/core-asynchronous-principles/j\_protocols.md)
  * [Coupling](asynchronous-api-guidelines/core-asynchronous-principles/coupling.md)
  * [Bounded Context](asynchronous-api-guidelines/core-asynchronous-principles/bounded-context.md)
  * [Stream Processing](asynchronous-api-guidelines/core-asynchronous-principles/stream-processing.md)
  * [Naming Conventions](asynchronous-api-guidelines/core-asynchronous-principles/i\_naming\_conventions.md)
  * [Tooling](asynchronous-api-guidelines/core-asynchronous-principles/tooling/README.md)
    * [Editors](asynchronous-api-guidelines/core-asynchronous-principles/tooling/editors.md)
    * [Command Line Interface (CLI)](asynchronous-api-guidelines/core-asynchronous-principles/tooling/command-line-interface-cli.md)
    * [Generators](asynchronous-api-guidelines/core-asynchronous-principles/tooling/generators.md)
* [Kafka Asynchronous Guidelines](asynchronous-api-guidelines/kafka-asynchronous-guidelines/README.md)
  * [Introduction](asynchronous-api-guidelines/kafka-asynchronous-guidelines/a\_introduction/README.md)
    * [Why AsyncAPI?](asynchronous-api-guidelines/kafka-asynchronous-guidelines/a\_introduction/why-asyncapi.md)
  * [AsyncAPI Version](asynchronous-api-guidelines/kafka-asynchronous-guidelines/b\_asyncapi\_version.md)
  * [Internal vs Public Specifications](asynchronous-api-guidelines/kafka-asynchronous-guidelines/c\_internal\_public\_specs.md)
  * [Key/Value Format](asynchronous-api-guidelines/kafka-asynchronous-guidelines/g\_key\_value\_format.md)
  * [Message Headers](asynchronous-api-guidelines/kafka-asynchronous-guidelines/h\_message\_headers.md)
  * [Specification Granularity](asynchronous-api-guidelines/kafka-asynchronous-guidelines/d\_spec\_granularity.md)
  * [Self-Contained Specifications](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_self\_contained\_specs/README.md)
    * [Meaningful Descriptions](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_self\_contained\_specs/e\_meaningful\_descriptions.md)
  * [Schema Data Evolution](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/README.md)
    * [Backward Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/backward-compatibility.md)
    * [Forward Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/forward-compatibility.md)
    * [Full Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/full-compatibility.md)
  * [Automatic Schema Registration](asynchronous-api-guidelines/kafka-asynchronous-guidelines/e\_schema\_registration.md)
  * [Contact Information](asynchronous-api-guidelines/kafka-asynchronous-guidelines/g\_contact\_information.md)
  * [AsyncAPI ID](asynchronous-api-guidelines/kafka-asynchronous-guidelines/h\_asyncapi\_id.md)
  * [Servers](asynchronous-api-guidelines/kafka-asynchronous-guidelines/i\_servers.md)
  * [Channels](asynchronous-api-guidelines/kafka-asynchronous-guidelines/j\_channels.md)
  * [Schemas](asynchronous-api-guidelines/kafka-asynchronous-guidelines/k\_schemas.md)
  * [Security Schemes](asynchronous-api-guidelines/kafka-asynchronous-guidelines/l\_security\_schemes.md)
  * [External Docs](asynchronous-api-guidelines/kafka-asynchronous-guidelines/m\_external\_docs.md)