| 1 |
swagger: '2.0' |
| 2 |
info: |
| 3 |
title: Snippets API |
| 4 |
description: |- |
| 5 |
This is a demo project for the [drf-yasg](https://github.com/axnsan12/drf-yasg) Django Rest Framework library. |
| 6 |
|
| 7 |
The `swagger-ui` view can be found [here](/cached/swagger). |
| 8 |
The `ReDoc` view can be found [here](/cached/redoc). |
| 9 |
The swagger YAML document can be found [here](/cached/swagger.yaml). |
| 10 |
|
| 11 |
You can log in using the pre-existing `admin` user with password `passwordadmin`. |
| 12 |
termsOfService: https://www.google.com/policies/terms/ |
| 13 |
contact: |
| 14 |
email: [email protected] |
| 15 |
license: |
| 16 |
name: BSD License |
| 17 |
version: v1 |
| 18 |
host: test.local:8002 |
| 19 |
schemes: |
| 20 |
- http |
| 21 |
basePath: / |
| 22 |
consumes: |
| 23 |
- application/json |
| 24 |
produces: |
| 25 |
- application/json |
| 26 |
securityDefinitions: |
| 27 |
Basic: |
| 28 |
type: basic |
| 29 |
Bearer: |
| 30 |
in: header |
| 31 |
name: Authorization |
| 32 |
type: apiKey |
| 33 |
OAuth2 password: |
| 34 |
flow: password |
| 35 |
scopes: |
| 36 |
read: Read everything. |
| 37 |
write: Write everything, |
| 38 |
tokenUrl: /o/token/ |
| 39 |
type: oauth2 |
| 40 |
Query: |
| 41 |
in: query |
| 42 |
name: auth |
| 43 |
type: apiKey |
| 44 |
security: |
| 45 |
- Basic: [] |
| 46 |
- Bearer: [] |
| 47 |
- OAuth2 password: [] |
| 48 |
- Query: [] |
| 49 |
paths: |
| 50 |
/articles/: |
| 51 |
get: |
| 52 |
operationId: articles_list |
| 53 |
description: description from swagger_auto_schema via method_decorator |
| 54 |
parameters: |
| 55 |
- name: title |
| 56 |
in: query |
| 57 |
description: Filter the returned list by title |
| 58 |
required: false |
| 59 |
type: string |
| 60 |
- name: ordering |
| 61 |
in: query |
| 62 |
description: Which field to use when ordering the results. |
| 63 |
required: false |
| 64 |
type: string |
| 65 |
- name: limit |
| 66 |
in: query |
| 67 |
description: Number of results to return per page. |
| 68 |
required: false |
| 69 |
type: integer |
| 70 |
- name: offset |
| 71 |
in: query |
| 72 |
description: The initial index from which to return the results. |
| 73 |
required: false |
| 74 |
type: integer |
| 75 |
responses: |
| 76 |
'200': |
| 77 |
description: '' |
| 78 |
schema: |
| 79 |
required: |
| 80 |
- count |
| 81 |
- results |
| 82 |
type: object |
| 83 |
properties: |
| 84 |
count: |
| 85 |
type: integer |
| 86 |
next: |
| 87 |
type: string |
| 88 |
format: uri |
| 89 |
x-nullable: true |
| 90 |
previous: |
| 91 |
type: string |
| 92 |
format: uri |
| 93 |
x-nullable: true |
| 94 |
results: |
| 95 |
type: array |
| 96 |
items: |
| 97 |
$ref: '#/definitions/Article' |
| 98 |
tags: |
| 99 |
- articles |
| 100 |
post: |
| 101 |
operationId: articles_create |
| 102 |
description: ArticleViewSet class docstring |
| 103 |
parameters: |
| 104 |
- name: data |
| 105 |
in: body |
| 106 |
required: true |
| 107 |
schema: |
| 108 |
$ref: '#/definitions/Article' |
| 109 |
responses: |
| 110 |
'201': |
| 111 |
description: '' |
| 112 |
schema: |
| 113 |
$ref: '#/definitions/Article' |
| 114 |
tags: |
| 115 |
- articles |
| 116 |
parameters: [] |
| 117 |
/articles/today/: |
| 118 |
get: |
| 119 |
operationId: articles_today |
| 120 |
description: ArticleViewSet class docstring |
| 121 |
parameters: |
| 122 |
- name: title |
| 123 |
in: query |
| 124 |
description: Filter the returned list by title |
| 125 |
required: false |
| 126 |
type: string |
| 127 |
- name: ordering |
| 128 |
in: query |
| 129 |
description: Which field to use when ordering the results. |
| 130 |
required: false |
| 131 |
type: string |
| 132 |
responses: |
| 133 |
'200': |
| 134 |
description: '' |
| 135 |
schema: |
| 136 |
type: array |
| 137 |
items: |
| 138 |
$ref: '#/definitions/Article' |
| 139 |
tags: |
| 140 |
- articles |
| 141 |
parameters: [] |
| 142 |
/articles/{slug}/: |
| 143 |
get: |
| 144 |
operationId: articles_read |
| 145 |
description: retrieve class docstring |
| 146 |
parameters: [] |
| 147 |
responses: |
| 148 |
'200': |
| 149 |
description: '' |
| 150 |
schema: |
| 151 |
$ref: '#/definitions/Article' |
| 152 |
tags: |
| 153 |
- articles |
| 154 |
put: |
| 155 |
operationId: no_body_test |
| 156 |
description: update method docstring |
| 157 |
parameters: [] |
| 158 |
responses: |
| 159 |
'200': |
| 160 |
description: '' |
| 161 |
schema: |
| 162 |
$ref: '#/definitions/Article' |
| 163 |
tags: |
| 164 |
- articles |
| 165 |
patch: |
| 166 |
operationId: articles_partial_update |
| 167 |
summary: partial_update summary |
| 168 |
description: partial_update description override |
| 169 |
parameters: |
| 170 |
- name: data |
| 171 |
in: body |
| 172 |
required: true |
| 173 |
schema: |
| 174 |
$ref: '#/definitions/Article' |
| 175 |
responses: |
| 176 |
'200': |
| 177 |
description: '' |
| 178 |
schema: |
| 179 |
$ref: '#/definitions/Article' |
| 180 |
'404': |
| 181 |
description: slug not found |
| 182 |
tags: |
| 183 |
- articles |
| 184 |
deprecated: true |
| 185 |
delete: |
| 186 |
operationId: articles_delete |
| 187 |
description: destroy method docstring |
| 188 |
parameters: [] |
| 189 |
responses: |
| 190 |
'204': |
| 191 |
description: '' |
| 192 |
tags: |
| 193 |
- articles |
| 194 |
parameters: |
| 195 |
- name: slug |
| 196 |
in: path |
| 197 |
description: slug model help_text |
| 198 |
required: true |
| 199 |
type: string |
| 200 |
format: slug |
| 201 |
pattern: '[a-z0-9]+(?:-[a-z0-9]+)' |
| 202 |
/articles/{slug}/image/: |
| 203 |
get: |
| 204 |
operationId: articles_image_read |
| 205 |
description: image GET description override |
| 206 |
parameters: [] |
| 207 |
responses: |
| 208 |
'200': |
| 209 |
description: '' |
| 210 |
schema: |
| 211 |
$ref: '#/definitions/Article' |
| 212 |
consumes: |
| 213 |
- multipart/form-data |
| 214 |
tags: |
| 215 |
- articles |
| 216 |
post: |
| 217 |
operationId: articles_image_create |
| 218 |
description: image method docstring |
| 219 |
parameters: |
| 220 |
- name: what_am_i_doing |
| 221 |
in: formData |
| 222 |
description: test |
| 223 |
required: false |
| 224 |
type: string |
| 225 |
pattern: ^69$ |
| 226 |
default: '69' |
| 227 |
minLength: 1 |
| 228 |
x-nullable: true |
| 229 |
- name: image_styles |
| 230 |
in: formData |
| 231 |
description: Parameter with Items |
| 232 |
required: true |
| 233 |
type: array |
| 234 |
items: |
| 235 |
type: string |
| 236 |
enum: |
| 237 |
- wide |
| 238 |
- tall |
| 239 |
- thumb |
| 240 |
- social |
| 241 |
- name: upload |
| 242 |
in: formData |
| 243 |
description: image serializer help_text |
| 244 |
required: true |
| 245 |
type: file |
| 246 |
responses: |
| 247 |
'201': |
| 248 |
description: '' |
| 249 |
schema: |
| 250 |
$ref: '#/definitions/ImageUpload' |
| 251 |
consumes: |
| 252 |
- multipart/form-data |
| 253 |
tags: |
| 254 |
- articles |
| 255 |
delete: |
| 256 |
operationId: articles_image_delete |
| 257 |
description: image method docstring |
| 258 |
parameters: |
| 259 |
- name: delete_form_param |
| 260 |
in: formData |
| 261 |
description: this should not crash (form parameter on DELETE method) |
| 262 |
type: integer |
| 263 |
responses: |
| 264 |
'204': |
| 265 |
description: '' |
| 266 |
consumes: |
| 267 |
- multipart/form-data |
| 268 |
tags: |
| 269 |
- articles |
| 270 |
parameters: |
| 271 |
- name: slug |
| 272 |
in: path |
| 273 |
description: slug model help_text |
| 274 |
required: true |
| 275 |
type: string |
| 276 |
format: slug |
| 277 |
pattern: '[a-z0-9]+(?:-[a-z0-9]+)' |
| 278 |
/people/: |
| 279 |
get: |
| 280 |
operationId: people_list |
| 281 |
description: '' |
| 282 |
parameters: |
| 283 |
- name: unknown_paginator |
| 284 |
in: query |
| 285 |
type: string |
| 286 |
responses: |
| 287 |
'200': |
| 288 |
description: '' |
| 289 |
schema: |
| 290 |
type: array |
| 291 |
items: |
| 292 |
$ref: '#/definitions/Person' |
| 293 |
tags: |
| 294 |
- people |
| 295 |
post: |
| 296 |
operationId: people_create |
| 297 |
description: '' |
| 298 |
parameters: |
| 299 |
- name: data |
| 300 |
in: body |
| 301 |
required: true |
| 302 |
schema: |
| 303 |
$ref: '#/definitions/Person' |
| 304 |
responses: |
| 305 |
'201': |
| 306 |
description: '' |
| 307 |
schema: |
| 308 |
$ref: '#/definitions/Person' |
| 309 |
tags: |
| 310 |
- people |
| 311 |
parameters: [] |
| 312 |
/people/{id}: |
| 313 |
get: |
| 314 |
operationId: people_read |
| 315 |
description: '' |
| 316 |
parameters: [] |
| 317 |
responses: |
| 318 |
'200': |
| 319 |
description: '' |
| 320 |
schema: |
| 321 |
$ref: '#/definitions/Person' |
| 322 |
tags: |
| 323 |
- people |
| 324 |
patch: |
| 325 |
operationId: people_partial_update |
| 326 |
description: '' |
| 327 |
parameters: |
| 328 |
- name: data |
| 329 |
in: body |
| 330 |
required: true |
| 331 |
schema: |
| 332 |
$ref: '#/definitions/Person' |
| 333 |
responses: |
| 334 |
'200': |
| 335 |
description: '' |
| 336 |
schema: |
| 337 |
$ref: '#/definitions/Person' |
| 338 |
tags: |
| 339 |
- people |
| 340 |
delete: |
| 341 |
operationId: people_delete |
| 342 |
description: '' |
| 343 |
parameters: [] |
| 344 |
responses: |
| 345 |
'204': |
| 346 |
description: '' |
| 347 |
tags: |
| 348 |
- people |
| 349 |
parameters: |
| 350 |
- name: id |
| 351 |
in: path |
| 352 |
description: A unique integer value identifying this person. |
| 353 |
required: true |
| 354 |
type: integer |
| 355 |
/people/{person}/identity: |
| 356 |
get: |
| 357 |
operationId: people_identity_read |
| 358 |
description: '' |
| 359 |
parameters: [] |
| 360 |
responses: |
| 361 |
'200': |
| 362 |
description: '' |
| 363 |
schema: |
| 364 |
$ref: '#/definitions/Identity' |
| 365 |
tags: |
| 366 |
- people |
| 367 |
patch: |
| 368 |
operationId: people_identity_partial_update |
| 369 |
description: '' |
| 370 |
parameters: |
| 371 |
- name: data |
| 372 |
in: body |
| 373 |
required: true |
| 374 |
schema: |
| 375 |
$ref: '#/definitions/Identity' |
| 376 |
responses: |
| 377 |
'200': |
| 378 |
description: '' |
| 379 |
schema: |
| 380 |
$ref: '#/definitions/Identity' |
| 381 |
tags: |
| 382 |
- people |
| 383 |
parameters: |
| 384 |
- name: person |
| 385 |
in: path |
| 386 |
required: true |
| 387 |
type: string |
| 388 |
/plain/: |
| 389 |
get: |
| 390 |
operationId: plain_list |
| 391 |
description: '' |
| 392 |
parameters: [] |
| 393 |
responses: |
| 394 |
'200': |
| 395 |
description: '' |
| 396 |
tags: |
| 397 |
- plain |
| 398 |
parameters: [] |
| 399 |
/snippets/: |
| 400 |
get: |
| 401 |
operationId: snippetsList |
| 402 |
description: SnippetList classdoc |
| 403 |
parameters: [] |
| 404 |
responses: |
| 405 |
'200': |
| 406 |
description: '' |
| 407 |
schema: |
| 408 |
type: array |
| 409 |
items: |
| 410 |
$ref: '#/definitions/Snippet' |
| 411 |
tags: |
| 412 |
- snippets |
| 413 |
post: |
| 414 |
operationId: snippetsCreate |
| 415 |
description: post method docstring |
| 416 |
parameters: |
| 417 |
- name: data |
| 418 |
in: body |
| 419 |
required: true |
| 420 |
schema: |
| 421 |
$ref: '#/definitions/Snippet' |
| 422 |
responses: |
| 423 |
'201': |
| 424 |
description: '' |
| 425 |
schema: |
| 426 |
$ref: '#/definitions/Snippet' |
| 427 |
tags: |
| 428 |
- snippets |
| 429 |
delete: |
| 430 |
operationId: snippetsDeleteBulk |
| 431 |
summary: summary from docstring |
| 432 |
description: description body is here, summary is not included |
| 433 |
parameters: |
| 434 |
- name: data |
| 435 |
in: body |
| 436 |
required: true |
| 437 |
schema: |
| 438 |
type: object |
| 439 |
properties: |
| 440 |
body: |
| 441 |
description: this should not crash (request body on DELETE method) |
| 442 |
type: string |
| 443 |
responses: |
| 444 |
'204': |
| 445 |
description: '' |
| 446 |
tags: |
| 447 |
- snippets |
| 448 |
parameters: [] |
| 449 |
/snippets/views/{snippet_pk}/: |
| 450 |
get: |
| 451 |
operationId: snippetsViewsList |
| 452 |
description: SnippetViewerList classdoc |
| 453 |
parameters: |
| 454 |
- name: page |
| 455 |
in: query |
| 456 |
description: A page number within the paginated result set. |
| 457 |
required: false |
| 458 |
type: integer |
| 459 |
responses: |
| 460 |
'200': |
| 461 |
description: '' |
| 462 |
schema: |
| 463 |
required: |
| 464 |
- count |
| 465 |
- results |
| 466 |
type: object |
| 467 |
properties: |
| 468 |
count: |
| 469 |
type: integer |
| 470 |
next: |
| 471 |
type: string |
| 472 |
format: uri |
| 473 |
x-nullable: true |
| 474 |
previous: |
| 475 |
type: string |
| 476 |
format: uri |
| 477 |
x-nullable: true |
| 478 |
results: |
| 479 |
type: array |
| 480 |
items: |
| 481 |
$ref: '#/definitions/SnippetViewer' |
| 482 |
tags: |
| 483 |
- snippets |
| 484 |
parameters: |
| 485 |
- name: snippet_pk |
| 486 |
in: path |
| 487 |
required: true |
| 488 |
type: string |
| 489 |
/snippets/{id}/: |
| 490 |
get: |
| 491 |
operationId: snippetsRead |
| 492 |
description: SnippetDetail classdoc |
| 493 |
parameters: [] |
| 494 |
responses: |
| 495 |
'200': |
| 496 |
description: '' |
| 497 |
schema: |
| 498 |
$ref: '#/definitions/Snippet' |
| 499 |
tags: |
| 500 |
- snippets |
| 501 |
put: |
| 502 |
operationId: snippetsUpdate |
| 503 |
description: put class docstring |
| 504 |
parameters: |
| 505 |
- name: data |
| 506 |
in: body |
| 507 |
required: true |
| 508 |
schema: |
| 509 |
$ref: '#/definitions/Snippet' |
| 510 |
responses: |
| 511 |
'200': |
| 512 |
description: '' |
| 513 |
schema: |
| 514 |
$ref: '#/definitions/Snippet' |
| 515 |
tags: |
| 516 |
- snippets |
| 517 |
patch: |
| 518 |
operationId: snippetsPartialUpdate |
| 519 |
description: patch method docstring |
| 520 |
parameters: |
| 521 |
- name: data |
| 522 |
in: body |
| 523 |
required: true |
| 524 |
schema: |
| 525 |
$ref: '#/definitions/Snippet' |
| 526 |
responses: |
| 527 |
'200': |
| 528 |
description: '' |
| 529 |
schema: |
| 530 |
$ref: '#/definitions/Snippet' |
| 531 |
tags: |
| 532 |
- snippets |
| 533 |
delete: |
| 534 |
operationId: snippetsDelete |
| 535 |
description: delete method docstring |
| 536 |
parameters: |
| 537 |
- name: id |
| 538 |
in: path |
| 539 |
description: path parameter override |
| 540 |
required: true |
| 541 |
type: integer |
| 542 |
responses: |
| 543 |
'204': |
| 544 |
description: this should not crash (response object with no schema) |
| 545 |
tags: |
| 546 |
- snippets |
| 547 |
parameters: |
| 548 |
- name: id |
| 549 |
in: path |
| 550 |
description: A unique integer value identifying this snippet. |
| 551 |
required: true |
| 552 |
type: integer |
| 553 |
/todo/: |
| 554 |
get: |
| 555 |
operationId: todo_list |
| 556 |
description: '' |
| 557 |
parameters: [] |
| 558 |
responses: |
| 559 |
'200': |
| 560 |
description: '' |
| 561 |
schema: |
| 562 |
type: array |
| 563 |
items: |
| 564 |
$ref: '#/definitions/Todo' |
| 565 |
tags: |
| 566 |
- todo |
| 567 |
parameters: [] |
| 568 |
/todo/another/: |
| 569 |
get: |
| 570 |
operationId: todo_another_list |
| 571 |
description: '' |
| 572 |
parameters: [] |
| 573 |
responses: |
| 574 |
'200': |
| 575 |
description: '' |
| 576 |
schema: |
| 577 |
type: array |
| 578 |
items: |
| 579 |
$ref: '#/definitions/TodoAnother' |
| 580 |
tags: |
| 581 |
- todo |
| 582 |
parameters: [] |
| 583 |
/todo/another/{id}/: |
| 584 |
get: |
| 585 |
operationId: todo_another_read |
| 586 |
description: '' |
| 587 |
parameters: [] |
| 588 |
responses: |
| 589 |
'200': |
| 590 |
description: '' |
| 591 |
schema: |
| 592 |
$ref: '#/definitions/TodoAnother' |
| 593 |
tags: |
| 594 |
- todo |
| 595 |
parameters: |
| 596 |
- name: id |
| 597 |
in: path |
| 598 |
description: A unique integer value identifying this todo another. |
| 599 |
required: true |
| 600 |
type: integer |
| 601 |
/todo/harvest/: |
| 602 |
get: |
| 603 |
operationId: todo_harvest_list |
| 604 |
description: '' |
| 605 |
parameters: [] |
| 606 |
responses: |
| 607 |
'200': |
| 608 |
description: '' |
| 609 |
schema: |
| 610 |
type: array |
| 611 |
items: |
| 612 |
$ref: '#/definitions/Harvest' |
| 613 |
tags: |
| 614 |
- todo |
| 615 |
parameters: [] |
| 616 |
/todo/harvest/{id}/: |
| 617 |
put: |
| 618 |
operationId: todo_harvest_update |
| 619 |
description: '' |
| 620 |
parameters: |
| 621 |
- name: data |
| 622 |
in: body |
| 623 |
required: true |
| 624 |
schema: |
| 625 |
$ref: '#/definitions/Harvest' |
| 626 |
responses: |
| 627 |
'200': |
| 628 |
description: '' |
| 629 |
schema: |
| 630 |
$ref: '#/definitions/Harvest' |
| 631 |
tags: |
| 632 |
- todo |
| 633 |
patch: |
| 634 |
operationId: todo_harvest_partial_update |
| 635 |
description: '' |
| 636 |
parameters: |
| 637 |
- name: data |
| 638 |
in: body |
| 639 |
required: true |
| 640 |
schema: |
| 641 |
$ref: '#/definitions/Harvest' |
| 642 |
responses: |
| 643 |
'200': |
| 644 |
description: '' |
| 645 |
schema: |
| 646 |
$ref: '#/definitions/Harvest' |
| 647 |
tags: |
| 648 |
- todo |
| 649 |
parameters: |
| 650 |
- name: id |
| 651 |
in: path |
| 652 |
description: A unique integer value identifying this pack. |
| 653 |
required: true |
| 654 |
type: integer |
| 655 |
/todo/recursive/: |
| 656 |
get: |
| 657 |
operationId: todo_recursive_list |
| 658 |
description: '' |
| 659 |
parameters: [] |
| 660 |
responses: |
| 661 |
'200': |
| 662 |
description: '' |
| 663 |
schema: |
| 664 |
type: array |
| 665 |
items: |
| 666 |
$ref: '#/definitions/TodoRecursive' |
| 667 |
tags: |
| 668 |
- todo |
| 669 |
post: |
| 670 |
operationId: todo_recursive_create |
| 671 |
description: '' |
| 672 |
parameters: |
| 673 |
- name: data |
| 674 |
in: body |
| 675 |
required: true |
| 676 |
schema: |
| 677 |
$ref: '#/definitions/TodoRecursive' |
| 678 |
responses: |
| 679 |
'201': |
| 680 |
description: '' |
| 681 |
schema: |
| 682 |
$ref: '#/definitions/TodoRecursive' |
| 683 |
tags: |
| 684 |
- todo |
| 685 |
parameters: [] |
| 686 |
/todo/recursive/{id}/: |
| 687 |
get: |
| 688 |
operationId: todo_recursive_read |
| 689 |
description: '' |
| 690 |
parameters: [] |
| 691 |
responses: |
| 692 |
'302': |
| 693 |
description: Redirect somewhere |
| 694 |
tags: |
| 695 |
- todo |
| 696 |
put: |
| 697 |
operationId: todo_recursive_update |
| 698 |
description: '' |
| 699 |
parameters: |
| 700 |
- name: data |
| 701 |
in: body |
| 702 |
required: true |
| 703 |
schema: |
| 704 |
$ref: '#/definitions/TodoRecursive' |
| 705 |
responses: |
| 706 |
'200': |
| 707 |
description: '' |
| 708 |
schema: |
| 709 |
$ref: '#/definitions/TodoRecursive' |
| 710 |
tags: |
| 711 |
- todo |
| 712 |
patch: |
| 713 |
operationId: todo_recursive_partial_update |
| 714 |
description: '' |
| 715 |
parameters: |
| 716 |
- name: data |
| 717 |
in: body |
| 718 |
required: true |
| 719 |
schema: |
| 720 |
$ref: '#/definitions/TodoRecursive' |
| 721 |
responses: |
| 722 |
'200': |
| 723 |
description: '' |
| 724 |
schema: |
| 725 |
$ref: '#/definitions/TodoRecursive' |
| 726 |
tags: |
| 727 |
- todo |
| 728 |
delete: |
| 729 |
operationId: todo_recursive_delete |
| 730 |
description: '' |
| 731 |
parameters: [] |
| 732 |
responses: |
| 733 |
'204': |
| 734 |
description: '' |
| 735 |
tags: |
| 736 |
- todo |
| 737 |
parameters: |
| 738 |
- name: id |
| 739 |
in: path |
| 740 |
description: A unique integer value identifying this todo tree. |
| 741 |
required: true |
| 742 |
type: integer |
| 743 |
/todo/tree/: |
| 744 |
get: |
| 745 |
operationId: todo_tree_list |
| 746 |
description: '' |
| 747 |
parameters: [] |
| 748 |
responses: |
| 749 |
'200': |
| 750 |
description: '' |
| 751 |
schema: |
| 752 |
type: array |
| 753 |
items: |
| 754 |
$ref: '#/definitions/TodoTree' |
| 755 |
tags: |
| 756 |
- todo |
| 757 |
parameters: [] |
| 758 |
/todo/tree/{id}/: |
| 759 |
get: |
| 760 |
operationId: todo_tree_read |
| 761 |
description: '' |
| 762 |
parameters: [] |
| 763 |
responses: |
| 764 |
'200': |
| 765 |
description: '' |
| 766 |
schema: |
| 767 |
$ref: '#/definitions/TodoTree' |
| 768 |
tags: |
| 769 |
- todo |
| 770 |
parameters: |
| 771 |
- name: id |
| 772 |
in: path |
| 773 |
description: A unique integer value identifying this todo tree. |
| 774 |
required: true |
| 775 |
type: integer |
| 776 |
/todo/yetanother/: |
| 777 |
get: |
| 778 |
operationId: todo_yetanother_list |
| 779 |
description: '' |
| 780 |
parameters: [] |
| 781 |
responses: |
| 782 |
'200': |
| 783 |
description: '' |
| 784 |
schema: |
| 785 |
type: array |
| 786 |
items: |
| 787 |
$ref: '#/definitions/TodoYetAnother' |
| 788 |
tags: |
| 789 |
- todo |
| 790 |
parameters: [] |
| 791 |
/todo/yetanother/{id}/: |
| 792 |
get: |
| 793 |
operationId: todo_yetanother_read |
| 794 |
description: '' |
| 795 |
parameters: [] |
| 796 |
responses: |
| 797 |
'200': |
| 798 |
description: '' |
| 799 |
schema: |
| 800 |
$ref: '#/definitions/TodoYetAnother' |
| 801 |
tags: |
| 802 |
- todo |
| 803 |
parameters: |
| 804 |
- name: id |
| 805 |
in: path |
| 806 |
description: A unique integer value identifying this todo yet another. |
| 807 |
required: true |
| 808 |
type: integer |
| 809 |
/todo/{id}/: |
| 810 |
get: |
| 811 |
operationId: todo_read |
| 812 |
description: '' |
| 813 |
parameters: [] |
| 814 |
responses: |
| 815 |
'200': |
| 816 |
description: '' |
| 817 |
schema: |
| 818 |
$ref: '#/definitions/Todo' |
| 819 |
tags: |
| 820 |
- todo |
| 821 |
parameters: |
| 822 |
- name: id |
| 823 |
in: path |
| 824 |
description: A unique integer value identifying this todo. |
| 825 |
required: true |
| 826 |
type: integer |
| 827 |
/todo/{todo_id}/yetanothers/{yetanother_id}/: |
| 828 |
get: |
| 829 |
operationId: todo_yetanothers_read |
| 830 |
description: '' |
| 831 |
parameters: [] |
| 832 |
responses: |
| 833 |
'200': |
| 834 |
description: '' |
| 835 |
schema: |
| 836 |
$ref: '#/definitions/TodoYetAnother' |
| 837 |
tags: |
| 838 |
- todo |
| 839 |
parameters: |
| 840 |
- name: todo_id |
| 841 |
in: path |
| 842 |
required: true |
| 843 |
type: string |
| 844 |
- name: yetanother_id |
| 845 |
in: path |
| 846 |
required: true |
| 847 |
type: string |
| 848 |
/users/: |
| 849 |
get: |
| 850 |
operationId: users_list |
| 851 |
description: UserList cbv classdoc |
| 852 |
parameters: |
| 853 |
- name: username |
| 854 |
in: query |
| 855 |
description: this field is generated from a query_serializer |
| 856 |
required: false |
| 857 |
type: string |
| 858 |
minLength: 1 |
| 859 |
- name: is_staff |
| 860 |
in: query |
| 861 |
description: this one too! |
| 862 |
required: false |
| 863 |
type: boolean |
| 864 |
- name: styles |
| 865 |
in: query |
| 866 |
description: and this one is fancy! |
| 867 |
required: true |
| 868 |
type: array |
| 869 |
items: |
| 870 |
type: string |
| 871 |
enum: |
| 872 |
- a |
| 873 |
- b |
| 874 |
- c |
| 875 |
- d |
| 876 |
collectionFormat: multi |
| 877 |
responses: |
| 878 |
'200': |
| 879 |
description: '' |
| 880 |
schema: |
| 881 |
type: array |
| 882 |
items: |
| 883 |
$ref: '#/definitions/UserSerializer' |
| 884 |
tags: |
| 885 |
- Users |
| 886 |
post: |
| 887 |
operationId: users_create |
| 888 |
description: apiview post description override |
| 889 |
parameters: |
| 890 |
- name: data |
| 891 |
in: body |
| 892 |
required: true |
| 893 |
schema: |
| 894 |
required: |
| 895 |
- username |
| 896 |
type: object |
| 897 |
properties: |
| 898 |
username: |
| 899 |
type: string |
| 900 |
responses: |
| 901 |
'201': |
| 902 |
description: '' |
| 903 |
schema: |
| 904 |
required: |
| 905 |
- username |
| 906 |
type: object |
| 907 |
properties: |
| 908 |
username: |
| 909 |
type: string |
| 910 |
tags: |
| 911 |
- Users |
| 912 |
security: [] |
| 913 |
patch: |
| 914 |
operationId: users_dummy |
| 915 |
description: dummy operation |
| 916 |
parameters: [] |
| 917 |
responses: |
| 918 |
'200': |
| 919 |
description: '' |
| 920 |
tags: |
| 921 |
- Users |
| 922 |
parameters: [] |
| 923 |
/users/{id}/: |
| 924 |
get: |
| 925 |
operationId: users_read |
| 926 |
description: user_detail fbv docstring |
| 927 |
parameters: |
| 928 |
- name: test |
| 929 |
in: query |
| 930 |
description: test manual param |
| 931 |
type: boolean |
| 932 |
- name: test_array |
| 933 |
in: query |
| 934 |
description: test query array arg |
| 935 |
required: true |
| 936 |
type: array |
| 937 |
items: |
| 938 |
type: string |
| 939 |
collectionFormat: multi |
| 940 |
responses: |
| 941 |
'200': |
| 942 |
description: response description |
| 943 |
schema: |
| 944 |
$ref: '#/definitions/UserSerializer' |
| 945 |
tags: |
| 946 |
- Users |
| 947 |
put: |
| 948 |
operationId: users_update |
| 949 |
description: user_detail fbv docstring |
| 950 |
parameters: |
| 951 |
- name: data |
| 952 |
in: body |
| 953 |
required: true |
| 954 |
schema: |
| 955 |
$ref: '#/definitions/UserSerializer' |
| 956 |
responses: |
| 957 |
'200': |
| 958 |
description: '' |
| 959 |
schema: |
| 960 |
$ref: '#/definitions/UserSerializer' |
| 961 |
tags: |
| 962 |
- Users |
| 963 |
parameters: |
| 964 |
- name: id |
| 965 |
in: path |
| 966 |
required: true |
| 967 |
type: string |
| 968 |
definitions: |
| 969 |
Article: |
| 970 |
required: |
| 971 |
- title |
| 972 |
- body |
| 973 |
- group |
| 974 |
type: object |
| 975 |
properties: |
| 976 |
title: |
| 977 |
description: title model help_text |
| 978 |
type: string |
| 979 |
maxLength: 255 |
| 980 |
minLength: 1 |
| 981 |
author: |
| 982 |
description: The ID of the user that created this article; if none is provided, |
| 983 |
defaults to the currently logged in user. |
| 984 |
type: integer |
| 985 |
default: 1 |
| 986 |
body: |
| 987 |
description: body serializer help_text |
| 988 |
type: string |
| 989 |
maxLength: 5000 |
| 990 |
minLength: 1 |
| 991 |
slug: |
| 992 |
description: slug model help_text |
| 993 |
type: string |
| 994 |
format: slug |
| 995 |
pattern: ^[-a-zA-Z0-9_]+$ |
| 996 |
maxLength: 50 |
| 997 |
date_created: |
| 998 |
type: string |
| 999 |
format: date-time |
| 1000 |
readOnly: true |
| 1001 |
date_modified: |
| 1002 |
type: string |
| 1003 |
format: date-time |
| 1004 |
readOnly: true |
| 1005 |
read_only_nullable: |
| 1006 |
type: string |
| 1007 |
readOnly: true |
| 1008 |
minLength: 1 |
| 1009 |
x-nullable: true |
| 1010 |
references: |
| 1011 |
description: this is a really bad example |
| 1012 |
type: object |
| 1013 |
additionalProperties: |
| 1014 |
description: but i needed to test these 2 fields somehow |
| 1015 |
type: string |
| 1016 |
format: uri |
| 1017 |
minLength: 1 |
| 1018 |
readOnly: true |
| 1019 |
uuid: |
| 1020 |
description: should articles have UUIDs? |
| 1021 |
type: string |
| 1022 |
format: uuid |
| 1023 |
readOnly: true |
| 1024 |
cover: |
| 1025 |
type: string |
| 1026 |
readOnly: true |
| 1027 |
format: uri |
| 1028 |
cover_name: |
| 1029 |
type: string |
| 1030 |
readOnly: true |
| 1031 |
article_type: |
| 1032 |
description: IntegerField declared on model with choices=(...) and exposed |
| 1033 |
via ModelSerializer |
| 1034 |
type: integer |
| 1035 |
enum: |
| 1036 |
- 1 |
| 1037 |
- 2 |
| 1038 |
- 3 |
| 1039 |
- 7 |
| 1040 |
- 8 |
| 1041 |
x-nullable: true |
| 1042 |
group: |
| 1043 |
type: string |
| 1044 |
format: uuid |
| 1045 |
original_group: |
| 1046 |
type: string |
| 1047 |
format: uuid |
| 1048 |
readOnly: true |
| 1049 |
ImageUpload: |
| 1050 |
required: |
| 1051 |
- image_styles |
| 1052 |
type: object |
| 1053 |
properties: |
| 1054 |
image_id: |
| 1055 |
type: string |
| 1056 |
format: uuid |
| 1057 |
readOnly: true |
| 1058 |
what_am_i_doing: |
| 1059 |
description: test |
| 1060 |
type: string |
| 1061 |
pattern: ^69$ |
| 1062 |
default: '69' |
| 1063 |
minLength: 1 |
| 1064 |
x-nullable: true |
| 1065 |
image_styles: |
| 1066 |
description: Parameter with Items |
| 1067 |
type: array |
| 1068 |
items: |
| 1069 |
type: string |
| 1070 |
enum: |
| 1071 |
- wide |
| 1072 |
- tall |
| 1073 |
- thumb |
| 1074 |
- social |
| 1075 |
upload: |
| 1076 |
description: image serializer help_text |
| 1077 |
type: string |
| 1078 |
readOnly: true |
| 1079 |
format: uri |
| 1080 |
Identity: |
| 1081 |
type: object |
| 1082 |
properties: |
| 1083 |
id: |
| 1084 |
title: ID |
| 1085 |
type: integer |
| 1086 |
readOnly: true |
| 1087 |
first_name: |
| 1088 |
title: First name |
| 1089 |
type: string |
| 1090 |
maxLength: 30 |
| 1091 |
minLength: 1 |
| 1092 |
x-nullable: true |
| 1093 |
last_name: |
| 1094 |
title: Last name |
| 1095 |
description: <strong>Here's some HTML!</strong> |
| 1096 |
type: string |
| 1097 |
maxLength: 30 |
| 1098 |
minLength: 1 |
| 1099 |
x-nullable: true |
| 1100 |
Person: |
| 1101 |
required: |
| 1102 |
- identity |
| 1103 |
type: object |
| 1104 |
properties: |
| 1105 |
id: |
| 1106 |
title: ID |
| 1107 |
type: integer |
| 1108 |
readOnly: true |
| 1109 |
identity: |
| 1110 |
$ref: '#/definitions/Identity' |
| 1111 |
Project: |
| 1112 |
required: |
| 1113 |
- projectName |
| 1114 |
- githubRepo |
| 1115 |
type: object |
| 1116 |
properties: |
| 1117 |
projectName: |
| 1118 |
title: project name custom title |
| 1119 |
description: Name of the project |
| 1120 |
type: string |
| 1121 |
minLength: 1 |
| 1122 |
githubRepo: |
| 1123 |
title: Github repo |
| 1124 |
description: Github repository of the project |
| 1125 |
type: string |
| 1126 |
minLength: 1 |
| 1127 |
Snippet: |
| 1128 |
required: |
| 1129 |
- code |
| 1130 |
- tags |
| 1131 |
- language |
| 1132 |
- nullableSecondaryLanguage |
| 1133 |
type: object |
| 1134 |
properties: |
| 1135 |
id: |
| 1136 |
title: Id |
| 1137 |
description: id serializer help text |
| 1138 |
type: integer |
| 1139 |
readOnly: true |
| 1140 |
created: |
| 1141 |
title: Client date time suu |
| 1142 |
type: string |
| 1143 |
format: integer |
| 1144 |
readOnly: true |
| 1145 |
description: Date time in unix timestamp format |
| 1146 |
owner: |
| 1147 |
title: Owner |
| 1148 |
description: The ID of the user that created this snippet; if none is provided, |
| 1149 |
defaults to the currently logged in user. |
| 1150 |
type: integer |
| 1151 |
default: 1 |
| 1152 |
ownerAsString: |
| 1153 |
description: The ID of the user that created this snippet. |
| 1154 |
type: string |
| 1155 |
readOnly: true |
| 1156 |
minLength: 1 |
| 1157 |
title: Owner as string |
| 1158 |
title: |
| 1159 |
title: Title |
| 1160 |
type: string |
| 1161 |
maxLength: 100 |
| 1162 |
code: |
| 1163 |
title: Code |
| 1164 |
type: string |
| 1165 |
minLength: 1 |
| 1166 |
tags: |
| 1167 |
type: array |
| 1168 |
items: |
| 1169 |
type: string |
| 1170 |
minLength: 2 |
| 1171 |
maxItems: 15 |
| 1172 |
minItems: 3 |
| 1173 |
linenos: |
| 1174 |
title: Linenos |
| 1175 |
type: boolean |
| 1176 |
language: |
| 1177 |
description: Sample help text for language |
| 1178 |
type: object |
| 1179 |
properties: |
| 1180 |
name: |
| 1181 |
title: Name |
| 1182 |
description: The name of the programming language |
| 1183 |
type: string |
| 1184 |
enum: |
| 1185 |
- cpp |
| 1186 |
- js |
| 1187 |
- python |
| 1188 |
default: python |
| 1189 |
readOnlyNullable: |
| 1190 |
title: Read only nullable |
| 1191 |
type: string |
| 1192 |
readOnly: true |
| 1193 |
minLength: 1 |
| 1194 |
x-nullable: true |
| 1195 |
styles: |
| 1196 |
type: array |
| 1197 |
items: |
| 1198 |
type: string |
| 1199 |
enum: |
| 1200 |
- monokai |
| 1201 |
- solarized-dark |
| 1202 |
- vim |
| 1203 |
default: |
| 1204 |
- solarized-dark |
| 1205 |
lines: |
| 1206 |
type: array |
| 1207 |
items: |
| 1208 |
type: integer |
| 1209 |
x-nullable: true |
| 1210 |
exampleProjects: |
| 1211 |
type: array |
| 1212 |
items: |
| 1213 |
$ref: '#/definitions/Project' |
| 1214 |
readOnly: true |
| 1215 |
maxItems: 100 |
| 1216 |
difficultyFactor: |
| 1217 |
title: Difficulty factor |
| 1218 |
description: this is here just to test FloatField |
| 1219 |
type: number |
| 1220 |
readOnly: true |
| 1221 |
default: 6.9 |
| 1222 |
rateAsString: |
| 1223 |
title: Rate as string |
| 1224 |
type: string |
| 1225 |
format: decimal |
| 1226 |
default: '0.000' |
| 1227 |
rate: |
| 1228 |
title: Rate |
| 1229 |
type: number |
| 1230 |
format: decimal |
| 1231 |
default: 0.0 |
| 1232 |
minimum: 0.0 |
| 1233 |
nullableSecondaryLanguage: |
| 1234 |
type: object |
| 1235 |
properties: |
| 1236 |
name: |
| 1237 |
title: Name |
| 1238 |
description: The name of the programming language |
| 1239 |
type: string |
| 1240 |
enum: |
| 1241 |
- cpp |
| 1242 |
- js |
| 1243 |
- python |
| 1244 |
default: python |
| 1245 |
readOnlyNullable: |
| 1246 |
title: Read only nullable |
| 1247 |
type: string |
| 1248 |
readOnly: true |
| 1249 |
minLength: 1 |
| 1250 |
x-nullable: true |
| 1251 |
x-nullable: true |
| 1252 |
SnippetViewer: |
| 1253 |
required: |
| 1254 |
- snippet |
| 1255 |
- viewer |
| 1256 |
type: object |
| 1257 |
properties: |
| 1258 |
id: |
| 1259 |
title: ID |
| 1260 |
type: integer |
| 1261 |
readOnly: true |
| 1262 |
snippet: |
| 1263 |
title: Snippet |
| 1264 |
type: integer |
| 1265 |
viewer: |
| 1266 |
title: Viewer |
| 1267 |
type: integer |
| 1268 |
Todo: |
| 1269 |
required: |
| 1270 |
- title |
| 1271 |
type: object |
| 1272 |
properties: |
| 1273 |
title: |
| 1274 |
title: Title |
| 1275 |
type: string |
| 1276 |
maxLength: 50 |
| 1277 |
minLength: 1 |
| 1278 |
TodoAnother: |
| 1279 |
required: |
| 1280 |
- title |
| 1281 |
- todo |
| 1282 |
type: object |
| 1283 |
properties: |
| 1284 |
title: |
| 1285 |
title: Title |
| 1286 |
type: string |
| 1287 |
maxLength: 50 |
| 1288 |
minLength: 1 |
| 1289 |
todo: |
| 1290 |
$ref: '#/definitions/Todo' |
| 1291 |
Harvest: |
| 1292 |
type: object |
| 1293 |
properties: |
| 1294 |
size_code: |
| 1295 |
title: Size code |
| 1296 |
type: string |
| 1297 |
enum: |
| 1298 |
- '50' |
| 1299 |
- '100' |
| 1300 |
- '200' |
| 1301 |
readOnly: true |
| 1302 |
TodoRecursive: |
| 1303 |
required: |
| 1304 |
- title |
| 1305 |
type: object |
| 1306 |
properties: |
| 1307 |
id: |
| 1308 |
title: ID |
| 1309 |
type: integer |
| 1310 |
readOnly: true |
| 1311 |
title: |
| 1312 |
title: Title |
| 1313 |
type: string |
| 1314 |
maxLength: 50 |
| 1315 |
minLength: 1 |
| 1316 |
parent: |
| 1317 |
$ref: '#/definitions/TodoRecursive' |
| 1318 |
parent_id: |
| 1319 |
type: integer |
| 1320 |
title: Parent id |
| 1321 |
x-nullable: true |
| 1322 |
TodoTree: |
| 1323 |
required: |
| 1324 |
- title |
| 1325 |
- children |
| 1326 |
- many_children |
| 1327 |
type: object |
| 1328 |
properties: |
| 1329 |
id: |
| 1330 |
title: ID |
| 1331 |
type: integer |
| 1332 |
readOnly: true |
| 1333 |
title: |
| 1334 |
title: Title |
| 1335 |
type: string |
| 1336 |
maxLength: 50 |
| 1337 |
minLength: 1 |
| 1338 |
children: |
| 1339 |
type: array |
| 1340 |
items: |
| 1341 |
$ref: '#/definitions/TodoTree' |
| 1342 |
many_children: |
| 1343 |
type: array |
| 1344 |
items: |
| 1345 |
$ref: '#/definitions/TodoTree' |
| 1346 |
TodoYetAnother: |
| 1347 |
required: |
| 1348 |
- title |
| 1349 |
type: object |
| 1350 |
properties: |
| 1351 |
title: |
| 1352 |
title: Title |
| 1353 |
type: string |
| 1354 |
maxLength: 50 |
| 1355 |
minLength: 1 |
| 1356 |
todo: |
| 1357 |
required: |
| 1358 |
- title |
| 1359 |
type: object |
| 1360 |
properties: |
| 1361 |
id: |
| 1362 |
title: ID |
| 1363 |
type: integer |
| 1364 |
readOnly: true |
| 1365 |
title: |
| 1366 |
title: Title |
| 1367 |
type: string |
| 1368 |
maxLength: 50 |
| 1369 |
minLength: 1 |
| 1370 |
todo: |
| 1371 |
required: |
| 1372 |
- title |
| 1373 |
type: object |
| 1374 |
properties: |
| 1375 |
id: |
| 1376 |
title: ID |
| 1377 |
type: integer |
| 1378 |
readOnly: true |
| 1379 |
title: |
| 1380 |
title: Title |
| 1381 |
type: string |
| 1382 |
maxLength: 50 |
| 1383 |
minLength: 1 |
| 1384 |
readOnly: true |
| 1385 |
readOnly: true |
| 1386 |
example: |
| 1387 |
title: parent |
| 1388 |
todo: |
| 1389 |
title: child |
| 1390 |
todo: null |
| 1391 |
OtherStuff: |
| 1392 |
description: the decorator should determine the serializer class for this |
| 1393 |
required: |
| 1394 |
- foo |
| 1395 |
type: object |
| 1396 |
properties: |
| 1397 |
foo: |
| 1398 |
title: Foo |
| 1399 |
type: string |
| 1400 |
minLength: 1 |
| 1401 |
MethodFieldExample: |
| 1402 |
type: object |
| 1403 |
properties: |
| 1404 |
hinted_bool: |
| 1405 |
title: Hinted bool |
| 1406 |
description: the type hint on the method should determine this to be a bool |
| 1407 |
type: boolean |
| 1408 |
readOnly: true |
| 1409 |
hinted_int: |
| 1410 |
title: Hinted int |
| 1411 |
description: the type hint on the method should determine this to be an integer |
| 1412 |
type: integer |
| 1413 |
readOnly: true |
| 1414 |
hinted_float: |
| 1415 |
title: Hinted float |
| 1416 |
description: the type hint on the method should determine this to be a number |
| 1417 |
type: number |
| 1418 |
readOnly: true |
| 1419 |
hinted_decimal: |
| 1420 |
title: Hinted decimal |
| 1421 |
description: the type hint on the method should determine this to be a decimal |
| 1422 |
type: string |
| 1423 |
format: decimal |
| 1424 |
readOnly: true |
| 1425 |
hinted_datetime: |
| 1426 |
title: Hinted datetime |
| 1427 |
description: the type hint on the method should determine this to be a datetime |
| 1428 |
type: string |
| 1429 |
format: date-time |
| 1430 |
readOnly: true |
| 1431 |
hinted_date: |
| 1432 |
title: Hinted date |
| 1433 |
description: the type hint on the method should determine this to be a date |
| 1434 |
type: string |
| 1435 |
format: date |
| 1436 |
readOnly: true |
| 1437 |
hinted_uuid: |
| 1438 |
title: Hinted uuid |
| 1439 |
description: the type hint on the method should determine this to be a uuid |
| 1440 |
type: string |
| 1441 |
format: uuid |
| 1442 |
readOnly: true |
| 1443 |
hinted_unknown: |
| 1444 |
title: Hinted unknown |
| 1445 |
description: type hint is unknown, so is expected to fallback to string |
| 1446 |
type: string |
| 1447 |
readOnly: true |
| 1448 |
non_hinted_number: |
| 1449 |
title: Non hinted number |
| 1450 |
description: No hint on the method, so this is expected to fallback to string |
| 1451 |
type: string |
| 1452 |
readOnly: true |
| 1453 |
UserSerializer: |
| 1454 |
required: |
| 1455 |
- username |
| 1456 |
- articles |
| 1457 |
- snippets |
| 1458 |
- hint_example |
| 1459 |
type: object |
| 1460 |
properties: |
| 1461 |
id: |
| 1462 |
title: ID |
| 1463 |
type: integer |
| 1464 |
readOnly: true |
| 1465 |
username: |
| 1466 |
title: Username |
| 1467 |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ |
| 1468 |
only. |
| 1469 |
type: string |
| 1470 |
pattern: ^[\w.@+-]+$ |
| 1471 |
maxLength: 150 |
| 1472 |
minLength: 1 |
| 1473 |
email: |
| 1474 |
title: Email address |
| 1475 |
type: string |
| 1476 |
format: email |
| 1477 |
maxLength: 254 |
| 1478 |
articles: |
| 1479 |
type: array |
| 1480 |
items: |
| 1481 |
type: integer |
| 1482 |
uniqueItems: true |
| 1483 |
snippets: |
| 1484 |
type: array |
| 1485 |
items: |
| 1486 |
type: integer |
| 1487 |
uniqueItems: true |
| 1488 |
last_connected_ip: |
| 1489 |
title: Last connected ip |
| 1490 |
description: i'm out of ideas |
| 1491 |
type: string |
| 1492 |
format: ipv4 |
| 1493 |
readOnly: true |
| 1494 |
minLength: 1 |
| 1495 |
last_connected_at: |
| 1496 |
title: Last connected at |
| 1497 |
description: really? |
| 1498 |
type: string |
| 1499 |
format: date |
| 1500 |
readOnly: true |
| 1501 |
article_slugs: |
| 1502 |
type: array |
| 1503 |
items: |
| 1504 |
type: string |
| 1505 |
format: slug |
| 1506 |
pattern: ^[-a-zA-Z0-9_]+$ |
| 1507 |
readOnly: true |
| 1508 |
uniqueItems: true |
| 1509 |
other_stuff: |
| 1510 |
$ref: '#/definitions/OtherStuff' |
| 1511 |
hint_example: |
| 1512 |
$ref: '#/definitions/MethodFieldExample' |
| 1513 |
help_text_example_1: |
| 1514 |
title: Help text example 1 |
| 1515 |
description: help text on field is set, so this should appear in swagger |
| 1516 |
type: integer |
| 1517 |
readOnly: true |
| 1518 |
help_text_example_2: |
| 1519 |
title: Help text example 2 |
| 1520 |
description: instance help_text is set, so should appear in swagger |
| 1521 |
type: integer |
| 1522 |
readOnly: true |
| 1523 |
help_text_example_3: |
| 1524 |
title: Help text example 3 |
| 1525 |
description: |2 |
| 1526 |
|
| 1527 |
docstring is set so should appear in swagger as fallback |
| 1528 |
:return: |
| 1529 |
type: integer |
| 1530 |
readOnly: true |