Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
API paragraph not found
...
| Page Properties |
|---|
Project Name | COVID-certificate |
|---|
Project abreviation | SVC |
|---|
Developer | Розробник методу API. Наприклад, Edenlab |
|---|
Project Manager | @Єлизавета Гессен-Дармштадська |
|---|
Tech Lead | @Іоанн Воїнов |
|---|
Product Owner | @Нікодім Святогорцев |
|---|
Вusiness analyst | @Пантелеймон Нікомедійський |
|---|
Status | |
|---|
Version | 1.0 |
|---|
Date of release | |
|---|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-generate-url-to-media-storage | Resource | /api/admin/contracts/media_storage/generate_url | Scope | private_contracts:write | Components | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC | Protocol type | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | POST | Sync/Async | Метод є синхронним чи асинхронним? |
|
Logic*
API paragraph not found
...
Filter
...
Values
...
Type
...
Description
...
Example
...
status
...
String
...
Optional
...
PROCESSED
Request structure*
See on Apiary
...
Request to process the request using a token in the headers
Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9
...
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": {
"url": "https://example.com/upload_url"
}
} |
|
Post-processing processes*
Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо
HTTP status codes*
HTTP status code | Message | What caused the error |
|---|
200 | | |
...