Spaces:
Running
Running
File size: 19,694 Bytes
66ca64a |
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 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
openapi: 3.0.0
info:
title: Providing Examples
description: Providing Examples
version: 1.0.0
paths:
/multiple-examples-in-request-parameters/{path-param-1}/{path-param-2}:
get:
tags:
- Providing Examples
parameters:
- name: 'path-param-1'
in: 'path'
schema:
type: 'string'
default: "p1-opt-2"
examples:
example1:
value: "p1-opt-1"
example2:
value: "p1-opt-2"
- name: 'path-param-2'
in: 'path'
schema:
type: 'string'
examples:
example1:
value: "p2-opt-1"
example2:
value: "p2-opt-2"
- name: 'age'
description: Single Example
in: 'query'
schema:
type: 'number'
example: 24
- name: 'country-code'
description: Multiple examples _(Notice `us` do not have a summary)_
in: 'query'
schema:
type: 'string'
default: " "
examples:
example1:
value: "uk"
summary: "United Kingdom"
example2:
value: "us"
example3:
value: "ch"
summary: "China"
- name: 'marital-status'
in: 'query'
schema:
type: 'string'
default: "unmarried"
examples:
example1:
value: "married"
example2:
value: "unmarried"
example3:
value: "widowed"
- name: luckyNumbers
in: query
schema:
type: array
items:
type: number
minItems: 4
maxItems: 4
examples:
- ""
- " "
- [10]
- [10, 20, 30, 40]
/multiple-examples-by-response-type:
get:
description: Multiple Examples provide for each media-type (`application/json` or `application/json`)
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
age:
description: Person Age
type: integer
fullName:
description: Person Full name
type: object
properties:
firstName:
description: First name
type: string
lastName:
description: Last name
type: string
examples:
valid-json:
summary: Example with Valid JSON String
description: If valid JSON is provided in the example, It will be displayed in JSON tree form. Allowing copy/expand/collapse functionality
value: |
{
"person": {
"fullName": {
"firstName": "Mickey",
"lastName": "Mouse"
},
"age": "9"
}
}
invalid-json:
summary: Example with Invalid JSON String
description: Invalid JSON is displayed in text-area as is
value: |
{
person: {
fullName: {
firstName: Donald,
lastName: Duck
},
age: 10
}
}
as-object:
summary: Example specified as object
value:
fullName:
firstName: Donald
lastName: Duck
age: 10
application/xml:
schema:
type: object
properties:
age:
description: Person Age
type: integer
fullName:
description: Person Full name
type: object
properties:
firstName:
description: First name
type: string
lastName:
description: Last name
type: string
examples:
example-1:
description: Exmple 1 Description
value: |
<root>
<person>
<fullName>
<firstName> Mickey </firstName>
<lastName> Mouse </lastName>
</fullName>
<age> 9 </age>
</person>
</root>
/single-example-by-response-type:
get:
summary: Single Example at schema Level
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
age:
description: Person Age
type: integer
fullName:
description: Person Full name
type: object
properties:
firstName:
description: First name
type: string
lastName:
description: Last name
type: string
example: |
{
age: 10,
fullName: {
firstName: Donald,
lastName: Duck
}
}
/example-with-array-1:
get:
summary: Single Example at schema Level
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ArrayOfInt-1"
/example-with-array-2:
get:
summary: Single Example at schema Level
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ArrayOfInt-2"
/object-example-for-a-schema:
get:
summary: Single example having invalid JSON, under a Schema
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
age:
description: Person Age
type: integer
fullName:
description: Person Full name
type: object
properties:
firstName:
description: First name
type: string
lastName:
description: Last name
type: string
example: |
{
person: {
fullName: {
firstName: Donald,
lastName: Duck
},
age: 10
}
}
/array-example-for-a-schema:
get:
summary: Single Example of Type Array Under a Schema
tags:
- Providing Examples
responses:
'200':
description: An array of currency codes
content:
application/json:
schema:
$ref: "#/components/schemas/currencies"
/example-with-simple-object:
get:
summary: Single Example of Type Array Under a Schema
tags:
- Providing Examples
responses:
'200':
description: An array of currency codes
content:
application/json:
schema:
$ref: "#/components/schemas/PersonObject"
/per-field-example-with-root-as-object:
get:
summary: Root node of the example is an object. and the object is constituted using field level example
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
age:
description: Person Age
type: integer
example: 8
fullName:
description: Person Full name
type: object
properties:
firstName:
description: First name
type: string
example: 'Daisy'
lastName:
description: Last name
type: string
example: 'Duck'
dependents:
type: array
items:
type: object
properties:
dependentName:
type: string
relation:
type: string
age:
type: number
/per-field-example-with-root-as-array:
get:
summary: Root node of the example is an array. and the object is constituted using field level example
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
type: object
properties:
dependentName:
type: string
relation:
type: string
age:
type: number
example:
dependentName: Natasha
relation: wife
age: 28
/example-with-refs:
get:
description: |
When a Schema definition is `provided` as a ref
(provide the example at schema-level)
tags:
- Providing Examples
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cost'
examples:
USD:
description: Cost in `US Dollars`
value: |
{
amount: 10,
currency: USD
}
INR:
description: Cost in `Indian Rupees`
value: |
{
amount: 700,
currency: INR
}
/multiple-example-in-request-body:
post:
summary: Request body with multiple examples
tags:
- Providing Examples
requestBody:
description: Request body containing **multiple** examples
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cost'
examples:
USD:
description: Cost in `US Dollars`
value: |
{
amount: 10,
currency: USD
}
INR:
description: Cost in `Indian Rupees`
value: |
{
amount: 700,
currency: INR
}
/object-containg-array-property-with-example:
get:
summary: Object schema with array type property containing example
tags:
- Providing Examples
responses:
200:
description: Object with array type property containing example
content:
application/json:
schema:
$ref: "#/components/schemas/ObjectWithArrayPropExample"
/examples-anyOf:
get:
tags:
- Providing Examples
summary: AnyOf schemas with examples as part of the subschema
responses:
'200':
description: AnyOf schemas with examples as part of the subschema
content:
application/problem+json:
schema:
anyOf:
- title: AnyOf example 1
description: First example
type: object
properties:
foo:
type: string
bar:
type: integer
example:
foo: foo
bar: 42
- title: Second anyOf
description: Another example
type: array
items:
type: object
properties:
foo:
type: string
quux:
type: array
items:
type: number
example:
foo: foo
quux: [ 42, 24 ]
- title: No example defined
type: array
items:
type: object
properties:
foo:
type: string
quux:
type: array
items:
type: number
/examples-anyOf-with-general-properties:
get:
tags:
- Providing Examples
summary: AnyOf schemas with general properties
responses:
'200':
description: AnyOf schemas with general properties
content:
application/problem+json:
schema:
title: A composed object
type: object
properties:
common:
type: string
other:
type: number
anyOf:
- title: Schema 1
type: object
properties:
foo:
type: string
bar:
type: integer
example:
foo: foo
bar: 42
- title: Second schema
type: object
properties:
baz:
type: string
format: url
/examples-oneOf:
get:
tags:
- Providing Examples
summary: OneOf schema with examples as part of the subschema
responses:
'200':
description: OneOf schema with examples as part of the subschema
content:
application/problem+json:
schema:
oneOf:
- title: Schema 1
type: object
properties:
foo:
type: string
bar:
type: integer
example:
foo: foo
bar: 42
- title: Second schema
type: object
properties:
baz:
type: string
format: url
/examples-allOf:
get:
tags:
- Providing Examples
summary: AllOf schemas with examples as part of the subschema
responses:
'200':
description: AllOf schemas with examples as part of the subschema
content:
application/problem+json:
schema:
allOf:
- title: Schema 1
type: object
properties:
foo:
type: string
bar:
type: integer
- title: Second schema
type: object
properties:
baz:
type: string
format: url
/examples-allOf-anyOf:
get:
tags:
- Providing Examples
summary: Combination of allOf & nested anyOf schemas
responses:
'200':
description: Combination of allOf & nested anyOf schemas
content:
application/problem+json:
schema:
allOf:
- title: Schema 1
type: object
properties:
foo:
type: string
bar:
type: integer
- title: Second schema
anyOf:
- type: object
properties:
baz:
type: string
format: url
- type: object
properties:
foobar:
type: string
components:
schemas:
cost:
type: object
properties:
amount:
type: integer
description: Amount
currency:
description: Currency Code
type: string
currencies:
type: array
items:
type: object
properties:
currencyCode:
type: string
evaluationDate:
type: string
format: date-time
example:
- currencyCode: USD
evaluationDate: '2017-07-21T17:32:28Z'
- currencyCode: INR
evaluationDate: '2017-07-21T17:32:28Z'
ArrayOfInt-1:
type: array
items:
type: integer
format: int64
example: [1, 2, 3, 4]
ArrayOfInt-2:
type: array
items:
type: integer
format: int64
example: 1
PersonObject:
type: object
properties:
name:
type: string
age:
type: integer
example:
name: name-1
age: 1
ObjectWithArrayPropExample:
type: object
properties:
numberProp:
type: number
example: 1000
stringProp:
type: string
enum: [value0, value1]
arrayProp:
type: array
items:
type: number
example: [0, 1, 2]
|