Spaces:
Sleeping
Sleeping
File size: 10,246 Bytes
8b34dfb |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
openapi: 3.0.0
info:
title: StihiRus Reader API
description: Provides access to author data and poems from stihirus.ru via the stihirus-reader library.
version: 1.2.0
servers:
- url: /
description: Current server
paths:
/author/{identifier}:
get:
summary: Get Author Data and Poems
description: Fetches author profile information and optionally poems based on the page parameter.
parameters:
- name: identifier
in: path
required: true
description: Author identifier (numeric ID or string username/URL part).
schema:
type: string # Use string even for ID to simplify path handling
example: "oreh-orehov"
- name: page
in: query
required: false
description: Controls poem fetching. `null` or empty = all poems, `0` = profile only, `N > 0` = specific page N. Defaults to `null`.
schema:
type: string # Allow 'null', '0', or positive integers as strings
example: "1"
- name: delay
in: query
required: false
description: Delay in ms between requests when fetching all pages (`page=null`). Defaults to 500ms.
schema:
type: integer
format: int32
minimum: 0
example: 500
responses:
'200':
description: Successful response with author data.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusSuccessResponse'
'400':
description: Invalid input parameter (identifier, page, or delay).
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'404':
description: Author not found.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'500':
description: Internal server error or error fetching/parsing data from stihirus.ru.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'502':
description: Bad Gateway (HTTP error from stihirus.ru).
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'503':
description: Service Unavailable (Network error connecting to stihirus.ru).
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
/author/{identifier}/filters:
get:
summary: Get Author Poem Filters
description: Fetches available filter options (rubrics, dates) for an author's poems.
parameters:
- name: identifier
in: path
required: true
description: Author identifier (numeric ID or string username/URL part).
schema:
type: string
example: "14260"
responses:
'200':
description: Successful response with filter data.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusFiltersSuccessResponse'
'400':
description: Invalid identifier format.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'404':
description: Author not found.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'500':
description: Internal server error or error fetching/parsing data from stihirus.ru.
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'502':
description: Bad Gateway (HTTP error from stihirus.ru).
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
'503':
description: Service Unavailable (Network error connecting to stihirus.ru).
content:
application/json:
schema:
$ref: '#/components/schemas/StihirusErrorResponse'
components:
schemas:
StihirusError:
type: object
properties:
code:
type: integer
format: int32
description: HTTP status or custom error code.
message:
type: string
description: Error message.
originalMessage:
type: string
description: Optional underlying error message.
required:
- code
- message
StihirusErrorResponse:
type: object
properties:
status:
type: string
enum: [error]
error:
$ref: '#/components/schemas/StihirusError'
required:
- status
- error
StihirusAuthorStats:
type: object
properties:
poems:
type: integer
description: Total number of poems (from profile HTML).
reviewsSent:
type: integer
description: Number of reviews sent.
reviewsReceived:
type: integer
description: Number of reviews received.
required:
- poems
- reviewsSent
- reviewsReceived
StihirusCollectionInfo:
type: object
properties:
name:
type: string
description: Collection name.
url:
type: string
format: url
description: Full URL to the collection.
required:
- name
- url
StihirusPoemRubric:
type: object
properties:
name:
type: string
description: Rubric name.
url:
type: string
format: url
nullable: true
description: Full URL to the rubric page, or null.
required:
- name
- url
StihirusPoem:
type: object
properties:
id:
type: integer
format: int64
description: Unique ID.
title:
type: string
description: Title (or '***').
text:
type: string
description: Full text.
created:
type: string
description: Creation date/time string (e.g., "27.03.2025 20:19").
rubric:
$ref: '#/components/schemas/StihirusPoemRubric'
collection:
type: string
nullable: true
description: Author's collection name, or null.
rating:
type: integer
description: Likes count.
commentsCount:
type: integer
description: Comments count.
imageUrl:
type: string
format: url
nullable: true
description: URL to poem's image, or null.
hasCertificate:
type: boolean
description: Whether it has a certificate.
required:
- id
- title
- text
- created
- rubric
- collection
- rating
- commentsCount
- imageUrl
- hasCertificate
StihirusAuthorData:
type: object
properties:
authorId:
type: integer
format: int64
username:
type: string
profileUrl:
type: string
format: url
canonicalUsername:
type: string
description:
type: string
avatarUrl:
type: string
format: url
nullable: true
headerUrl:
type: string
format: url
nullable: true
status:
type: string
lastVisit:
type: string
stats:
$ref: '#/components/schemas/StihirusAuthorStats'
collections:
type: array
items:
$ref: '#/components/schemas/StihirusCollectionInfo'
poems:
type: array
items:
$ref: '#/components/schemas/StihirusPoem'
required:
- authorId
- username
- profileUrl
- canonicalUsername
- description
- avatarUrl
- headerUrl
- status
- lastVisit
- stats
- collections
- poems
StihirusSuccessResponse:
type: object
properties:
status:
type: string
enum: [success]
data:
$ref: '#/components/schemas/StihirusAuthorData'
required:
- status
- data
StihirusFilterRubric:
type: object
properties:
id:
type: integer
description: Rubric ID used for filtering.
name:
type: string
description: Display name of the rubric.
count:
type: integer
description: Number of poems in this rubric.
required:
- id
- name
- count
StihirusFilterDate:
type: object
properties:
year:
type: integer
description: Year used for filtering.
month:
type: integer
description: Month used for filtering (1-12).
count:
type: integer
description: Number of poems published in this month/year.
required:
- year
- month
- count
StihirusAuthorFiltersData:
type: object
properties:
rubrics:
type: array
items:
$ref: '#/components/schemas/StihirusFilterRubric'
dates:
type: array
items:
$ref: '#/components/schemas/StihirusFilterDate'
required:
- rubrics
- dates
StihirusFiltersSuccessResponse:
type: object
properties:
status:
type: string
enum: [success]
data:
$ref: '#/components/schemas/StihirusAuthorFiltersData'
required:
- status
- data |