Documentation
¶
Overview ¶
Package docs Code generated by swag/swag. DO NOT EDIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "localhost:8080", BasePath: "/api/v1", Schemes: []string{}, Title: "API pro správu uživatelů", Description: "<details>\n <summary><b><font size=\"5\">Základní aplikační logika</font></b></summary>\n <p>Toto REST API k elektronické komunikaci pro dodavatele s architekturou REST a formátem dat JSON s kódováním UTF8. Autentizace probíhá na základě certifikátu.</p>\n</details>\n\n<details>\n <summary><b><font size=\"5\">Operace webové služby</font></b></summary>\n\n### Zaevidování zprávy zadavateli\nPro zaevidování zprávy se používá endpoint **POST /servisni/zprava-zadavali**. Očekává požadavek typu `multipart/form-data` se dvěma částmi: `zpravaJson` (JSON s daty zprávy) a volitelnými `prilohy` (soubory s maximální celkovou velikostí 1 GB).\n\n### Zaevidování přečtení zprávy zadavali\nEndpoint **POST /servisni/zprava-zadavali/precteni** slouží k zaevidování přečtení zprávy. Přečtení lze zaevidovat pouze u zprávy, která byla zaevidována stejným elektronickým nástrojem.\n\n### Detail zprávy zadavateli\nPro načtení detailu zprávy je k dispozici endpoint **GET /servisni/zprava-zadavali/{id}**, kde `{id}` je UUID zprávy.\n\n### Smazání zprávy zadavateli\nEndpoint **DELETE /servisni/zprava-zadavali/{id}** umožňuje smazání zprávy. Smazat lze pouze zprávy, které pocházejí ze stejného elektronického nástroje, který je evidoval.\n</details>\n\n---\n\n<b><font size=\"5\">Seznam změn</font></b>\n### Aktuální verze\n\n<details>\n <summary>1.0.0</summary>\n\n#### Inicializační verze\n- Implementace základních operací pro správu zpráv.\n- Podpora zaevidování zprávy s přílohami.\n- Možnost zaznamenat přečtení zprávy a získat její detail.\n- Funkce pro smazání zprávy s omezením na nástroj, který ji vytvořil.\n</details>", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", }
SwaggerInfo holds exported Swagger Info so clients can modify it
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.