response_success_with_json_api_response.md

petstore_api.components.responses.response_success_with_json_api_response

Response SuccessWithJsonApiResponse

Description

successful operation

ApiResponse

Name	Type	Description	Notes
response	urllib3.HTTPResponse	Raw response
body	api_response.ApiResponseDict
headers	HeadersDict

Body

Content-Type	Schema
"application/json"	content.application_json.Schema

Body Details

content ApplicationJson Schema

type: schemas.Schema

Ref Schema Info

Ref Schema	Input Type	Output Type
api_response.ApiResponse	api_response.ApiResponseDictInput, api_response.ApiResponseDict	api_response.ApiResponseDict

Headers

Headers

type: schemas.Schema

validate method

Input Type	Return Type	Notes
HeadersDictInput, HeadersDict	HeadersDict

Headers HeadersDictInput

type: typing.TypedDict

Key	Type	Description	Notes
int32	int
ref-content-schema-header	str
ref-schema-header	str
stringHeader	str
numberHeader	str		[optional]

Headers HeadersDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument	Type	Description	Notes
int32	int
stringHeader	str
numberHeader	str, schemas.Unset		[optional]

properties

Property	Type	Description	Notes
int32	int
stringHeader	str
numberHeader	str, schemas.Unset		[optional]

methods

Method	Input Type	Return Type	Notes
from_dict_	HeadersDictInput, HeadersDict	HeadersDict	a constructor
__getitem__	str	schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO	This model has invalid python names so this method is used under the hood when you access instance["ref-content-schema-header"], instance["ref-schema-header"],

[Back to top] [Back to Component Responses] [Back to README]