ODataV4Format Класс

  • Ссылка

Класс для описания формата ошибки OData версии 4.

http://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html#_Toc372793091

Пример JSON:

error: { "code": "ValidationError", "message": "Одно или несколько полей содержат неверные значения: ", "details": [

  {
     "code": "ValidationError",
     "target": "representation",
     "message": "Parsing error(s): String '' does not match regex pattern '^[^{}/ :]+(?: :\d+)?$'.
     Path 'host', line 1, position 297."

  },
  {

     "code": "ValidationError",
     "target": "representation",
     "message": "Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specificate
     https: //github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
     (schema [https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json))."

  }

]

}

Наследование
builtins.object
ODataV4Format

Конструктор

ODataV4Format(json_object: Mapping[str, Any])

Параметры

json_object
dict
Обязательно

Дикт Python, представляющий JSON ODataV4

Переменные

~.code
str

Его значением является код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

message
str

Удобочитаемое, зависят от языка представление ошибки.

target
str

Целевой объект конкретной ошибки (например, имя свойства в ошибке). Это поле является необязательным и может иметь значение None.

details
list[ODataV4Format]

Массив экземпляров ODataV4Format, которые ДОЛЖНЫ содержать пары "имя-значение" для кода и сообщения и могут содержать пару "имя-значение" для целевого объекта, как описано выше.

innererror
dict

Объект. Содержимое этого объекта определяется службой. Обычно этот объект содержит сведения, которые помогут выполнить отладку службы.

Методы

message_details

Возвращает подробную строку ошибки.

message_details

Возвращает подробную строку ошибки.

message_details() -> str

Возвращаемое значение

Строка с подробными сведениями об ошибке.

Возвращаемый тип

str

Атрибуты

error

CODE_LABEL 

CODE_LABEL = 'code'

DETAILS_LABEL 

DETAILS_LABEL = 'details'

INNERERROR_LABEL 

INNERERROR_LABEL = 'innererror'

MESSAGE_LABEL 

MESSAGE_LABEL = 'message'

TARGET_LABEL 

TARGET_LABEL = 'target'