conjure-error 0.3.9

Runtime support for generated Conjure errors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

types:
  definitions:
    default-package: com.palantir.conjure.error
    objects:
      ErrorCode:
        docs: |
          The broad category of a Conjure error.

          When an error is transmitted over HTTP, this determines the response's status code.
        values:
          - PERMISSION_DENIED
          - INVALID_ARGUMENT
          - NOT_FOUND
          - CONFLICT
          - REQUEST_ENTITY_TOO_LARGE
          - FAILED_PRECONDITION
          - INTERNAL
          - TIMEOUT
          - CUSTOM_CLIENT
          - CUSTOM_SERVER
      SerializableError:
        docs: The JSON-serializable representation of an error.
        fields:
          errorCode:
            docs: |
              The broad category of the error.

              When transmitted over HTTP, this determines the response's status code.
            type: ErrorCode
          errorName:
            docs: |
              The error's name.

              The name is made up of a namespace and more specific error name, separated by a `:`.
            type: string
          errorInstanceId:
            docs: |
              A unique identifier for this error instance.

              This can be used to correlate reporting about the error as it transfers between components of a
              distributed system.
            type: uuid
          parameters:
            docs: Parameters providing more information about the error.
            type: map<string, string>
    errors:
      PermissionDenied:
        docs: A generic `PERMISSION_DENIED` error.
        namespace: Default
        code: PERMISSION_DENIED
      InvalidArgument:
        docs: A generic `INVALID_ARGUMENT` error.
        namespace: Default
        code: INVALID_ARGUMENT
      NotFound:
        docs: A generic `NOT_FOUND` error.
        namespace: Default
        code: NOT_FOUND
      Conflict:
        docs: A generic `CONFLICT` error.
        namespace: Default
        code: CONFLICT
      RequestEntityTooLarge:
        docs: A generic `REQUEST_ENTITY_TOO_LARGE` error.
        namespace: Default
        code: REQUEST_ENTITY_TOO_LARGE
      FailedPrecondition:
        docs: A generic `FAILED_PRECONDITION` error.
        namespace: Default
        code: FAILED_PRECONDITION
      Internal:
        docs: A generic `INTERNAL` error.
        namespace: Default
        code: INTERNAL
      Timeout:
        docs: A generic `TIMEOUT` error.
        namespace: Default
        code: TIMEOUT