Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 3.1 KB

Problem.md

File metadata and controls

38 lines (29 loc) · 3.1 KB
Raw

icasdk.model.problem.Problem

RFC 7807 Problem object (https://tools.ietf.org/html/rfc7807)

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, RFC 7807 Problem object (https://tools.ietf.org/html/rfc7807)

Dictionary Keys

Key Input Type Accessed Type Description Notes
title str, str, A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation;
type str, str, A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
parameters dict, frozendict.frozendict, frozendict.frozendict, Problem parameters for e.g. request body attribute validation. This attribute is not in scope of RFC 7807.
status decimal.Decimal, int, decimal.Decimal, The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. value must be a 32 bit integer
timestamp str, datetime, str, value must conform to RFC-3339 date-time
id str, uuid.UUID, str, [optional] value must be a uuid
detail str, str, A human-readable explanation specific to this occurrence of the problem. [optional]
instance str, str, A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

parameters

Problem parameters for e.g. request body attribute validation. This attribute is not in scope of RFC 7807.

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Problem parameters for e.g. request body attribute validation. This attribute is not in scope of RFC 7807.

Dictionary Keys

Key Input Type Accessed Type Description Notes
any_string_name str, str, any string name can be used but the value must be the correct type Problem parameters for e.g. request body attribute validation. This attribute is not in scope of RFC 7807. [optional]

[Back to Model list] [Back to API list] [Back to README]