-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel_attachments_model_all_of__embedded_elements.go
More file actions
439 lines (363 loc) · 19.3 KB
/
model_attachments_model_all_of__embedded_elements.go
File metadata and controls
439 lines (363 loc) · 19.3 KB
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/*
OpenProject API V3 (Stable)
You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current development version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3). ## Introduction The documentation for the APIv3 is written according to the [OpenAPI 3.0 Specification](https://swagger.io/specification/). You can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/) or the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md), in your OpenProject installation under `/api/docs`. In the latter you can try out the various API endpoints directly interacting with our OpenProject data. Moreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml` (e.g. [here](https://community.openproject.org/api/v3/spec.yml)). The APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS). This means that each endpoint of this API will have links to other resources or actions defined in the resulting body. These related resources and actions for any given resource will be context sensitive. For example, only actions that the authenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any given response. As an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only be present when the user you authenticated has been granted a permission to update the work package in the assigned project. ## HAL+JSON HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API. Read more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08) **OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties: - `_type` - specifies the type of the resource (e.g.: WorkPackage, Project) - `_links` - contains all related resource and action links available for the resource - `_embedded` - contains all embedded objects HAL does not guarantee that embedded resources are embedded in their full representation, they might as well be partially represented (e.g. some properties can be left out). However in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**. ## API response structure All API responses contain a single HAL+JSON object, even collections of objects are technically represented by a single HAL+JSON object that itself contains its members. More details on collections can be found in the [Collections Section](https://www.openproject.org/docs/api/collections/). ## Authentication The API supports the following authentication schemes: OAuth2, session based authentication, and basic auth. Depending on the settings of the OpenProject instance many resources can be accessed without being authenticated. In case the instance requires authentication on all requests the client will receive an **HTTP 401** status code in response to any request. Otherwise unauthenticated clients have all the permissions of the anonymous user. ### Session-based Authentication This means you have to login to OpenProject via the Web-Interface to be authenticated in the API. This method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject. In this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication. ### API Key through Basic Auth Users can authenticate towards the API v3 using basic auth with the user name `apikey` (NOT your login) and the API key as the password. Users can find their API key on their account page. Example: ```shell API_KEY=2519132cdf62dcf5a66fd96394672079f9e9cad1 curl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42 ``` ### OAuth2.0 authentication OpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes. To get started, you first need to register an application in the OpenProject OAuth administration section of your installation. This will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`). You can then use one the following guides to perform the supported OAuth 2.0 flows: - [Authorization code flow](https://oauth.net/2/grant-types/authorization-code) - [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential. - [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access ### Why not username and password? The simplest way to do basic auth would be to use a user's username and password naturally. However, OpenProject already has supported API keys in the past for the API v2, though not through basic auth. Using **username and password** directly would have some advantages: * It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject. * No extra logic for token management necessary. On the other hand using **API keys** has some advantages too, which is why we went for that: * If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too. * They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general. Most importantly users may not actually have a password to begin with. Specifically when they have registered through an OpenID Connect provider. ## Cross-Origin Resource Sharing (CORS) By default, the OpenProject API is _not_ responding with any CORS headers. If you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned. Please see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on how to selectively enable CORS. ## Allowed HTTP methods - `GET` - Get a single resource or collection of resources - `POST` - Create a new resource or perform - `PATCH` - Update a resource - `DELETE` - Delete a resource ## Compression Responses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951) are supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3). If no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed.
API version: 3
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openproject
import (
"encoding/json"
"time"
"fmt"
)
// checks if the AttachmentsModelAllOfEmbeddedElements type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &AttachmentsModelAllOfEmbeddedElements{}
// AttachmentsModelAllOfEmbeddedElements struct for AttachmentsModelAllOfEmbeddedElements
type AttachmentsModelAllOfEmbeddedElements struct {
// Attachment's id
Id *int `json:"id,omitempty"`
// The name of the file
Title *string `json:"title,omitempty"`
// The name of the uploaded file
FileName string `json:"fileName"`
// The size of the uploaded file in Bytes
FileSize *int `json:"fileSize,omitempty"`
Description AttachmentModelDescription `json:"description"`
// The files MIME-Type as determined by the server
ContentType string `json:"contentType"`
Digest AttachmentModelDigest `json:"digest"`
// Time of creation
CreatedAt time.Time `json:"createdAt"`
Links *AttachmentModelLinks `json:"_links,omitempty"`
AdditionalProperties map[string]interface{}
}
type _AttachmentsModelAllOfEmbeddedElements AttachmentsModelAllOfEmbeddedElements
// NewAttachmentsModelAllOfEmbeddedElements instantiates a new AttachmentsModelAllOfEmbeddedElements object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewAttachmentsModelAllOfEmbeddedElements(fileName string, description AttachmentModelDescription, contentType string, digest AttachmentModelDigest, createdAt time.Time) *AttachmentsModelAllOfEmbeddedElements {
this := AttachmentsModelAllOfEmbeddedElements{}
this.FileName = fileName
this.Description = description
this.ContentType = contentType
this.Digest = digest
this.CreatedAt = createdAt
return &this
}
// NewAttachmentsModelAllOfEmbeddedElementsWithDefaults instantiates a new AttachmentsModelAllOfEmbeddedElements object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewAttachmentsModelAllOfEmbeddedElementsWithDefaults() *AttachmentsModelAllOfEmbeddedElements {
this := AttachmentsModelAllOfEmbeddedElements{}
return &this
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *AttachmentsModelAllOfEmbeddedElements) GetId() int {
if o == nil || IsNil(o.Id) {
var ret int
return ret
}
return *o.Id
}
// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetIdOk() (*int, bool) {
if o == nil || IsNil(o.Id) {
return nil, false
}
return o.Id, true
}
// HasId returns a boolean if a field has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) HasId() bool {
if o != nil && !IsNil(o.Id) {
return true
}
return false
}
// SetId gets a reference to the given int and assigns it to the Id field.
func (o *AttachmentsModelAllOfEmbeddedElements) SetId(v int) {
o.Id = &v
}
// GetTitle returns the Title field value if set, zero value otherwise.
func (o *AttachmentsModelAllOfEmbeddedElements) GetTitle() string {
if o == nil || IsNil(o.Title) {
var ret string
return ret
}
return *o.Title
}
// GetTitleOk returns a tuple with the Title field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetTitleOk() (*string, bool) {
if o == nil || IsNil(o.Title) {
return nil, false
}
return o.Title, true
}
// HasTitle returns a boolean if a field has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) HasTitle() bool {
if o != nil && !IsNil(o.Title) {
return true
}
return false
}
// SetTitle gets a reference to the given string and assigns it to the Title field.
func (o *AttachmentsModelAllOfEmbeddedElements) SetTitle(v string) {
o.Title = &v
}
// GetFileName returns the FileName field value
func (o *AttachmentsModelAllOfEmbeddedElements) GetFileName() string {
if o == nil {
var ret string
return ret
}
return o.FileName
}
// GetFileNameOk returns a tuple with the FileName field value
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetFileNameOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.FileName, true
}
// SetFileName sets field value
func (o *AttachmentsModelAllOfEmbeddedElements) SetFileName(v string) {
o.FileName = v
}
// GetFileSize returns the FileSize field value if set, zero value otherwise.
func (o *AttachmentsModelAllOfEmbeddedElements) GetFileSize() int {
if o == nil || IsNil(o.FileSize) {
var ret int
return ret
}
return *o.FileSize
}
// GetFileSizeOk returns a tuple with the FileSize field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetFileSizeOk() (*int, bool) {
if o == nil || IsNil(o.FileSize) {
return nil, false
}
return o.FileSize, true
}
// HasFileSize returns a boolean if a field has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) HasFileSize() bool {
if o != nil && !IsNil(o.FileSize) {
return true
}
return false
}
// SetFileSize gets a reference to the given int and assigns it to the FileSize field.
func (o *AttachmentsModelAllOfEmbeddedElements) SetFileSize(v int) {
o.FileSize = &v
}
// GetDescription returns the Description field value
func (o *AttachmentsModelAllOfEmbeddedElements) GetDescription() AttachmentModelDescription {
if o == nil {
var ret AttachmentModelDescription
return ret
}
return o.Description
}
// GetDescriptionOk returns a tuple with the Description field value
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetDescriptionOk() (*AttachmentModelDescription, bool) {
if o == nil {
return nil, false
}
return &o.Description, true
}
// SetDescription sets field value
func (o *AttachmentsModelAllOfEmbeddedElements) SetDescription(v AttachmentModelDescription) {
o.Description = v
}
// GetContentType returns the ContentType field value
func (o *AttachmentsModelAllOfEmbeddedElements) GetContentType() string {
if o == nil {
var ret string
return ret
}
return o.ContentType
}
// GetContentTypeOk returns a tuple with the ContentType field value
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetContentTypeOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.ContentType, true
}
// SetContentType sets field value
func (o *AttachmentsModelAllOfEmbeddedElements) SetContentType(v string) {
o.ContentType = v
}
// GetDigest returns the Digest field value
func (o *AttachmentsModelAllOfEmbeddedElements) GetDigest() AttachmentModelDigest {
if o == nil {
var ret AttachmentModelDigest
return ret
}
return o.Digest
}
// GetDigestOk returns a tuple with the Digest field value
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetDigestOk() (*AttachmentModelDigest, bool) {
if o == nil {
return nil, false
}
return &o.Digest, true
}
// SetDigest sets field value
func (o *AttachmentsModelAllOfEmbeddedElements) SetDigest(v AttachmentModelDigest) {
o.Digest = v
}
// GetCreatedAt returns the CreatedAt field value
func (o *AttachmentsModelAllOfEmbeddedElements) GetCreatedAt() time.Time {
if o == nil {
var ret time.Time
return ret
}
return o.CreatedAt
}
// GetCreatedAtOk returns a tuple with the CreatedAt field value
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetCreatedAtOk() (*time.Time, bool) {
if o == nil {
return nil, false
}
return &o.CreatedAt, true
}
// SetCreatedAt sets field value
func (o *AttachmentsModelAllOfEmbeddedElements) SetCreatedAt(v time.Time) {
o.CreatedAt = v
}
// GetLinks returns the Links field value if set, zero value otherwise.
func (o *AttachmentsModelAllOfEmbeddedElements) GetLinks() AttachmentModelLinks {
if o == nil || IsNil(o.Links) {
var ret AttachmentModelLinks
return ret
}
return *o.Links
}
// GetLinksOk returns a tuple with the Links field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) GetLinksOk() (*AttachmentModelLinks, bool) {
if o == nil || IsNil(o.Links) {
return nil, false
}
return o.Links, true
}
// HasLinks returns a boolean if a field has been set.
func (o *AttachmentsModelAllOfEmbeddedElements) HasLinks() bool {
if o != nil && !IsNil(o.Links) {
return true
}
return false
}
// SetLinks gets a reference to the given AttachmentModelLinks and assigns it to the Links field.
func (o *AttachmentsModelAllOfEmbeddedElements) SetLinks(v AttachmentModelLinks) {
o.Links = &v
}
func (o AttachmentsModelAllOfEmbeddedElements) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o AttachmentsModelAllOfEmbeddedElements) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Id) {
toSerialize["id"] = o.Id
}
if !IsNil(o.Title) {
toSerialize["title"] = o.Title
}
toSerialize["fileName"] = o.FileName
if !IsNil(o.FileSize) {
toSerialize["fileSize"] = o.FileSize
}
toSerialize["description"] = o.Description
toSerialize["contentType"] = o.ContentType
toSerialize["digest"] = o.Digest
toSerialize["createdAt"] = o.CreatedAt
if !IsNil(o.Links) {
toSerialize["_links"] = o.Links
}
for key, value := range o.AdditionalProperties {
toSerialize[key] = value
}
return toSerialize, nil
}
func (o *AttachmentsModelAllOfEmbeddedElements) UnmarshalJSON(data []byte) (err error) {
// This validates that all required properties are included in the JSON object
// by unmarshalling the object into a generic map with string keys and checking
// that every required field exists as a key in the generic map.
requiredProperties := []string{
"fileName",
"description",
"contentType",
"digest",
"createdAt",
}
allProperties := make(map[string]interface{})
err = json.Unmarshal(data, &allProperties)
if err != nil {
return err;
}
for _, requiredProperty := range(requiredProperties) {
if _, exists := allProperties[requiredProperty]; !exists {
return fmt.Errorf("no value given for required property %v", requiredProperty)
}
}
varAttachmentsModelAllOfEmbeddedElements := _AttachmentsModelAllOfEmbeddedElements{}
err = json.Unmarshal(data, &varAttachmentsModelAllOfEmbeddedElements)
if err != nil {
return err
}
*o = AttachmentsModelAllOfEmbeddedElements(varAttachmentsModelAllOfEmbeddedElements)
additionalProperties := make(map[string]interface{})
if err = json.Unmarshal(data, &additionalProperties); err == nil {
delete(additionalProperties, "id")
delete(additionalProperties, "title")
delete(additionalProperties, "fileName")
delete(additionalProperties, "fileSize")
delete(additionalProperties, "description")
delete(additionalProperties, "contentType")
delete(additionalProperties, "digest")
delete(additionalProperties, "createdAt")
delete(additionalProperties, "_links")
o.AdditionalProperties = additionalProperties
}
return err
}
type NullableAttachmentsModelAllOfEmbeddedElements struct {
value *AttachmentsModelAllOfEmbeddedElements
isSet bool
}
func (v NullableAttachmentsModelAllOfEmbeddedElements) Get() *AttachmentsModelAllOfEmbeddedElements {
return v.value
}
func (v *NullableAttachmentsModelAllOfEmbeddedElements) Set(val *AttachmentsModelAllOfEmbeddedElements) {
v.value = val
v.isSet = true
}
func (v NullableAttachmentsModelAllOfEmbeddedElements) IsSet() bool {
return v.isSet
}
func (v *NullableAttachmentsModelAllOfEmbeddedElements) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableAttachmentsModelAllOfEmbeddedElements(val *AttachmentsModelAllOfEmbeddedElements) *NullableAttachmentsModelAllOfEmbeddedElements {
return &NullableAttachmentsModelAllOfEmbeddedElements{value: val, isSet: true}
}
func (v NullableAttachmentsModelAllOfEmbeddedElements) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableAttachmentsModelAllOfEmbeddedElements) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}