vehicle_service_catalog/vsc-error.yml at master · COVESA/vehicle_service_catalog · GitHub

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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
#
# Copyright 2021, Magnus Feuer
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
#

#
# Standard Vehicle Service Catalog error codes.
#
---

#
# The stdvsc namespace is composed of several standard files that all
# install their entries in the same stdvsc namespace.
#
name: stdvsc
major_version: 1
minor_version: 0
description: Standard error codes.

enumerations:
  #
  # Error enumeration
  #
  - name: error_t
    type: enumeration

    datatype: int16
    options:
        #
        # Null / no return value
        #
      - name: null
        value: 0
        description: No return value. Shall be used only as default value, shall never be explicitly returned
                     by a service implementation.

        #
        # Positive success codes
        #
      - name: ok
        value: 1
        description: Operation succeeded. Definition of success is method dependent.
                     Depending on operation, it can either indicate that the request was accepted or that the
                     corresponding physical operation (e.g. FOTA update, seat movement) has succeeded.

      - name: in_progress
        value: 2
        description: The operation has been initialized and is in progress.
                     May only be used by implementation framework and shall never be explicitly returned
                     by a service implementation.

# Do we see a need to differentiate between ok and completed
# Or shall we keep them but never specify both for an individual method, assuming that an individual method only can
# return once.
#       - name: completed
#        value: 3
#        description: The operation has been completed

        #
        # Negative error codes
        #
      - name: permission_denied
        value: -1
        description: Caller does not have permission to carry out operation

      - name: not_found
        value: -2
        description: A resource or service was not found, e.g. the addressed instance was not found or does not exist.

      - name: busy
        value: -3
        description: A resource or service needed for the operation is currently busy

      - name: invalid_argument
        value: -4
        description: One or more of the provided arguments are invalid, e.g. outside supported range.

      - name: incorrect_state
        value: -5
        description: The service is not in the correct state to perform operation

      - name: no_resource
        value: -6
        description: There are not enough resources to perform operation

      - name: expired
        value: -7
        description: The session or resource has expired and is no longer available

      - name: no_service
        value: -8
        description: The service or one of its dependent-upon services are not available

      - name: not_supported
        value: -9
        description: The operation is not supported by service implementation

      - name: lost_arbitration
        value: -10
        description: The operation was rejected in favor of a competing operation

      - name: interrupted
        value: -11
        description: The operation was interrupted

      - name: other
        value: -12
        description: Other error