Skip to content

oapi.oas.model

This module contains models describing objects defined by the OpenAPI Specification. The root object, oapi.oas.OpenAPI is capable of representing either an OpenAPI 3 Document or an OpenAPI 2 (Swagger) Document , depending on the specification version identified in the document.

Contact 

Contact(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: str | None = None,
    url: str | None = None,
    email: str | None = None,
)

Bases: sob.Object

OpenAPI 3 Contact Object

Attributes:

  • name (str | None) –
  • url (str | None) –
  • email (str | None) –
Source code in src/oapi/oas/model.py 
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
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    url: (
        str
        | None
    ) = None,
    email: (
        str
        | None
    ) = None
) -> None:
    self.name: (
        str
        | None
    ) = name
    self.url: (
        str
        | None
    ) = url
    self.email: (
        str
        | None
    ) = email
    super().__init__(_data)

Discriminator 

Discriminator(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    property_name: str | None = None,
    mapping: typing.Mapping[str, str] | None = None,
)

Bases: sob.Object

OpenAPI 3 Discriminator Object

Attributes:

  • property_name (str | None) –

    The name of the property which will hold the discriminating value.

  • mapping (typing.Mapping[str, str] | None) –

    An mappings of payload values to schema names or references.

Source code in src/oapi/oas/model.py 
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
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    property_name: (
        str
        | None
    ) = None,
    mapping: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = None
) -> None:
    self.property_name: (
        str
        | None
    ) = property_name
    self.mapping: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = mapping
    super().__init__(_data)

Encoding 

Encoding(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    content_type: str | None = None,
    headers: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Header,
        ]
        | None
    ) = None,
    style: str | None = None,
    explode: bool | None = None,
    allow_reserved: bool | None = None,
)

Bases: sob.Object

OpenAPI 3 Encoding Object

Attributes:

  • content_type (str | None) –
  • headers (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.Header] | None) –
  • style (str | None) –
  • explode (bool | None) –
  • allow_reserved (bool | None) –
Source code in src/oapi/oas/model.py 
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
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    content_type: (
        str
        | None
    ) = None,
    headers: (
        typing.Mapping[
            str,
            Reference
            | Header
        ]
        | None
    ) = None,
    style: (
        str
        | None
    ) = None,
    explode: (
        bool
        | None
    ) = None,
    allow_reserved: (
        bool
        | None
    ) = None
) -> None:
    self.content_type: (
        str
        | None
    ) = content_type
    self.headers: (
        typing.Mapping[
            str,
            Reference
            | Header
        ]
        | None
    ) = headers
    self.style: (
        str
        | None
    ) = style
    self.explode: (
        bool
        | None
    ) = explode
    self.allow_reserved: (
        bool
        | None
    ) = allow_reserved
    super().__init__(_data)

Example 

Example(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    summary: str | None = None,
    description: str | None = None,
    value: typing.Any | None = None,
    external_value: str | None = None,
)

Bases: sob.Object

OpenAPI 3 Example Object

Attributes:

  • summary (str | None) –
  • description (str | None) –
  • value (typing.Any | None) –
  • external_value (str | None) –
Source code in src/oapi/oas/model.py 
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
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    summary: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    value: (
        typing.Any
        | None
    ) = None,
    external_value: (
        str
        | None
    ) = None
) -> None:
    self.summary: (
        str
        | None
    ) = summary
    self.description: (
        str
        | None
    ) = description
    self.value: (
        typing.Any
        | None
    ) = value
    self.external_value: (
        str
        | None
    ) = external_value
    super().__init__(_data)

ExternalDocumentation 

ExternalDocumentation(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: str | None = None,
    url: str | None = None,
)

Bases: sob.Object

OpenAPI 3 External Documentation Object

Attributes:

  • description (str | None) –
  • url (str | None) –
Source code in src/oapi/oas/model.py 
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
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    url: (
        str
        | None
    ) = None
) -> None:
    self.description: (
        str
        | None
    ) = description
    self.url: (
        str
        | None
    ) = url
    super().__init__(_data)

Header 

Header(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: str | None = None,
    required: bool | None = None,
    deprecated: bool | None = None,
    allow_empty_value: bool | None = None,
    style: str | None = None,
    explode: bool | None = None,
    allow_reserved: bool | None = None,
    schema: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | None
    ) = None,
    example: typing.Any | None = None,
    examples: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Example,
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[str, oapi.oas.model.MediaType] | None
    ) = None,
    type_: str | None = None,
    default: typing.Any | None = None,
    maximum: float | int | decimal.Decimal | None = None,
    exclusive_maximum: bool | None = None,
    minimum: float | int | decimal.Decimal | None = None,
    exclusive_minimum: bool | None = None,
    max_length: int | None = None,
    min_length: int | None = None,
    pattern: str | None = None,
    max_items: int | None = None,
    min_items: int | None = None,
    unique_items: bool | None = None,
    enum: (
        typing.Sequence[sob.abc.MarshallableTypes | None]
        | None
    ) = None,
    format_: str | None = None,
    collection_format: str | None = None,
    items: oapi.oas.model.Items | None = None,
    multiple_of: (
        float | int | decimal.Decimal | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Header Object

Attributes:

  • description (str | None) –
  • required (bool | None) –
  • deprecated (bool | None) –
  • allow_empty_value (bool | None) –
  • style (str | None) –
  • explode (bool | None) –
  • allow_reserved (bool | None) –
  • schema (oapi.oas.model.Reference | oapi.oas.model.Schema | None) –
  • example (typing.Any | None) –
  • examples (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.Example] | None) –
  • content (typing.Mapping[str, oapi.oas.model.MediaType] | None) –
  • type_ (str | None) –
  • default (typing.Any | None) –
  • maximum (float | int | decimal.Decimal | None) –
  • exclusive_maximum (bool | None) –
  • minimum (float | int | decimal.Decimal | None) –
  • exclusive_minimum (bool | None) –
  • max_length (int | None) –
  • min_length (int | None) –
  • pattern (str | None) –
  • max_items (int | None) –
  • min_items (int | None) –
  • unique_items (bool | None) –
  • enum (typing.Sequence[sob.abc.MarshallableTypes | None] | None) –
  • format_ (str | None) –
  • collection_format (str | None) –
  • items (oapi.oas.model.Items | None) –
  • multiple_of (float | int | decimal.Decimal | None) –
Source code in src/oapi/oas/model.py 
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    required: (
        bool
        | None
    ) = None,
    deprecated: (
        bool
        | None
    ) = None,
    allow_empty_value: (
        bool
        | None
    ) = None,
    style: (
        str
        | None
    ) = None,
    explode: (
        bool
        | None
    ) = None,
    allow_reserved: (
        bool
        | None
    ) = None,
    schema: (
        Reference
        | Schema
        | None
    ) = None,
    example: (
        typing.Any
        | None
    ) = None,
    examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    default: (
        typing.Any
        | None
    ) = None,
    maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_maximum: (
        bool
        | None
    ) = None,
    minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_minimum: (
        bool
        | None
    ) = None,
    max_length: (
        int
        | None
    ) = None,
    min_length: (
        int
        | None
    ) = None,
    pattern: (
        str
        | None
    ) = None,
    max_items: (
        int
        | None
    ) = None,
    min_items: (
        int
        | None
    ) = None,
    unique_items: (
        bool
        | None
    ) = None,
    enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    collection_format: (
        str
        | None
    ) = None,
    items: (
        Items
        | None
    ) = None,
    multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None
) -> None:
    self.description: (
        str
        | None
    ) = description
    self.required: (
        bool
        | None
    ) = required
    self.deprecated: (
        bool
        | None
    ) = deprecated
    self.allow_empty_value: (
        bool
        | None
    ) = allow_empty_value
    self.style: (
        str
        | None
    ) = style
    self.explode: (
        bool
        | None
    ) = explode
    self.allow_reserved: (
        bool
        | None
    ) = allow_reserved
    self.schema: (
        Reference
        | Schema
        | None
    ) = schema
    self.example: (
        typing.Any
        | None
    ) = example
    self.examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = examples
    self.content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = content
    self.type_: (
        str
        | None
    ) = type_
    self.default: (
        typing.Any
        | None
    ) = default
    self.maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = maximum
    self.exclusive_maximum: (
        bool
        | None
    ) = exclusive_maximum
    self.minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = minimum
    self.exclusive_minimum: (
        bool
        | None
    ) = exclusive_minimum
    self.max_length: (
        int
        | None
    ) = max_length
    self.min_length: (
        int
        | None
    ) = min_length
    self.pattern: (
        str
        | None
    ) = pattern
    self.max_items: (
        int
        | None
    ) = max_items
    self.min_items: (
        int
        | None
    ) = min_items
    self.unique_items: (
        bool
        | None
    ) = unique_items
    self.enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = enum
    self.format_: (
        str
        | None
    ) = format_
    self.collection_format: (
        str
        | None
    ) = collection_format
    self.items: (
        Items
        | None
    ) = items
    self.multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = multiple_of
    super().__init__(_data)

Info 

Info(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    title: str | None = None,
    description: str | None = None,
    terms_of_service: str | None = None,
    contact: oapi.oas.model.Contact | None = None,
    license_: oapi.oas.model.License | None = None,
    version: str | None = None,
)

Bases: sob.Object

OpenAPI 3 Info Object

Attributes:

  • title (str | None) –
  • description (str | None) –
  • terms_of_service (str | None) –
  • contact (oapi.oas.model.Contact | None) –
  • license_ (oapi.oas.model.License | None) –
  • version (str | None) –
Source code in src/oapi/oas/model.py 
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    terms_of_service: (
        str
        | None
    ) = None,
    contact: (
        Contact
        | None
    ) = None,
    license_: (
        License
        | None
    ) = None,
    version: (
        str
        | None
    ) = None
) -> None:
    self.title: (
        str
        | None
    ) = title
    self.description: (
        str
        | None
    ) = description
    self.terms_of_service: (
        str
        | None
    ) = terms_of_service
    self.contact: (
        Contact
        | None
    ) = contact
    self.license_: (
        License
        | None
    ) = license_
    self.version: (
        str
        | None
    ) = version
    super().__init__(_data)

Items 

Items(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    format_: str | None = None,
    items: oapi.oas.model.Items | None = None,
    collection_format: str | None = None,
    default: typing.Any | None = None,
    maximum: float | int | decimal.Decimal | None = None,
    exclusive_maximum: bool | None = None,
    minimum: float | int | decimal.Decimal | None = None,
    exclusive_minimum: bool | None = None,
    max_length: int | None = None,
    min_length: int | None = None,
    pattern: str | None = None,
    max_items: int | None = None,
    min_items: int | None = None,
    unique_items: bool | None = None,
    enum: (
        typing.Sequence[sob.abc.MarshallableTypes | None]
        | None
    ) = None,
    multiple_of: (
        float | int | decimal.Decimal | None
    ) = None,
)

Bases: sob.Object

OpenAPI 2 Items Object

Attributes:

  • type_ (str | None) –
  • format_ (str | None) –
  • items (oapi.oas.model.Items | None) –
  • collection_format (str | None) –
  • default (typing.Any | None) –
  • maximum (float | int | decimal.Decimal | None) –
  • exclusive_maximum (bool | None) –
  • minimum (float | int | decimal.Decimal | None) –
  • exclusive_minimum (bool | None) –
  • max_length (int | None) –
  • min_length (int | None) –
  • pattern (str | None) –
  • max_items (int | None) –
  • min_items (int | None) –
  • unique_items (bool | None) –
  • enum (typing.Sequence[sob.abc.MarshallableTypes | None] | None) –
  • multiple_of (float | int | decimal.Decimal | None) –
Source code in src/oapi/oas/model.py 
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    items: (
        Items
        | None
    ) = None,
    collection_format: (
        str
        | None
    ) = None,
    default: (
        typing.Any
        | None
    ) = None,
    maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_maximum: (
        bool
        | None
    ) = None,
    minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_minimum: (
        bool
        | None
    ) = None,
    max_length: (
        int
        | None
    ) = None,
    min_length: (
        int
        | None
    ) = None,
    pattern: (
        str
        | None
    ) = None,
    max_items: (
        int
        | None
    ) = None,
    min_items: (
        int
        | None
    ) = None,
    unique_items: (
        bool
        | None
    ) = None,
    enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.format_: (
        str
        | None
    ) = format_
    self.items: (
        Items
        | None
    ) = items
    self.collection_format: (
        str
        | None
    ) = collection_format
    self.default: (
        typing.Any
        | None
    ) = default
    self.maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = maximum
    self.exclusive_maximum: (
        bool
        | None
    ) = exclusive_maximum
    self.minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = minimum
    self.exclusive_minimum: (
        bool
        | None
    ) = exclusive_minimum
    self.max_length: (
        int
        | None
    ) = max_length
    self.min_length: (
        int
        | None
    ) = min_length
    self.pattern: (
        str
        | None
    ) = pattern
    self.max_items: (
        int
        | None
    ) = max_items
    self.min_items: (
        int
        | None
    ) = min_items
    self.unique_items: (
        bool
        | None
    ) = unique_items
    self.enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = enum
    self.multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = multiple_of
    super().__init__(_data)

License 

License(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: str | None = None,
    url: str | None = None,
)

Bases: sob.Object

OpenAPI 3 License Object

Attributes:

  • name (str | None) –
  • url (str | None) –
Source code in src/oapi/oas/model.py 
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    url: (
        str
        | None
    ) = None
) -> None:
    self.name: (
        str
        | None
    ) = name
    self.url: (
        str
        | None
    ) = url
    super().__init__(_data)

LinkObject 

LinkObject(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    operation_ref: str | None = None,
    operation_id: str | None = None,
    parameters: (
        typing.Mapping[
            str, sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    request_body: typing.Any | None = None,
    description: str | None = None,
    server: oapi.oas.model.Server | None = None,
)

Bases: sob.Object

OpenAPI 3 Link Object

Attributes:

  • operation_ref (str | None) –
  • operation_id (str | None) –
  • parameters (typing.Mapping[str, sob.abc.MarshallableTypes | None] | None) –
  • request_body (typing.Any | None) –
  • description (str | None) –
  • server (oapi.oas.model.Server | None) –
Source code in src/oapi/oas/model.py 
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    operation_ref: (
        str
        | None
    ) = None,
    operation_id: (
        str
        | None
    ) = None,
    parameters: (
        typing.Mapping[
            str,
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    request_body: (
        typing.Any
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    server: (
        Server
        | None
    ) = None
) -> None:
    self.operation_ref: (
        str
        | None
    ) = operation_ref
    self.operation_id: (
        str
        | None
    ) = operation_id
    self.parameters: (
        typing.Mapping[
            str,
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = parameters
    self.request_body: (
        typing.Any
        | None
    ) = request_body
    self.description: (
        str
        | None
    ) = description
    self.server: (
        Server
        | None
    ) = server
    super().__init__(_data)

MediaType 

MediaType(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    schema: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | None
    ) = None,
    example: typing.Any | None = None,
    examples: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Example,
        ]
        | None
    ) = None,
    encoding: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Encoding,
        ]
        | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Media Type Object

Attributes:

Source code in src/oapi/oas/model.py 
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    schema: (
        Reference
        | Schema
        | None
    ) = None,
    example: (
        typing.Any
        | None
    ) = None,
    examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = None,
    encoding: (
        typing.Mapping[
            str,
            Reference
            | Encoding
        ]
        | None
    ) = None
) -> None:
    self.schema: (
        Reference
        | Schema
        | None
    ) = schema
    self.example: (
        typing.Any
        | None
    ) = example
    self.examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = examples
    self.encoding: (
        typing.Mapping[
            str,
            Reference
            | Encoding
        ]
        | None
    ) = encoding
    super().__init__(_data)

OAuthFlow 

OAuthFlow(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    authorization_url: str | None = None,
    token_url: str | None = None,
    refresh_url: str | None = None,
    scopes: typing.Mapping[str, str] | None = None,
)

Bases: sob.Object

OpenAPI 3 Parameter Object

Attributes:

  • authorization_url (str | None) –
  • token_url (str | None) –
  • refresh_url (str | None) –
  • scopes (typing.Mapping[str, str] | None) –
Source code in src/oapi/oas/model.py 
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    authorization_url: (
        str
        | None
    ) = None,
    token_url: (
        str
        | None
    ) = None,
    refresh_url: (
        str
        | None
    ) = None,
    scopes: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = None
) -> None:
    self.authorization_url: (
        str
        | None
    ) = authorization_url
    self.token_url: (
        str
        | None
    ) = token_url
    self.refresh_url: (
        str
        | None
    ) = refresh_url
    self.scopes: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = scopes
    super().__init__(_data)

OAuthFlows 

OAuthFlows(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    implicit: oapi.oas.model.OAuthFlow | None = None,
    password: oapi.oas.model.OAuthFlow | None = None,
    client_credentials: (
        oapi.oas.model.OAuthFlow | None
    ) = None,
    authorization_code: (
        oapi.oas.model.OAuthFlow | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 OAuth Flows Object

Attributes:

Source code in src/oapi/oas/model.py 
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    implicit: (
        OAuthFlow
        | None
    ) = None,
    password: (
        OAuthFlow
        | None
    ) = None,
    client_credentials: (
        OAuthFlow
        | None
    ) = None,
    authorization_code: (
        OAuthFlow
        | None
    ) = None
) -> None:
    self.implicit: (
        OAuthFlow
        | None
    ) = implicit
    self.password: (
        OAuthFlow
        | None
    ) = password
    self.client_credentials: (
        OAuthFlow
        | None
    ) = client_credentials
    self.authorization_code: (
        OAuthFlow
        | None
    ) = authorization_code
    super().__init__(_data)

OpenAPI 

OpenAPI(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    openapi: str | None = None,
    info: oapi.oas.model.Info | None = None,
    json_schema_dialect: str | None = None,
    host: str | None = None,
    servers: (
        typing.Sequence[oapi.oas.model.Server] | None
    ) = None,
    base_path: str | None = None,
    schemes: typing.Sequence[str] | None = None,
    tags: typing.Sequence[oapi.oas.model.Tag] | None = None,
    paths: oapi.oas.model.Paths | None = None,
    components: oapi.oas.model.Components | None = None,
    consumes: typing.Sequence[str] | None = None,
    swagger: str | None = None,
    definitions: oapi.oas.model.Definitions | None = None,
    security_definitions: (
        oapi.oas.model.SecuritySchemes | None
    ) = None,
    produces: typing.Sequence[str] | None = None,
    external_docs: (
        oapi.oas.model.ExternalDocumentation | None
    ) = None,
    parameters: (
        typing.Mapping[str, oapi.oas.model.Parameter] | None
    ) = None,
    responses: (
        typing.Mapping[str, oapi.oas.model.Response] | None
    ) = None,
    security: (
        typing.Sequence[oapi.oas.model.SecurityRequirement]
        | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 OpenAPI (root) Object

Attributes:

  • openapi (str | None) –
  • info (oapi.oas.model.Info | None) –
  • json_schema_dialect (str | None) –
  • host (str | None) –
  • servers (typing.Sequence[oapi.oas.model.Server] | None) –
  • base_path (str | None) –
  • schemes (typing.Sequence[str] | None) –
  • tags (typing.Sequence[oapi.oas.model.Tag] | None) –
  • paths (oapi.oas.model.Paths | None) –
  • components (oapi.oas.model.Components | None) –
  • consumes (typing.Sequence[str] | None) –
  • swagger (str | None) –
  • definitions (oapi.oas.model.Definitions | None) –
  • security_definitions (oapi.oas.model.SecuritySchemes | None) –
  • produces (typing.Sequence[str] | None) –
  • external_docs (oapi.oas.model.ExternalDocumentation | None) –
  • parameters (typing.Mapping[str, oapi.oas.model.Parameter] | None) –
  • responses (typing.Mapping[str, oapi.oas.model.Response] | None) –
  • security (typing.Sequence[oapi.oas.model.SecurityRequirement] | None) –
Source code in src/oapi/oas/model.py 
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    openapi: (
        str
        | None
    ) = None,
    info: (
        Info
        | None
    ) = None,
    json_schema_dialect: (
        str
        | None
    ) = None,
    host: (
        str
        | None
    ) = None,
    servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = None,
    base_path: (
        str
        | None
    ) = None,
    schemes: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    tags: (
        typing.Sequence[
            Tag
        ]
        | None
    ) = None,
    paths: (
        Paths
        | None
    ) = None,
    components: (
        Components
        | None
    ) = None,
    consumes: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    swagger: (
        str
        | None
    ) = None,
    definitions: (
        Definitions
        | None
    ) = None,
    security_definitions: (
        SecuritySchemes
        | None
    ) = None,
    produces: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    external_docs: (
        ExternalDocumentation
        | None
    ) = None,
    parameters: (
        typing.Mapping[
            str,
            Parameter
        ]
        | None
    ) = None,
    responses: (
        typing.Mapping[
            str,
            Response
        ]
        | None
    ) = None,
    security: (
        typing.Sequence[
            SecurityRequirement
        ]
        | None
    ) = None
) -> None:
    self.openapi: (
        str
        | None
    ) = openapi
    self.info: (
        Info
        | None
    ) = info
    self.json_schema_dialect: (
        str
        | None
    ) = json_schema_dialect
    self.host: (
        str
        | None
    ) = host
    self.servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = servers
    self.base_path: (
        str
        | None
    ) = base_path
    self.schemes: (
        typing.Sequence[
            str
        ]
        | None
    ) = schemes
    self.tags: (
        typing.Sequence[
            Tag
        ]
        | None
    ) = tags
    self.paths: (
        Paths
        | None
    ) = paths
    self.components: (
        Components
        | None
    ) = components
    self.consumes: (
        typing.Sequence[
            str
        ]
        | None
    ) = consumes
    self.swagger: (
        str
        | None
    ) = swagger
    self.definitions: (
        Definitions
        | None
    ) = definitions
    self.security_definitions: (
        SecuritySchemes
        | None
    ) = security_definitions
    self.produces: (
        typing.Sequence[
            str
        ]
        | None
    ) = produces
    self.external_docs: (
        ExternalDocumentation
        | None
    ) = external_docs
    self.parameters: (
        typing.Mapping[
            str,
            Parameter
        ]
        | None
    ) = parameters
    self.responses: (
        typing.Mapping[
            str,
            Response
        ]
        | None
    ) = responses
    self.security: (
        typing.Sequence[
            SecurityRequirement
        ]
        | None
    ) = security
    super().__init__(_data)
    version: str = self.openapi or self.swagger or ""
    if version:
        sob.version_model(self, "openapi", version)

Operation 

Operation(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    tags: typing.Sequence[str] | None = None,
    summary: str | None = None,
    description: str | None = None,
    external_docs: (
        oapi.oas.model.ExternalDocumentation | None
    ) = None,
    operation_id: str | None = None,
    consumes: typing.Sequence[str] | None = None,
    produces: typing.Sequence[str] | None = None,
    parameters: (
        typing.Sequence[
            oapi.oas.model.Reference
            | oapi.oas.model.Parameter
        ]
        | None
    ) = None,
    request_body: (
        oapi.oas.model.Reference
        | oapi.oas.model.RequestBody
        | None
    ) = None,
    responses: oapi.oas.model.Responses | None = None,
    callbacks: oapi.oas.model.Callbacks | None = None,
    schemes: typing.Sequence[str] | None = None,
    deprecated: bool | None = None,
    security: (
        typing.Sequence[oapi.oas.model.SecurityRequirement]
        | None
    ) = None,
    servers: (
        typing.Sequence[oapi.oas.model.Server] | None
    ) = None,
)

Bases: sob.Object

Open API 3 Operation Object

Describes a single API operation on a path.

Attributes:

  • tags (typing.Sequence[str] | None) –

    A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

  • summary (str | None) –

    A short summary of what the operation does.

  • description (str | None) –

    A verbose explanation of the operation behavior. CommonMark <http://spec.commonmark.org> syntax may be used for rich text representation.

  • external_docs (oapi.oas.model.ExternalDocumentation | None) –

    Additional external documentation for this operation.

  • operation_id (str | None) –

    Unique string used to identify the operation. The ID must be unique among all operations described in the API. Tools and libraries may use the operation_id to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.

  • parameters (typing.Sequence[oapi.oas.model.Reference | oapi.oas.model.Parameter] | None) –

    A list of parameters that are applicable for this operation. If a parameter is already defined at the PathItem, the new definition will override it, but can never remove it.

  • request_body (oapi.oas.model.Reference | oapi.oas.model.RequestBody | None) –

    The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 <https://tools.ietf.org/html/rfc7231#section-4.3.1> has explicitly defined semantics for request bodies.

  • responses (oapi.oas.model.Responses | None) –

    A mapping of HTTP response codes to Response objects.

  • callbacks (oapi.oas.model.Callbacks | None) –
  • deprecated (bool | None) –
  • security (typing.Sequence[oapi.oas.model.SecurityRequirement] | None) –
  • servers (typing.Sequence[oapi.oas.model.Server] | None) –
  • produces (typing.Sequence[str] | None) –

    (OpenAPI 2x only)

Source code in src/oapi/oas/model.py 
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    tags: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    summary: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    external_docs: (
        ExternalDocumentation
        | None
    ) = None,
    operation_id: (
        str
        | None
    ) = None,
    consumes: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    produces: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    parameters: (
        typing.Sequence[
            Reference
        | Parameter
        ]
        | None
    ) = None,
    request_body: (
        Reference
        | RequestBody
        | None
    ) = None,
    responses: (
        Responses
        | None
    ) = None,
    callbacks: (
        Callbacks
        | None
    ) = None,
    schemes: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    deprecated: (
        bool
        | None
    ) = None,
    security: (
        typing.Sequence[
            SecurityRequirement
        ]
        | None
    ) = None,
    servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = None
) -> None:
    self.tags: (
        typing.Sequence[
            str
        ]
        | None
    ) = tags
    self.summary: (
        str
        | None
    ) = summary
    self.description: (
        str
        | None
    ) = description
    self.external_docs: (
        ExternalDocumentation
        | None
    ) = external_docs
    self.operation_id: (
        str
        | None
    ) = operation_id
    self.consumes: (
        typing.Sequence[
            str
        ]
        | None
    ) = consumes
    self.produces: (
        typing.Sequence[
            str
        ]
        | None
    ) = produces
    self.parameters: (
        typing.Sequence[
            Reference
        | Parameter
        ]
        | None
    ) = parameters
    self.request_body: (
        Reference
        | RequestBody
        | None
    ) = request_body
    self.responses: (
        Responses
        | None
    ) = responses
    self.callbacks: (
        Callbacks
        | None
    ) = callbacks
    self.schemes: (
        typing.Sequence[
            str
        ]
        | None
    ) = schemes
    self.deprecated: (
        bool
        | None
    ) = deprecated
    self.security: (
        typing.Sequence[
            SecurityRequirement
        ]
        | None
    ) = security
    self.servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = servers
    super().__init__(_data)

Parameter 

Parameter(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: str | None = None,
    in_: str | None = None,
    description: str | None = None,
    required: bool | None = None,
    deprecated: bool | None = None,
    allow_empty_value: bool | None = None,
    style: str | None = None,
    explode: bool | None = None,
    allow_reserved: bool | None = None,
    schema: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | None
    ) = None,
    example: typing.Any | None = None,
    examples: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Example,
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[str, oapi.oas.model.MediaType] | None
    ) = None,
    type_: str | None = None,
    default: typing.Any | None = None,
    maximum: float | int | decimal.Decimal | None = None,
    exclusive_maximum: bool | None = None,
    minimum: float | int | decimal.Decimal | None = None,
    exclusive_minimum: bool | None = None,
    max_length: int | None = None,
    min_length: int | None = None,
    pattern: str | None = None,
    max_items: int | None = None,
    min_items: int | None = None,
    unique_items: bool | None = None,
    enum: (
        typing.Sequence[sob.abc.MarshallableTypes | None]
        | None
    ) = None,
    format_: str | None = None,
    collection_format: str | None = None,
    items: oapi.oas.model.Items | None = None,
    multiple_of: (
        float | int | decimal.Decimal | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Parameter Object | OpenAPI 2 Parameter Object

Attributes:

  • name (str | None) –
  • in_ (str | None) –

    "path", "query", "header", or "cookie"

  • description (str | None) –
  • required (bool | None) –
  • deprecated (bool | None) –
  • allow_empty_value (bool | None) –

    Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. The default value is False. If style is used, and if behavior is inapplicable (cannot be serialized), the value of allow_empty_value will be ignored.

  • style (str | None) –

    Describes how the parameter value will be serialized, depending on the type of the parameter value (see: Parameter Serialization ). Valid values include: "matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject", and "dotObject". The default values vary by location (in_). For "query": "form", path: "simple", header: "simple", and cookie: "form". The "dotObject" style is identical to "deepObject" except that object.attribute notation is used instead of object[attribute] notation.

  • explode (bool | None) –

    When this is True, array or object parameter values generate separate parameters for each value of the array or name-value pair of the map. For other value_types of parameters this property has no effect. When style is "form", the default value is True. For all other styles, the default value is False.

  • allow_reserved (bool | None) –

    Determines whether the parameter value SHOULD allow reserved characters :/?#[]@!$&'()*+,;= (as defined by RFC3986 to be included without percent-encoding. This property only applies to "query" parameters. The default value is False.

  • schema (oapi.oas.model.Reference | oapi.oas.model.Schema | None) –

    The schema defining the type used for the parameter.

  • example (typing.Any | None) –

    An example of the parameter's potential value—see Working With Examples . Either an example or examples parameter may be provided, but not both.

  • examples (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.Example] | None) –

    Examples of the parameter's potential values—see Working With Examples . Either an example or examples parameter may be provided, but not both.

  • content (typing.Mapping[str, oapi.oas.model.MediaType] | None) –

    A mapping with a media type name and the object describing it. The mapping must only contain one entry. See Fixed fields for use with content .

  • type_ (str | None) –

    (Open API 2x only)

  • enum (typing.Sequence[sob.abc.MarshallableTypes | None] | None) –

    (Open API 2x only)

  • collection_format (str | None) –

    (Open API 2x only) Determines the format of the array if type_ == "array". Possible values include:

    • csv: comma separated values foo,bar.
    • ssv: space separated values foo bar.
    • tsv: tab separated values foo bar.
    • pipes: pipe separated values foo|bar.
    • multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz. This is valid only for parameters in "query" or "formData".
Source code in src/oapi/oas/model.py 
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    in_: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    required: (
        bool
        | None
    ) = None,
    deprecated: (
        bool
        | None
    ) = None,
    allow_empty_value: (
        bool
        | None
    ) = None,
    style: (
        str
        | None
    ) = None,
    explode: (
        bool
        | None
    ) = None,
    allow_reserved: (
        bool
        | None
    ) = None,
    schema: (
        Reference
        | Schema
        | None
    ) = None,
    example: (
        typing.Any
        | None
    ) = None,
    examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    default: (
        typing.Any
        | None
    ) = None,
    maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_maximum: (
        bool
        | None
    ) = None,
    minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_minimum: (
        bool
        | None
    ) = None,
    max_length: (
        int
        | None
    ) = None,
    min_length: (
        int
        | None
    ) = None,
    pattern: (
        str
        | None
    ) = None,
    max_items: (
        int
        | None
    ) = None,
    min_items: (
        int
        | None
    ) = None,
    unique_items: (
        bool
        | None
    ) = None,
    enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    collection_format: (
        str
        | None
    ) = None,
    items: (
        Items
        | None
    ) = None,
    multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None
) -> None:
    self.name: (
        str
        | None
    ) = name
    self.in_: (
        str
        | None
    ) = in_
    self.description: (
        str
        | None
    ) = description
    self.required: (
        bool
        | None
    ) = required
    self.deprecated: (
        bool
        | None
    ) = deprecated
    self.allow_empty_value: (
        bool
        | None
    ) = allow_empty_value
    self.style: (
        str
        | None
    ) = style
    self.explode: (
        bool
        | None
    ) = explode
    self.allow_reserved: (
        bool
        | None
    ) = allow_reserved
    self.schema: (
        Reference
        | Schema
        | None
    ) = schema
    self.example: (
        typing.Any
        | None
    ) = example
    self.examples: (
        typing.Mapping[
            str,
            Reference
            | Example
        ]
        | None
    ) = examples
    self.content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = content
    self.type_: (
        str
        | None
    ) = type_
    self.default: (
        typing.Any
        | None
    ) = default
    self.maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = maximum
    self.exclusive_maximum: (
        bool
        | None
    ) = exclusive_maximum
    self.minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = minimum
    self.exclusive_minimum: (
        bool
        | None
    ) = exclusive_minimum
    self.max_length: (
        int
        | None
    ) = max_length
    self.min_length: (
        int
        | None
    ) = min_length
    self.pattern: (
        str
        | None
    ) = pattern
    self.max_items: (
        int
        | None
    ) = max_items
    self.min_items: (
        int
        | None
    ) = min_items
    self.unique_items: (
        bool
        | None
    ) = unique_items
    self.enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = enum
    self.format_: (
        str
        | None
    ) = format_
    self.collection_format: (
        str
        | None
    ) = collection_format
    self.items: (
        Items
        | None
    ) = items
    self.multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = multiple_of
    super().__init__(_data)

PathItem 

PathItem(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    summary: str | None = None,
    description: str | None = None,
    get: oapi.oas.model.Operation | None = None,
    put: oapi.oas.model.Operation | None = None,
    post: oapi.oas.model.Operation | None = None,
    delete: oapi.oas.model.Operation | None = None,
    options: oapi.oas.model.Operation | None = None,
    head: oapi.oas.model.Operation | None = None,
    patch: oapi.oas.model.Operation | None = None,
    trace: oapi.oas.model.Operation | None = None,
    servers: (
        typing.Sequence[oapi.oas.model.Server] | None
    ) = None,
    parameters: (
        typing.Sequence[
            oapi.oas.model.Reference
            | oapi.oas.model.Parameter
        ]
        | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Path Item Object

Attributes:

Source code in src/oapi/oas/model.py 
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    summary: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    get: (
        Operation
        | None
    ) = None,
    put: (
        Operation
        | None
    ) = None,
    post: (
        Operation
        | None
    ) = None,
    delete: (
        Operation
        | None
    ) = None,
    options: (
        Operation
        | None
    ) = None,
    head: (
        Operation
        | None
    ) = None,
    patch: (
        Operation
        | None
    ) = None,
    trace: (
        Operation
        | None
    ) = None,
    servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = None,
    parameters: (
        typing.Sequence[
            Reference
        | Parameter
        ]
        | None
    ) = None
) -> None:
    self.summary: (
        str
        | None
    ) = summary
    self.description: (
        str
        | None
    ) = description
    self.get: (
        Operation
        | None
    ) = get
    self.put: (
        Operation
        | None
    ) = put
    self.post: (
        Operation
        | None
    ) = post
    self.delete: (
        Operation
        | None
    ) = delete
    self.options: (
        Operation
        | None
    ) = options
    self.head: (
        Operation
        | None
    ) = head
    self.patch: (
        Operation
        | None
    ) = patch
    self.trace: (
        Operation
        | None
    ) = trace
    self.servers: (
        typing.Sequence[
            Server
        ]
        | None
    ) = servers
    self.parameters: (
        typing.Sequence[
            Reference
        | Parameter
        ]
        | None
    ) = parameters
    super().__init__(_data)

Reference 

Reference(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    ref: str | None = None,
    summary: str | None = None,
    description: str | None = None,
)

Bases: sob.Object

OpenAPI 3 Reference Object

Attributes:

  • ref (str | None) –
  • summary (str | None) –
  • description (str | None) –
Source code in src/oapi/oas/model.py 
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    ref: (
        str
        | None
    ) = None,
    summary: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None
) -> None:
    self.ref: (
        str
        | None
    ) = ref
    self.summary: (
        str
        | None
    ) = summary
    self.description: (
        str
        | None
    ) = description
    super().__init__(_data)

RequestBody 

RequestBody(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: str | None = None,
    content: (
        typing.Mapping[str, oapi.oas.model.MediaType] | None
    ) = None,
    required: bool | None = None,
)

Bases: sob.Object

OpenAPI 3 Request Body Object

Attributes:

  • description (str | None) –
  • content (typing.Mapping[str, oapi.oas.model.MediaType] | None) –
  • required (bool | None) –
Source code in src/oapi/oas/model.py 
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = None,
    required: (
        bool
        | None
    ) = None
) -> None:
    self.description: (
        str
        | None
    ) = description
    self.content: (
        typing.Mapping[
            str,
            MediaType
        ]
        | None
    ) = content
    self.required: (
        bool
        | None
    ) = required
    super().__init__(_data)

Response 

Response(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: str | None = None,
    schema: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | None
    ) = None,
    headers: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.Header,
        ]
        | None
    ) = None,
    examples: (
        typing.Mapping[
            str, sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.MediaType,
        ]
        | None
    ) = None,
    links: (
        typing.Mapping[
            str,
            oapi.oas.model.Reference
            | oapi.oas.model.LinkObject,
        ]
        | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Response Object

Attributes:

  • description (str | None) –

    A short description of the response. CommonMark syntax may be used for rich text representation.

  • headers (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.Header] | None) –

    Maps a header name to its definition (mappings are case-insensitive).

  • content (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.MediaType] | None) –

    A mapping of media value_types to MediaType instances describing potential payloads.

  • links (typing.Mapping[str, oapi.oas.model.Reference | oapi.oas.model.LinkObject] | None) –

    A map of operations links that can be followed from the response.

  • examples (typing.Mapping[str, sob.abc.MarshallableTypes | None] | None) –

    Examples responses

  • schema (oapi.oas.model.Reference | oapi.oas.model.Schema | None) –

    (OpenAPI 2x only)

Source code in src/oapi/oas/model.py 
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    schema: (
        Reference
        | Schema
        | None
    ) = None,
    headers: (
        typing.Mapping[
            str,
            Reference
            | Header
        ]
        | None
    ) = None,
    examples: (
        typing.Mapping[
            str,
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    content: (
        typing.Mapping[
            str,
            Reference
            | MediaType
        ]
        | None
    ) = None,
    links: (
        typing.Mapping[
            str,
            Reference
            | LinkObject
        ]
        | None
    ) = None
) -> None:
    self.description: (
        str
        | None
    ) = description
    self.schema: (
        Reference
        | Schema
        | None
    ) = schema
    self.headers: (
        typing.Mapping[
            str,
            Reference
            | Header
        ]
        | None
    ) = headers
    self.examples: (
        typing.Mapping[
            str,
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = examples
    self.content: (
        typing.Mapping[
            str,
            Reference
            | MediaType
        ]
        | None
    ) = content
    self.links: (
        typing.Mapping[
            str,
            Reference
            | LinkObject
        ]
        | None
    ) = links
    super().__init__(_data)

Schema 

Schema(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    title: str | None = None,
    description: str | None = None,
    multiple_of: (
        float | int | decimal.Decimal | None
    ) = None,
    maximum: float | int | decimal.Decimal | None = None,
    exclusive_maximum: bool | None = None,
    minimum: float | int | decimal.Decimal | None = None,
    exclusive_minimum: bool | None = None,
    max_length: int | None = None,
    min_length: int | None = None,
    pattern: str | None = None,
    max_items: int | None = None,
    min_items: int | None = None,
    unique_items: bool | None = None,
    items: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | typing.Sequence[
            oapi.oas.model.Reference | oapi.oas.model.Schema
        ]
        | None
    ) = None,
    max_properties: int | None = None,
    min_properties: int | None = None,
    properties: oapi.oas.model.Properties | None = None,
    additional_properties: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | bool
        | None
    ) = None,
    enum: (
        typing.Sequence[sob.abc.MarshallableTypes | None]
        | None
    ) = None,
    type_: str | None = None,
    format_: str | None = None,
    required: typing.Sequence[str] | None = None,
    all_of: (
        typing.Sequence[
            oapi.oas.model.Reference | oapi.oas.model.Schema
        ]
        | None
    ) = None,
    any_of: (
        typing.Sequence[
            oapi.oas.model.Reference | oapi.oas.model.Schema
        ]
        | None
    ) = None,
    one_of: (
        typing.Sequence[
            oapi.oas.model.Reference | oapi.oas.model.Schema
        ]
        | None
    ) = None,
    is_not: (
        oapi.oas.model.Reference
        | oapi.oas.model.Schema
        | None
    ) = None,
    definitions: typing.Any | None = None,
    default: typing.Any | None = None,
    discriminator: (
        oapi.oas.model.Discriminator | str | None
    ) = None,
    read_only: bool | None = None,
    write_only: bool | None = None,
    xml: oapi.oas.model.XML | None = None,
    external_docs: (
        oapi.oas.model.ExternalDocumentation | None
    ) = None,
    example: typing.Any | None = None,
    deprecated: bool | None = None,
    links: (
        typing.Sequence[oapi.oas.model.Link] | None
    ) = None,
    nullable: bool | None = None,
    content_encoding: str | None = None,
    content_media_type: str | None = None,
    examples: (
        typing.Sequence[sob.abc.MarshallableTypes | None]
        | None
    ) = None,
)

Bases: sob.Object

Open API 3 Schema Object | JSON Schema

Attributes:

  • title (str | None) –
  • description (str | None) –
  • multiple_of (float | int | decimal.Decimal | None) –

    The numeric value this schema describes should be divisible by this number.

  • maximum (float | int | decimal.Decimal | None) –

    The number this schema describes should be less than or equal to this value, or less than this value, depending on the value of exclusive_maximum.

  • exclusive_maximum (bool | None) –

    If True, the numeric instance described by this schema must be less than maximum. If False, the numeric instance described by this schema can be less than or equal to maximum.

  • minimum (float | int | decimal.Decimal | None) –

    The number this schema describes should be greater than or equal to this value, or greater than this value, depending on the value of exclusive_minimum.

  • exclusive_minimum (bool | None) –

    If True, the numeric instance described by this schema must be greater than minimum. If False, the numeric instance described by this schema can be greater than or equal to minimum.

  • max_length (int | None) –

    The number of characters in the string instance described by this schema must be less than, or equal to, the value of this property.

  • min_length (int | None) –

    The number of characters in the string instance described by this schema must be greater than, or equal to, the value of this property.

  • pattern (str | None) –

    The string instance described by this schema should match this regular expression (ECMA 262).

  • items (oapi.oas.model.Reference | oapi.oas.model.Schema | typing.Sequence[oapi.oas.model.Reference | oapi.oas.model.Schema] | None) –
    • If items is a sub-schema--each item in the array instance described by this schema should be valid as described by this sub-schema.
    • If items is a sequence of sub-schemas, the array instance described by this schema should be equal in length to this sequence, and each value should be valid as described by the sub-schema at the corresponding index within this sequence of sub-schemas.
  • max_items (int | None) –

    The array instance described by this schema should contain no more than this number of items.

  • min_items (int | None) –

    The array instance described by this schema should contain at least this number of items.

  • unique_items (bool | None) –

    The array instance described by this schema should contain only unique items.

  • max_properties (int | None) –
  • min_properties (int | None) –
  • properties (oapi.oas.model.Properties | None) –

    Any properties of the object instance described by this schema which correspond to a name in this mapping should be valid as described by the sub-schema corresponding to that name.

  • additional_properties (oapi.oas.model.Reference | oapi.oas.model.Schema | bool | None) –
    • If additional_properties is True—properties may be present in the object described by this schema with names which do not match those in properties.
    • If additional_properties is False—all properties present in the object described by this schema must correspond to a property matched in properties.
    • If additional_properties is a schema object, all properties not described in properties must have values matching the additional_properties schema.
  • enum (typing.Sequence[sob.abc.MarshallableTypes | None] | None) –

    The value/instance described by this schema should be among those in this sequence.

  • type_ (str | None) –

    See [OpenAPI 3 Data Types (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3. 1.1.md#data-types)], Swagger - OpenAPI 3 Data Types and OpenAPI 2 Data Types

    • "boolean"
    • "object"
    • "array"
    • "number"
    • "string"
    • "integer"
    • "file"
  • format_ (str | None) –

    See Open API 3 Data Type Format

    • "date-time": A date and time in the format YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45+01:00), YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00), or YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00).
    • "email"
    • "hostname"
    • "ipv4"
    • "ipv6"
    • "uri"
    • "uriref": A URI or a relative reference.
  • all_of (typing.Sequence[oapi.oas.model.Reference | oapi.oas.model.Schema] | None) –

    The value/instance described by the schema should also be valid as described by all sub-schemas in this sequence.

  • any_of (typing.Sequence[oapi.oas.model.Reference | oapi.oas.model.Schema] | None) –

    The value/instance described by the schema should also be valid as described in at least one of the sub-schemas in this sequence.

  • one_of (typing.Sequence[oapi.oas.model.Reference | oapi.oas.model.Schema] | None) –

    The value/instance described by the schema should also be valid as described in one (but only one) of the sub-schemas in this sequence.

  • is_not (oapi.oas.model.Reference | oapi.oas.model.Schema | None) –

    The value/instance described by this schema should * not* be valid as described by this sub-schema.

  • definitions (typing.Any | None) –

    Schema}): A dictionary of sub-schemas, stored for the purpose of referencing these sub-schemas elsewhere in the schema.

  • required (typing.Sequence[str] | None) –

    A list of attributes which must be present on the object instance described by this schema.

  • default (typing.Any | None) –

    The value presumed if the value/instance described by this schema is absent.

  • content_media_type (str | None) –
  • content_encoding (str | None) –
  • examples (typing.Sequence[sob.abc.MarshallableTypes | None] | None) –

    A list of valid examples of this object

  • nullable (bool | None) –

    If True, the value/instance described by this schema may be a null value (None). (Specific to OpenAPI, not part of the JSON Schema)

  • discriminator (oapi.oas.model.Discriminator | str | None) –

    Adds support for polymorphism. (Specific to OpenAPI, not part of the JSON Schema)

  • read_only (bool | None) –

    If True, the property described may be returned as part of a response, but should not be part of a request (Specific to OpenAPI, not part of the JSON Schema).

  • write_only (bool | None) –

    If True, the property described may be sent as part of a request, but should not be returned as part of a response (Specific to OpenAPI, not part of the JSON Schema).

  • xml (oapi.oas.model.XML | None) –

    Provides additional information describing XML representation of the property described by this schema (Specific to OpenAPI, not part of the JSON Schema).

  • external_docs (oapi.oas.model.ExternalDocumentation | None) –

    (Specific to OpenAPI, not part of the JSON Schema)

  • example (typing.Any | None) –

    (Specific to OpenAPI, not part of the JSON Schema)

  • definitions (typing.Any | None) –

    (Specific to OpenAPI, not part of the JSON Schema)

  • depracated (typing.Any | None) –

    If True, the property or instance described by this schema should be phased out, as if will no longer be supported in future versions (Specific to OpenAPI, not part of the JSON Schema).

Source code in src/oapi/oas/model.py 
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_maximum: (
        bool
        | None
    ) = None,
    minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    exclusive_minimum: (
        bool
        | None
    ) = None,
    max_length: (
        int
        | None
    ) = None,
    min_length: (
        int
        | None
    ) = None,
    pattern: (
        str
        | None
    ) = None,
    max_items: (
        int
        | None
    ) = None,
    min_items: (
        int
        | None
    ) = None,
    unique_items: (
        bool
        | None
    ) = None,
    items: (
        Reference
        | Schema
        | typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = None,
    max_properties: (
        int
        | None
    ) = None,
    min_properties: (
        int
        | None
    ) = None,
    properties: (
        Properties
        | None
    ) = None,
    additional_properties: (
        Reference
        | Schema
        | bool
        | None
    ) = None,
    enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    required: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    all_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = None,
    any_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = None,
    one_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = None,
    is_not: (
        Reference
        | Schema
        | None
    ) = None,
    definitions: (
        typing.Any
        | None
    ) = None,
    default: (
        typing.Any
        | None
    ) = None,
    discriminator: (
        Discriminator
        | str
        | None
    ) = None,
    read_only: (
        bool
        | None
    ) = None,
    write_only: (
        bool
        | None
    ) = None,
    xml: (
        XML
        | None
    ) = None,
    external_docs: (
        ExternalDocumentation
        | None
    ) = None,
    example: (
        typing.Any
        | None
    ) = None,
    deprecated: (
        bool
        | None
    ) = None,
    links: (
        typing.Sequence[
            Link
        ]
        | None
    ) = None,
    nullable: (
        bool
        | None
    ) = None,
    content_encoding: (
        str
        | None
    ) = None,
    content_media_type: (
        str
        | None
    ) = None,
    examples: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = None
) -> None:
    self.title: (
        str
        | None
    ) = title
    self.description: (
        str
        | None
    ) = description
    self.multiple_of: (
        float
        | int
        | decimal.Decimal
        | None
    ) = multiple_of
    self.maximum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = maximum
    self.exclusive_maximum: (
        bool
        | None
    ) = exclusive_maximum
    self.minimum: (
        float
        | int
        | decimal.Decimal
        | None
    ) = minimum
    self.exclusive_minimum: (
        bool
        | None
    ) = exclusive_minimum
    self.max_length: (
        int
        | None
    ) = max_length
    self.min_length: (
        int
        | None
    ) = min_length
    self.pattern: (
        str
        | None
    ) = pattern
    self.max_items: (
        int
        | None
    ) = max_items
    self.min_items: (
        int
        | None
    ) = min_items
    self.unique_items: (
        bool
        | None
    ) = unique_items
    self.items: (
        Reference
        | Schema
        | typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = items
    self.max_properties: (
        int
        | None
    ) = max_properties
    self.min_properties: (
        int
        | None
    ) = min_properties
    self.properties: (
        Properties
        | None
    ) = properties
    self.additional_properties: (
        Reference
        | Schema
        | bool
        | None
    ) = additional_properties
    self.enum: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = enum
    self.type_: (
        str
        | None
    ) = type_
    self.format_: (
        str
        | None
    ) = format_
    self.required: (
        typing.Sequence[
            str
        ]
        | None
    ) = required
    self.all_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = all_of
    self.any_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = any_of
    self.one_of: (
        typing.Sequence[
            Reference
        | Schema
        ]
        | None
    ) = one_of
    self.is_not: (
        Reference
        | Schema
        | None
    ) = is_not
    self.definitions: (
        typing.Any
        | None
    ) = definitions
    self.default: (
        typing.Any
        | None
    ) = default
    self.discriminator: (
        Discriminator
        | str
        | None
    ) = discriminator
    self.read_only: (
        bool
        | None
    ) = read_only
    self.write_only: (
        bool
        | None
    ) = write_only
    self.xml: (
        XML
        | None
    ) = xml
    self.external_docs: (
        ExternalDocumentation
        | None
    ) = external_docs
    self.example: (
        typing.Any
        | None
    ) = example
    self.deprecated: (
        bool
        | None
    ) = deprecated
    self.links: (
        typing.Sequence[
            Link
        ]
        | None
    ) = links
    self.nullable: (
        bool
        | None
    ) = nullable
    self.content_encoding: (
        str
        | None
    ) = content_encoding
    self.content_media_type: (
        str
        | None
    ) = content_media_type
    self.examples: (
        typing.Sequence[
            sob.abc.MarshallableTypes | None
        ]
        | None
    ) = examples
    super().__init__(_data)

SecurityScheme 

SecurityScheme(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    description: str | None = None,
    name: str | None = None,
    in_: str | None = None,
    scheme: str | None = None,
    bearer_format: str | None = None,
    flows: oapi.oas.model.OAuthFlows | None = None,
    open_id_connect_url: str | None = None,
    flow: str | None = None,
    authorization_url: str | None = None,
    token_url: str | None = None,
    scopes: typing.Mapping[str, str] | None = None,
)

Bases: sob.Object

[OpenAPI 3 Security Scheme Object] ](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md# security-scheme-object) | OpenAPI 2 Security Scheme Object

Attributes:

  • type_ (str | None) –

    OpenAPI 3x: "apiKey", "http", "mutualTLS", "oauth2", or "openIdConnect". OpenAPI 2x: "basic", "apiKey" or "oauth2".

  • description (str | None) –
  • name (str | None) –
  • in_ (str | None) –
  • scheme (str | None) –
  • bearer_format (str | None) –
  • flows (oapi.oas.model.OAuthFlows | None) –
  • open_id_connect_url (str | None) –
  • scopes (typing.Mapping[str, str] | None) –
  • flow (str | None) –

    "implicit", "password", "application" or "accessCode"

  • authorization_url (str | None) –
  • token_url (str | None) –
Source code in src/oapi/oas/model.py 
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    in_: (
        str
        | None
    ) = None,
    scheme: (
        str
        | None
    ) = None,
    bearer_format: (
        str
        | None
    ) = None,
    flows: (
        OAuthFlows
        | None
    ) = None,
    open_id_connect_url: (
        str
        | None
    ) = None,
    flow: (
        str
        | None
    ) = None,
    authorization_url: (
        str
        | None
    ) = None,
    token_url: (
        str
        | None
    ) = None,
    scopes: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.description: (
        str
        | None
    ) = description
    self.name: (
        str
        | None
    ) = name
    self.in_: (
        str
        | None
    ) = in_
    self.scheme: (
        str
        | None
    ) = scheme
    self.bearer_format: (
        str
        | None
    ) = bearer_format
    self.flows: (
        OAuthFlows
        | None
    ) = flows
    self.open_id_connect_url: (
        str
        | None
    ) = open_id_connect_url
    self.flow: (
        str
        | None
    ) = flow
    self.authorization_url: (
        str
        | None
    ) = authorization_url
    self.token_url: (
        str
        | None
    ) = token_url
    self.scopes: (
        typing.Mapping[
            str,
            str
        ]
        | None
    ) = scopes
    super().__init__(_data)

Server 

Server(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    url: str | None = None,
    description: str | None = None,
    variables: (
        typing.Mapping[str, oapi.oas.model.ServerVariable]
        | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Server Object

Attributes:

  • url (str | None) –
  • description (str | None) –
  • variables (typing.Mapping[str, oapi.oas.model.ServerVariable] | None) –
Source code in src/oapi/oas/model.py 
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    url: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    variables: (
        typing.Mapping[
            str,
            ServerVariable
        ]
        | None
    ) = None
) -> None:
    self.url: (
        str
        | None
    ) = url
    self.description: (
        str
        | None
    ) = description
    self.variables: (
        typing.Mapping[
            str,
            ServerVariable
        ]
        | None
    ) = variables
    super().__init__(_data)

ServerVariable 

ServerVariable(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    enum: typing.Sequence[str] | None = None,
    default: str | None = None,
    description: str | None = None,
)

Bases: sob.Object

OpenAPI 3 Server Variable Object

Attributes:

  • enum (typing.Sequence[str] | None) –
  • default (str | None) –
  • description (str | None) –
Source code in src/oapi/oas/model.py 
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    enum: (
        typing.Sequence[
            str
        ]
        | None
    ) = None,
    default: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None
) -> None:
    self.enum: (
        typing.Sequence[
            str
        ]
        | None
    ) = enum
    self.default: (
        str
        | None
    ) = default
    self.description: (
        str
        | None
    ) = description
    super().__init__(_data)

Tag 

Tag(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: str | None = None,
    description: str | None = None,
    external_docs: (
        oapi.oas.model.ExternalDocumentation | None
    ) = None,
)

Bases: sob.Object

OpenAPI 3 Tag Object

Attributes:

Source code in src/oapi/oas/model.py 
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    external_docs: (
        ExternalDocumentation
        | None
    ) = None
) -> None:
    self.name: (
        str
        | None
    ) = name
    self.description: (
        str
        | None
    ) = description
    self.external_docs: (
        ExternalDocumentation
        | None
    ) = external_docs
    super().__init__(_data)

XML 

XML(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: str | None = None,
    name_space: str | None = None,
    prefix: str | None = None,
    attribute: bool | None = None,
    wrapped: bool | None = None,
)

Bases: sob.Object

OpenAPI 3 XML Object

Attributes:

  • name (str | None) –

    The element name.

  • name_space (str | None) –

    The absolute URI of a namespace.

  • prefix (str | None) –

    The prefix to be used with the name to reference the name-space.

  • attribute (bool | None) –

    If True, the property described is an attribute rather than a sub-element.

  • wrapped (bool | None) –

    If True, an array instance described by the schema will be wrapped by a tag (named according to the parent element's property, while name refers to the child element name).

Source code in src/oapi/oas/model.py 
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    name_space: (
        str
        | None
    ) = None,
    prefix: (
        str
        | None
    ) = None,
    attribute: (
        bool
        | None
    ) = None,
    wrapped: (
        bool
        | None
    ) = None
) -> None:
    self.name: (
        str
        | None
    ) = name
    self.name_space: (
        str
        | None
    ) = name_space
    self.prefix: (
        str
        | None
    ) = prefix
    self.attribute: (
        bool
        | None
    ) = attribute
    self.wrapped: (
        bool
        | None
    ) = wrapped
    super().__init__(_data)