v1

latestOpenAPI 3.0.42026-07-14475158859.0 KB
Ganjoor

batch rename cat poems (Auth policies: ganjoor:modify)

put/api/ganjoor/cat/recaptionpoems/{id}

Path parameters

idinteger required

Request body

startWithNotIncludingSpacesstring nullable

Start with (not including required spaces)

removePreviousPatternboolean

remove previous pattern from start until any numbers

removeSetOfCharactersstring nullable

remove set of characters other than spaces from beginning and end

simulateboolean

simulate naming

Example request

{
  "startWithNotIncludingSpaces": "\r\n            شمارهٔ \r\n            ",
  "removeSetOfCharacters": ".-"
}

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