Skip to content

Latest commit

 

History

History
356 lines (240 loc) · 9.4 KB

EREErrorResponse.md

File metadata and controls

356 lines (240 loc) · 9.4 KB

Class: EREErrorResponse

Response sent by the ERE when some error/exception occurs while processing a request.

For instance, this may happen if the request is malformed or some internal error happens.

__

The attributes of this class are based on RFC-9457.

__

URI: ere:EREErrorResponse

 classDiagram
    class EREErrorResponse
    click EREErrorResponse href "../EREErrorResponse/"
      EREResponse <|-- EREErrorResponse
        click EREResponse href "../EREResponse/"
      
      EREErrorResponse : ere_request_id
        
      EREErrorResponse : error_detail
        
      EREErrorResponse : error_title
        
      EREErrorResponse : error_trace
        
      EREErrorResponse : error_type
        
      EREErrorResponse : timestamp
        
      EREErrorResponse : type
Loading

Inheritance

Slots

Name Cardinality and Range Description Inheritance
error_type 1
String		 A string representing the error type, eg, the FQN of the raised exception direct
error_title 0..1
String		 A human readable brief message about the error that occurred direct
error_detail 0..1
String		 A human readable detailed message about the error that occurred direct
error_trace 0..1
String		 A string representing a (stack) trace of the error that occurred direct
type 1
String		 The type of the request or result EREMessage
ere_request_id 1
String		 A string representing the unique ID of an ERE request, or the ID of the reque... EREMessage
timestamp 0..1
Datetime		 The time when the message was created EREMessage

Examples

Value
{
"type": "EREErrorResponse",
"request_id": "324fs3r345vx",
"error_type": "ere.exceptions.MalformedRequestError",
"error_title": "The entity data is missing in the request",
"error_detail": "The 'entity' attribute is required in EntityMentionResolutionRequest message",
// Optional and not recommended for production use
"error_trace": "Traceback (most recent call last):\n File "/app/ere/service.py", line 45, in process_request\n..."
}

|

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self ere:EREErrorResponse
native ere:EREErrorResponse

LinkML Source

Direct

Details ```yaml name: EREErrorResponse description: 'Response sent by the ERE when some error/exception occurs while processing a request.

For instance, this may happen if the request is malformed or some internal error happens.

The attributes of this class are based on RFC-9457.

' examples:

  • value: "{\n "type": "EREErrorResponse",\n "request_id": "324fs3r345vx"
    ,\n "error_type": "ere.exceptions.MalformedRequestError",\n "error_title"
    : "The entity data is missing in the request",\n "error_detail": "The 'entity'
    \ attribute is required in EntityMentionResolutionRequest message",\n // Optional
    \ and not recommended for production use\n "error_trace": "Traceback (most
    \ recent call last):\n File \"/app/ere/service.py\", line 45, in process_request\
    n..."\n}\n" from_schema: https://data.europa.eu/ers/schema/ere is_a: EREResponse attributes: error_type: name: error_type description: 'A string representing the error type, eg, the FQN of the raised exception.

    This corresponds to RFC-9457''s `type`.

'

    from_schema: https://data.europa.eu/ers/schema/ere rank: 1000 domain_of:

    • EREErrorResponse required: true error_title: name: error_title description: 'A human readable brief message about the error that occurred.

      This corresponds to RFC-9457''s title.

      ' from_schema: https://data.europa.eu/ers/schema/ere rank: 1000 domain_of:

    • EREErrorResponse error_detail: name: error_detail description: 'A human readable detailed message about the error that occurred.

      This corresponds to RFC-9457''s detail.

      ' from_schema: https://data.europa.eu/ers/schema/ere rank: 1000 domain_of:

    • EREErrorResponse error_trace: name: error_trace description: 'A string representing a (stack) trace of the error that occurred.

      This is optional and typically used for debugging purposes only, since

      exposing this kind of server-side information is a security risk.

      ' from_schema: https://data.europa.eu/ers/schema/ere rank: 1000 domain_of:

    • EREErrorResponse

</details>

### Induced

<details>
```yaml
name: EREErrorResponse
description: 'Response sent by the ERE when some error/exception occurs while processing
  a request.

  For instance, this may happen if the request is malformed or some internal error
  happens.


  The attributes of this class are based on [RFC-9457](https://datatracker.ietf.org/doc/html/rfc9457).

  '
examples:
- value: "{\n  \"type\": \"EREErrorResponse\",\n  \"request_id\": \"324fs3r345vx\"\
    ,\n  \"error_type\": \"ere.exceptions.MalformedRequestError\",\n  \"error_title\"\
    : \"The entity data is missing in the request\",\n  \"error_detail\": \"The 'entity'\
    \ attribute is required in EntityMentionResolutionRequest message\",\n  // Optional\
    \ and not recommended for production use\n  \"error_trace\": \"Traceback (most\
    \ recent call last):\\n  File \\\"/app/ere/service.py\\\", line 45, in process_request\\\
    n...\"\n}\n"
from_schema: https://data.europa.eu/ers/schema/ere
is_a: EREResponse
attributes:
  error_type:
    name: error_type
    description: 'A string representing the error type, eg, the FQN of the raised
      exception.


      This corresponds to RFC-9457''s `type`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: error_type
    owner: EREErrorResponse
    domain_of:
    - EREErrorResponse
    range: string
    required: true
  error_title:
    name: error_title
    description: 'A human readable brief message about the error that occurred.


      This corresponds to RFC-9457''s `title`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: error_title
    owner: EREErrorResponse
    domain_of:
    - EREErrorResponse
    range: string
  error_detail:
    name: error_detail
    description: 'A human readable detailed message about the error that occurred.


      This corresponds to RFC-9457''s `detail`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: error_detail
    owner: EREErrorResponse
    domain_of:
    - EREErrorResponse
    range: string
  error_trace:
    name: error_trace
    description: 'A string representing a (stack) trace of the error that occurred.


      This is optional and typically used for debugging purposes only, since

      exposing this kind of server-side information is a security risk.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: error_trace
    owner: EREErrorResponse
    domain_of:
    - EREErrorResponse
    range: string
  type:
    name: type
    description: "The type of the request or result.\n\nAs per LinkML specification,\
      \ `designates_type` is used here in order to allow for this\nslot to tell the\
      \ concrete subclass that an instance (such as a JSON object) belongs to.\n\n\
      In other words, a particular request will have `type` set with values like \n\
      `EntityMentionResolutionRequest` or `EntityResolutionResult`\n"
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    designates_type: true
    alias: type
    owner: EREErrorResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  ere_request_id:
    name: ere_request_id
    description: 'A string representing the unique ID of an ERE request, or the ID
      of the request a response is about.

      This **is not** the same as `request_id` + `source_id`.


      Note on notification responses: as per ERE contract, an `EntityMentionResolutionResponse`
      message

      can originate from within the ERE, without any previous request counterpart,
      as a notification of

      resolution update. In this case, `ere_request_id` has the prefix `ereNotification:`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: ere_request_id
    owner: EREErrorResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  timestamp:
    name: timestamp
    description: 'The time when the message was created. Should be in ISO-8601 format.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: timestamp
    owner: EREErrorResponse
    domain_of:
    - EREMessage
    range: datetime