Grafika - editor kódu

slouží pro práci se soubory na testovací verzi grafiky e-shopu, obdobně lze využít nástroj Editor kódu v administraci.
seznamy souborů ovlivňuje zapnutý či vypnutý grafický editor Designer.
více informací ohledně struktury souborů a složek nebo základní dokumentace naleznete v nápovědách.
všechny cesty jsou vzhledem k root složce /. Dle verze grafiky se mohou měnit názvy a umístění systémových souborů.

Informace o souboru / složce

GET

/api/v2/graphics/code

Vrací informace o souboru nebo složce

Informace o souboru / složce › query Parameters

pathname

string

cesta ke konkrétní složce nebo souboru

Default: /

Informace o souboru / složce › Responses

200

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Soubor

GraphicsFile

pathname

string

cesta k souboru

last_update_time

DateTime · date-time

datum poslední změny souboru

custom_yn

boolean

příznak, zda jde o vlastnoručně vytvořený soubor

size

integer

velikost souboru v bajtech

content

string

samotný obsah souboru (textový řetězec)

readonly_yn

boolean

příznak, zda je soubor pouze pro čtení (nelze jej přepsat)

success

boolean

indikace úspěšného zpracování požadavku

object[]

seznam chyb (pouze pokud je success = TRUE)

Aktualizace obsahu souboru

PUT

/api/v2/graphics/code

Přepíše obsah souboru na zadané cestě novými daty.

Aktualizace obsahu souboru › Request Body

pathname

string · required

Cesta k souboru

content

string · required

Obsah souboru.

Aktualizace obsahu souboru › Responses

200

success

boolean

Indikace, zda aktualizace proběhla v pořádku.

object[]

seznam chyb (pouze pokud je success = TRUE)

Vytvoření souboru / složky

POST

/api/v2/graphics/code

Vytvoří nový soubor nebo složku na zadané cestě.

Vytvoření souboru / složky › Request Body

pathname

string · required

Plná cesta k souboru nebo složce (/path/<name><.><extension>). Samotný název (bez cesty a přípony) musí odpovídat REGEXu: /^([a-zA-Z0-9_-]){1,50}$/i.

type

string · enum · required

Typ položky:

directory - složka
file - soubor

Enum values:

Vytvoření souboru / složky › Responses

200

pathname

string

Cesta k vytvořenému objektu.

success

boolean

Indikace, zda se vytvoření podařilo.

object[]

seznam chyb (pouze pokud je success = TRUE)

Smazání souboru / složky

DELETE

/api/v2/graphics/code

Odstraní soubor nebo celou složku na základě zadané cesty.

Smazání souboru / složky › Request Body

pathname

string · required

Cesta k souboru nebo složce, která má být smazána.

Smazání souboru / složky › Responses

200

success

boolean

Indikace, zda smazání proběhlo úspěšně.

object[]

seznam chyb (pouze pokud je success = TRUE)

Faktury Grafika - zálohy

Informace o souboru / složce

GET

/api/v2/graphics/code

Vrací informace o souboru nebo složce

Informace o souboru / složce › query Parameters

pathname

string

cesta ke konkrétní složce nebo souboru

Default: /

Informace o souboru / složce › Responses

200

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Soubor

GraphicsFile

pathname

string

cesta k souboru

last_update_time

DateTime · date-time

datum poslední změny souboru

custom_yn

boolean

příznak, zda jde o vlastnoručně vytvořený soubor

size

integer

velikost souboru v bajtech

content

string

samotný obsah souboru (textový řetězec)

readonly_yn

boolean

příznak, zda je soubor pouze pro čtení (nelze jej přepsat)

success

boolean

indikace úspěšného zpracování požadavku

object[]

seznam chyb (pouze pokud je success = TRUE)

Aktualizace obsahu souboru

PUT

/api/v2/graphics/code

Přepíše obsah souboru na zadané cestě novými daty.

Aktualizace obsahu souboru › Request Body

pathname

string · required

Cesta k souboru

content

string · required

Obsah souboru.

Aktualizace obsahu souboru › Responses

200

success

boolean

Indikace, zda aktualizace proběhla v pořádku.

object[]

seznam chyb (pouze pokud je success = TRUE)

Vytvoření souboru / složky

POST

/api/v2/graphics/code

Vytvoří nový soubor nebo složku na zadané cestě.

Vytvoření souboru / složky › Request Body

pathname

string · required

Plná cesta k souboru nebo složce (/path/<name><.><extension>). Samotný název (bez cesty a přípony) musí odpovídat REGEXu: /^([a-zA-Z0-9_-]){1,50}$/i.

type

string · enum · required

Typ položky:

directory - složka
file - soubor

Enum values:

Vytvoření souboru / složky › Responses

200

pathname

string

Cesta k vytvořenému objektu.

success

boolean

Indikace, zda se vytvoření podařilo.

object[]

seznam chyb (pouze pokud je success = TRUE)

Smazání souboru / složky

DELETE

/api/v2/graphics/code

Odstraní soubor nebo celou složku na základě zadané cesty.

Smazání souboru / složky › Request Body

pathname

string · required

Cesta k souboru nebo složce, která má být smazána.

Smazání souboru / složky › Responses

200

success

boolean

Indikace, zda smazání proběhlo úspěšně.

object[]

seznam chyb (pouze pokud je success = TRUE)