mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Minor fixes
This commit is contained in:
@@ -10,7 +10,7 @@ That contract **MUST** contain enough information to use the API (servers, URIs,
|
||||
|
||||
### API First
|
||||
|
||||
Asyncrhonous APIs **SHOULD** use the API First principle :
|
||||
Asynchronous APIs **SHOULD** use the API First principle :
|
||||
|
||||
- The API designs **SHOULD** involve all relevant stakeholders (developers, consumers, ...) to ensure that final design fulfil requirements from different perspectives
|
||||
- The resulting API specification will be the source of truth rather than the API implementation
|
||||
|
||||
@@ -26,13 +26,13 @@ This access control is handled through Role-Based Access Control (RBAC) implemen
|
||||
|
||||
### Spec granularity
|
||||
|
||||
In FDP all resources are grouped by namespace.
|
||||
In Fast Data Platform (FDP) all resources are grouped by namespace.
|
||||
|
||||
For that reason specs **SHOULD** be created with a relation 1:1 with namespaces. In other words, every namespace will have an AsyncAPI spec including all the assets belonging to that namespace.
|
||||
|
||||
Different granularities **MAY** be chosen depending on the needs.
|
||||
|
||||
### Meaningful descriptions
|
||||
### Meaningful descriptions
|
||||
|
||||
All fields included in the specs **MUST** include a proper description.
|
||||
|
||||
@@ -129,7 +129,7 @@ channels:
|
||||
description: A description of the purpose of the topic and the contained information
|
||||
servers: ["pivotalDev", "pivotalSit", "pivotalPro"]
|
||||
x-metadata:
|
||||
myField1: myValue1
|
||||
myField1: myValue1
|
||||
myField2: myValue2
|
||||
x-configurations:
|
||||
pivotal.dev:
|
||||
|
||||
Reference in New Issue
Block a user