1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2020 Deutsche Telekom AG.
6 .. This is a template to document new APIs for CDS blueprint processor
8 .. make use of tabs whenever it fits
16 General description about the resource.
23 ......................
25 Method 1 Endpoint 1 description
31 :caption: **(sample) request**
35 .. can be split into Header and Body description if thats more suitable.
36 .. If its split, Header requires content-type definition, Body requires example payload
38 **Request Path Parameters:**
57 **Request Query Parameters:**
76 **Request Body Parameters:**
96 ......................
101 ``Content-Type:application/json``
104 :caption: **(sample) response body and/or response schema**
106 (sample) response (can be {})
108 **Success Response Parameters:**
125 ......................
127 HTTP Status 404 The requested resource could not be found
130 :caption: **sample error response**
134 **Error Response Parameters:**
150 .. or just table for responses with HTTP code, description and schema
163 Functional Description
164 ..............................
166 What does the API do in detail?
168 Technical Description
169 ...........................
171 Called class, methods, other hints.
174 ......................
187 ......................
189 Method 2 Endpoint 1 description
194 Method 1 Endpoint 2 (Subresource):
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
197 <method> ``<path><subpath>``
198 ..............................