{ "openapi": "3.1.0", "info": { "title": "Barberyo API", "version": "1.0.0", "description": "Ve\u0159ejn\u00E9 API barbershopu. Umo\u017E\u0148uje \u010D\u00EDst katalog a voln\u00E9 term\u00EDny a zakl\u00E1dat rezervace z ciz\u00EDho syst\u00E9mu \u2014 z webu podniku, pokladny nebo vlastn\u00ED aplikace. Kl\u00ED\u010D nese podnik, tak\u017Ee se v cest\u00E1ch nikde neuv\u00E1d\u00ED, kter\u00E9ho podniku se t\u00FDkaj\u00ED." }, "servers": [ { "url": "https://barberyo.onrender.com" } ], "security": [ { "ApiKey": [] } ], "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "Kl\u00ED\u010D vydan\u00FD v administraci podniku." } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Strojov\u011B \u010Diteln\u00FD k\u00F3d chyby." }, "message": { "type": "string", "description": "Popis pro \u010Dlov\u011Bka." } } } } } } }, "paths": { "/api/v1/shop": { "get": { "summary": "Profil podniku", "description": "Z\u00E1kladn\u00ED \u00FAdaje, otev\u00EDrac\u00ED doba, pravidla rezervac\u00ED a pr\u016Fm\u011Brn\u00E9 hodnocen\u00ED. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED CatalogRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/services": { "get": { "summary": "Seznam slu\u017Eeb", "description": "Aktivn\u00ED slu\u017Eby s cenou, d\u00E9lkou a p\u0159\u00EDpadn\u00FDm rozsahem od\u2013do. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED CatalogRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/barbers": { "get": { "summary": "Seznam barber\u016F", "description": "Aktivn\u00ED barbe\u0159i s medailonkem, jazyky a hodnocen\u00EDm. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED CatalogRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/availability": { "get": { "summary": "Voln\u00E9 term\u00EDny na den", "description": "Vr\u00E1t\u00ED voln\u00E9 za\u010D\u00E1tky term\u00EDn\u016F. Bez barbera hled\u00E1 u kohokoliv. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED AvailabilityRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "serviceId", "in": "query", "required": true, "description": "Id slu\u017Eby.", "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": true, "description": "Den ve tvaru YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "barberId", "in": "query", "required": false, "description": "Id barbera; bez n\u011Bj kdokoliv.", "schema": { "type": "integer" } } ] } }, "/api/v1/availability/month": { "get": { "summary": "Volno po dnech v m\u011Bs\u00EDci", "description": "Po\u010Det voln\u00FDch term\u00EDn\u016F pro ka\u017Ed\u00FD den m\u011Bs\u00EDce \u2014 pro vykreslen\u00ED kalend\u00E1\u0159e. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED AvailabilityRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "serviceId", "in": "query", "required": true, "description": "Id slu\u017Eby.", "schema": { "type": "integer" } }, { "name": "month", "in": "query", "required": true, "description": "M\u011Bs\u00EDc ve tvaru YYYY-MM.", "schema": { "type": "string" } }, { "name": "barberId", "in": "query", "required": false, "description": "Id barbera; bez n\u011Bj kdokoliv.", "schema": { "type": "integer" } } ] } }, "/api/v1/bookings": { "get": { "summary": "V\u00FDpis rezervac\u00ED", "description": "Rezervace v zadan\u00E9m obdob\u00ED. Bez parametr\u016F vrac\u00ED nejbli\u017E\u0161\u00EDch \u010Dtrn\u00E1ct dn\u00ED. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED BookingRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "from", "in": "query", "required": false, "description": "Od (YYYY-MM-DD).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "Do (YYYY-MM-DD).", "schema": { "type": "string" } }, { "name": "take", "in": "query", "required": false, "description": "Kolik nejv\u00FD\u0161 vr\u00E1tit (1\u2013500).", "schema": { "type": "integer" } } ] }, "post": { "summary": "Zalo\u017Een\u00ED rezervace", "description": "Projde stejnou kontrolou jako rezervace z webu: otev\u00EDrac\u00ED doba, uzav\u00EDrky, blokace, minim\u00E1ln\u00ED p\u0159edstih i rezerva\u010Dn\u00ED okno. Ode\u0161lou se i potvrzovac\u00ED e-maily. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED BookingWrite.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "barberId", "serviceId", "start", "customerName", "customerEmail", "customerPhone" ], "properties": { "barberId": { "type": "integer", "description": "Id barbera." }, "serviceId": { "type": "integer", "description": "Id hlavn\u00ED slu\u017Eby." }, "start": { "type": "string", "description": "Za\u010D\u00E1tek ve tvaru YYYY-MM-DDTHH:mm." }, "customerName": { "type": "string", "description": "Jm\u00E9no z\u00E1kazn\u00EDka." }, "customerEmail": { "type": "string", "description": "E-mail z\u00E1kazn\u00EDka." }, "customerPhone": { "type": "string", "description": "Telefon z\u00E1kazn\u00EDka." }, "notes": { "type": "string", "description": "Pozn\u00E1mka k rezervaci." }, "extraServiceIds": { "type": "array", "items": { "type": "integer" }, "description": "Dopl\u0148kov\u00E9 slu\u017Eby v t\u00E9\u017Ee n\u00E1v\u0161t\u011Bv\u011B." }, "promoCode": { "type": "string", "description": "Slevov\u00FD k\u00F3d." }, "voucherCode": { "type": "string", "description": "K\u00F3d d\u00E1rkov\u00E9ho poukazu." } } } } } }, "responses": { "201": { "description": "Vytvo\u0159eno." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/bookings/{id}": { "get": { "summary": "Jedna rezervace", "description": "Detail rezervace podniku, na kterou je kl\u00ED\u010D vydan\u00FD. Na tuhle adresu odkazuje hlavi\u010Dka Location v odpov\u011Bdi na zalo\u017Een\u00ED rezervace. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED BookingRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id rezervace.", "schema": { "type": "integer" } } ] }, "delete": { "summary": "Zru\u0161en\u00ED rezervace", "description": "Zru\u0161\u00ED rezervaci stejnou cestou jako administrace \u2014 odejdou e-maily a zap\u00ED\u0161e se to do historie rezervace. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED BookingWrite.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id rezervace.", "schema": { "type": "integer" } } ] } }, "/api/v1/reviews": { "get": { "summary": "Hodnocen\u00ED", "description": "Ve\u0159ejn\u00E1 hodnocen\u00ED v\u010Detn\u011B d\u00EDl\u010D\u00EDch os a odpov\u011Bdi podniku. Soukrom\u00E1 zp\u011Btn\u00E1 vazba se nevrac\u00ED. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED ReviewRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "take", "in": "query", "required": false, "description": "Kolik nejv\u00FD\u0161 vr\u00E1tit (1\u2013100).", "schema": { "type": "integer" } } ] } }, "/api/v1/customers": { "get": { "summary": "Z\u00E1kazn\u00EDci", "description": "Z\u00E1kazn\u00EDci podniku s po\u010Dtem n\u00E1v\u0161t\u011Bv a \u00FAtratou. Vy\u017Eaduje zvl\u00E1\u0161tn\u00ED opr\u00E1vn\u011Bn\u00ED, proto\u017Ee vyd\u00E1v\u00E1 osobn\u00ED \u00FAdaje. Vy\u017Eaduje opr\u00E1vn\u011Bn\u00ED CustomerRead.", "responses": { "200": { "description": "V po\u0159\u00E1dku." }, "401": { "description": "Chyb\u00ED nebo neplat\u00ED kl\u00ED\u010D.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Kl\u00ED\u010D nem\u00E1 pot\u0159ebn\u00E9 opr\u00E1vn\u011Bn\u00ED, nebo vol\u00E1 z nepovolen\u00E9 dom\u00E9ny.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Po\u017Eadavek nepro\u0161el kontrolou (obsazen\u00FD term\u00EDn, zav\u0159eno\u2026).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "P\u0159ekro\u010Den limit po\u017Eadavk\u016F. Hlavi\u010Dka Retry-After \u0159\u00EDk\u00E1, za jak dlouho to zkusit znovu.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "take", "in": "query", "required": false, "description": "Kolik nejv\u00FD\u0161 vr\u00E1tit (1\u2013500).", "schema": { "type": "integer" } } ] } } } }