Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes

Browse Source
This commit is contained in:
Juan Manuel Pérez
2024-04-24 10:08:27 +02:00
parent 88fc9b8369
commit b68dc1ba13
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_guidelines.md
View File

@@ -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: