Sign in

v1

OpenAPI 3.0.42026-07-14475158859.0 KB
Ganjoor

modify page (Auth policies: ganjoor:modify)

put/api/ganjoor/page/{id}

Path parameters

idinteger required

Request body

titlestring nullable

title

urlSlugstring nullable

url => slug

htmlTextstring nullable

Html Text

rhythmstring nullable

Poem Rhythm

rhythm2string nullable

Second Poem Rhythm

rhythm3string nullable

Third Poem Rhythm

rhymeLettersstring nullable

rhyme letters

sourceNamestring nullable

source name

sourceUrlSlugstring nullable

source url slug

oldTagstring nullable

old collection or book name for Saadi's ghazalyiat (طیبات، خواتیم و ....)

oldTagPageUrlstring nullable

old collection page url e.g /saadi/tayyebat

noIndexboolean

no index (search engines are blocked to index the page)

redirectFromFullUrlstring nullable

if a page url is changed, store the old URL here to be redirected automatically

mixedModeOrderinteger

order when mixed with categories

publishedboolean

published

languagestring nullable

language (this is intended to affect html page encodings and not determine actuallly accents and ....)

tableOfContentsStyle0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

ganjoor TOC options

catType0 | 1 | 2

Ganjoor Category Type

descriptionstring nullable

additional description or note

descriptionHtmlstring nullable

html mode of additional description or note

notestring nullable

a description of the modfication

Response

OK

idinteger

id

ganjoorPageType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

Ganjoor Page Type

titlestring nullable

title

fullTitlestring nullable

cat + parent cats title + title

urlSlugstring nullable

url => slug

fullUrlstring nullable

sample: /hafez/ghazal/sh1

htmlTextstring nullable

Html Text

noIndexboolean

no index (search engines are blocked to index the page)

redirectFromFullUrlstring nullable

if a page url is changed, store the old URL here to be redirected automatically