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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2020 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package client
// ErrorKind distinguishes kind of errors.
type ErrorKind string
// error kind const value doc comments here have a non-default,
// specialized style (to help docs/error-kind.go):
//
// // ErrorKind...: DESCRIPTION .
//
// Note the mandatory dot at the end.
// `code-like` quoting should be used when meaningful.
// Error kinds. Keep https://forum.snapcraft.io/t/using-the-rest-api/18603#heading--errors in sync using doc/error-kinds.go.
const (
// ErrorKindTwoFactorRequired: the client needs to retry the
// `login` command including an OTP.
ErrorKindTwoFactorRequired ErrorKind = "two-factor-required"
// ErrorKindTwoFactorFailed: the OTP provided wasn't recognised.
ErrorKindTwoFactorFailed ErrorKind = "two-factor-failed"
// ErrorKindLoginRequired: the requested operation cannot be
// performed without an authenticated user. This is the kind
// of any other 401 Unauthorized response.
ErrorKindLoginRequired ErrorKind = "login-required"
// ErrorKindInvalidAuthData: the authentication data provided
// failed to validate (e.g. a malformed email address). The
// `value` of the error is an object with a key per failed field
// and a list of the failures on each field.
ErrorKindInvalidAuthData ErrorKind = "invalid-auth-data"
// ErrorKindPasswordPolicy: provided password doesn't meet
// system policy.
ErrorKindPasswordPolicy ErrorKind = "password-policy"
// ErrorKindAuthCancelled: authentication was cancelled by the user.
ErrorKindAuthCancelled ErrorKind = "auth-cancelled"
// ErrorKindTermsNotAccepted: deprecated, do not document.
ErrorKindTermsNotAccepted ErrorKind = "terms-not-accepted"
// ErrorKindNoPaymentMethods: deprecated, do not document.
ErrorKindNoPaymentMethods ErrorKind = "no-payment-methods"
// ErrorKindPaymentDeclined: deprecated, do not document.
ErrorKindPaymentDeclined ErrorKind = "payment-declined"
// ErrorKindSnapAlreadyInstalled: the requested snap is
// already installed.
ErrorKindSnapAlreadyInstalled ErrorKind = "snap-already-installed"
// ErrorKindSnapNotInstalled: the requested snap is not installed.
ErrorKindSnapNotInstalled ErrorKind = "snap-not-installed"
// ErrorKindSnapNotFound: the requested snap couldn't be found.
ErrorKindSnapNotFound ErrorKind = "snap-not-found"
// ErrorKindAppNotFound: the requested app couldn't be found.
ErrorKindAppNotFound ErrorKind = "app-not-found"
// ErrorKindSnapLocal: cannot perform operation on local snap.
ErrorKindSnapLocal ErrorKind = "snap-local"
// ErrorKindSnapNeedsDevMode: the requested snap needs devmode
// to be installed.
ErrorKindSnapNeedsDevMode ErrorKind = "snap-needs-devmode"
// ErrorKindSnapNeedsClassic: the requested snap needs classic
// confinement to be installed.
ErrorKindSnapNeedsClassic ErrorKind = "snap-needs-classic"
// ErrorKindSnapNeedsClassicSystem: the requested snap can't
// be installed on the current non-classic system.
ErrorKindSnapNeedsClassicSystem ErrorKind = "snap-needs-classic-system"
// ErrorKindSnapNotClassic: snap not compatible with classic mode.
ErrorKindSnapNotClassic ErrorKind = "snap-not-classic"
// ErrorKindSnapNoUpdateAvailable: the requested snap does not
// have an update available.
ErrorKindSnapNoUpdateAvailable ErrorKind = "snap-no-update-available"
// ErrorKindSnapRevisionNotAvailable: no snap revision available
// as specified.
ErrorKindSnapRevisionNotAvailable ErrorKind = "snap-revision-not-available"
// ErrorKindSnapChannelNotAvailable: no snap revision on specified
// channel. The `value` of the error is a rich object with
// requested `snap-name`, `action`, `channel`, `architecture`, and
// actually available `releases` as list of
// `{"architecture":... , "channel": ...}` objects.
ErrorKindSnapChannelNotAvailable ErrorKind = "snap-channel-not-available"
// ErrorKindSnapArchitectureNotAvailable: no snap revision on
// specified architecture. Value has the same format as for
// `snap-channel-not-available`.
ErrorKindSnapArchitectureNotAvailable ErrorKind = "snap-architecture-not-available"
// ErrorKindSnapChangeConflict: the requested operation would
// conflict with currently ongoing change. This is a temporary
// error. The error `value` is an object with optional fields
// `snap-name`, `change-kind` of the ongoing change.
ErrorKindSnapChangeConflict ErrorKind = "snap-change-conflict"
// ErrorKindQuotaChangeConflict: the requested operation would
// conflict with a currently ongoing change affecting the quota
// group. This is a temporary error. The error `value` is an
// object with optional fields `quota-name`, `change-kind` of the
// ongoing change.
ErrorKindQuotaChangeConflict ErrorKind = "quota-change-conflict"
// ErrorKindNotSnap: the given snap or directory does not
// look like a snap.
ErrorKindNotSnap ErrorKind = "snap-not-a-snap"
// ErrorKindInterfacesUnchanged: the requested interfaces'
// operation would have no effect.
ErrorKindInterfacesUnchanged ErrorKind = "interfaces-unchanged"
// ErrorKindBadQuery: a bad query was provided.
ErrorKindBadQuery ErrorKind = "bad-query"
// ErrorKindConfigNoSuchOption: the given configuration option
// does not exist.
ErrorKindConfigNoSuchOption ErrorKind = "option-not-found"
// ErrorKindAssertionNotFound: assertion can not be found.
ErrorKindAssertionNotFound ErrorKind = "assertion-not-found"
// ErrorKindConfdbViewNotFound: the confdb view can not be found.
ErrorKindConfdbViewNotFound ErrorKind = "confdb-view-not-found"
// ErrorKindConfdbNoMatchingRule: no view rule matches the request.
ErrorKindConfdbNoMatchingRule ErrorKind = "confdb-no-matching-rule"
// ErrorKindUnsuccessful: snapctl command was unsuccessful.
ErrorKindUnsuccessful ErrorKind = "unsuccessful"
// ErrorKindNetworkTimeout: a timeout occurred during the request.
ErrorKindNetworkTimeout ErrorKind = "network-timeout"
// ErrorKindDNSFailure: DNS not responding.
ErrorKindDNSFailure ErrorKind = "dns-failure"
// ErrorKindInsufficientDiskSpace: not enough disk space to perform the request.
ErrorKindInsufficientDiskSpace ErrorKind = "insufficient-disk-space"
// ErrorKindValidationSetNotFound: validation set cannot be found.
ErrorKindValidationSetNotFound ErrorKind = "validation-set-not-found"
// ErrorKindAppArmorPromptingNotRunning: AppArmor Prompting is not running.
ErrorKindAppArmorPromptingNotRunning ErrorKind = "apparmor-prompting-not-running"
// ErrorKindInterfacesRequestsPromptNotFound: interfaces requests prompt not found.
ErrorKindInterfacesRequestsPromptNotFound ErrorKind = "interfaces-requests-prompt-not-found"
// ErrorKindInterfacesRequestsRuleNotFound: interfaces requests rule not found.
ErrorKindInterfacesRequestsRuleNotFound ErrorKind = "interfaces-requests-rule-not-found"
// ErrorKindInterfacesRequestsInvalidFields: POST body to prompting API contains invalid fields.
ErrorKindInterfacesRequestsInvalidFields ErrorKind = "interfaces-requests-invalid-fields"
// ErrorKindInterfacesRequestsPatchedRuleHasNoPermissions: patched rule has no permission.
ErrorKindInterfacesRequestsPatchedRuleHasNoPermissions ErrorKind = "interfaces-requests-patched-rule-has-no-permissions"
// ErrorKindInterfacesRequestsNewSessionRuleNoSession: cannot create a rule with lifespan "session" when the user session is not present.
ErrorKindInterfacesRequestsNewSessionRuleNoSession ErrorKind = "interfaces-requests-new-session-rule-no-session"
// ErrorKindInterfacesRequestsReplyNotMatchRequest: the prompt reply does not match the path and/or permissions which were requested.
ErrorKindInterfacesRequestsReplyNotMatchRequest ErrorKind = "interfaces-requests-reply-not-match-request"
// ErrorKindInterfacesRequestsRuleConflict: a rule with conflicting path pattern and permissions already exists.
ErrorKindInterfacesRequestsRuleConflict ErrorKind = "interfaces-requests-rule-conflict"
// ErrorKindMissingSnapResourcePair: cannot find a snap-resource-pair when attempting to sideload a component.
ErrorKindMissingSnapResourcePair ErrorKind = "missing-snap-resource-pair"
// ErrorKindInvalidPassphrase: passphrase is invalid and/or does not pass quality checks.
ErrorKindInvalidPassphrase ErrorKind = "invalid-passphrase"
// ErrorKindInvalidPIN: PIN is invalid and/or does not pass quality checks.
ErrorKindInvalidPIN ErrorKind = "invalid-pin"
// ErrorKindUnsupportedByTargetSystem: target system does not support corresponding feature (e.g. client.StorageEncryptionFeaturePassphraseAuth).
ErrorKindUnsupportedByTargetSystem ErrorKind = "unsupported"
// ErrorKindSystemKeyVersionUnsupported: snapd does not support the system key version sent by the client.
ErrorKindSystemKeyVersionUnsupported ErrorKind = "unsupported-system-key-version"
)
// Maintenance error kinds.
// These are used only inside the maintenance field of responses.
// Keep https://forum.snapcraft.io/t/using-the-rest-api/18603#heading--maint-errors in sync using doc/error-kinds.go.
const (
// ErrorKindDaemonRestart: daemon is restarting.
ErrorKindDaemonRestart ErrorKind = "daemon-restart"
// ErrorKindSystemRestart: system is restarting.
ErrorKindSystemRestart ErrorKind = "system-restart"
)
|
