aas 0.4.0

Data type bindings for the Asset Administration Shell Specs
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
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
//! Submodel Repository API

use crate::part1::v3_1::core::Submodel;
use crate::part2::v3_1::error::AASError;
use crate::part2::v3_1::services::SubmodelRepositoryService;
use axum::Json;
use axum::extract::State;
use std::sync::Arc;
use utoipa_axum::router::OpenApiRouter;
use utoipa_axum::routes;

#[utoipa::path(
    get,
    path = "/submodels",
    tag = "Submodel Repository API",
    summary = "Returns all Submodels",
    responses(
        (status = 200, description = "List of all Submodels"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn get_all_submodels<S: SubmodelRepositoryService>(
    State(service): State<Arc<S>>,
) -> Result<Json<Vec<Submodel>>, Json<AASError>> {
    service
        .find_all_submodels()
        .await
        .and_then(|submodels| Ok(Json(submodels)))
        .map_err(|e| e.into())
}

#[utoipa::path(
    post,
    path = "/submodels",
    tag = "Submodel Repository API",
    summary = "Creates a new Submodel",
    responses(
        (status = 201, description = "Submodel created successfully"),
        (status = 400, description = "Bad Request"),
        (status = 409, description = "Conflict - Submodel with same identifier already exists")
    )
)]
pub async fn post_submodel<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/$metadata",
    tag = "Submodel Repository API",
    summary = "Returns the metadata attributes of all Submodels",
    responses(
        (status = 200, description = "Metadata of all Submodels"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn get_all_submodels_metadata<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/$value",
    tag = "Submodel Repository API",
    summary = "Returns all Submodels in their ValueOnly representation",
    responses(
        (status = 200, description = "All Submodels in ValueOnly representation"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn get_all_submodels_value_only<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/$reference",
    tag = "Submodel Repository API",
    summary = "Returns the References for all Submodels",
    responses(
        (status = 200, description = "References of all Submodels"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn get_all_submodels_reference<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/$path",
    tag = "Submodel Repository API",
    summary = "Returns all Submodels in the Path notation",
    responses(
        (status = 200, description = "All Submodels in Path notation"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn get_all_submodels_path<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}",
    tag = "Submodel Repository API",
    summary = "Returns a specific Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Requested Submodel"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_submodel_by_id<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    put,
    path = "/submodels/{submodelIdentifier}",
    tag = "Submodel Repository API",
    summary = "Creates or updates an existing Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Submodel updated successfully"),
        (status = 201, description = "Submodel created successfully"),
        (status = 400, description = "Bad Request")
    )
)]
pub async fn put_submodel_by_id<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    patch,
    path = "/submodels/{submodelIdentifier}",
    tag = "Submodel Repository API",
    summary = "Updates an existing Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 204, description = "Submodel updated successfully"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn patch_submodel_by_id<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    delete,
    path = "/submodels/{submodelIdentifier}",
    tag = "Submodel Repository API",
    summary = "Deletes a Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 204, description = "Submodel deleted successfully"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn delete_submodel_by_id<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/$metadata",
    tag = "Submodel Repository API",
    summary = "Returns the metadata attributes of a specific Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Requested Submodel metadata"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_submodel_by_id_metadata<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    patch,
    path = "/submodels/{submodelIdentifier}/$metadata",
    tag = "Submodel Repository API",
    summary = "Updates the metadata attributes of an existing Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 204, description = "Submodel metadata updated successfully"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn patch_submodel_by_id_metadata<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/$value",
    tag = "Submodel Repository API",
    summary = "Returns a specific Submodel in the ValueOnly representation",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Requested Submodel in ValueOnly representation"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_submodel_by_id_value_only<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    patch,
    path = "/submodels/{submodelIdentifier}/$value",
    tag = "Submodel Repository API",
    summary = "Updates the values of an existing Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 204, description = "Submodel values updated successfully"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn patch_submodel_by_id_value_only<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/$reference",
    tag = "Submodel Repository API",
    summary = "Returns the Reference of a specific Submodel",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Requested Submodel reference"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_submodel_by_id_reference<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/$path",
    tag = "Submodel Repository API",
    summary = "Returns a specific Submodel in the Path notation",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Requested Submodel path"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_submodel_by_id_path<S: SubmodelRepositoryService>(State(_service): State<Arc<S>>) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/submodel-elements",
    tag = "Submodel Repository API",
    summary = "Returns all submodel elements including their hierarchy",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "List of all submodel elements"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_all_submodel_elements_submodel_repository<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    post,
    path = "/submodels/{submodelIdentifier}/submodel-elements",
    tag = "Submodel Repository API",
    summary = "Creates a new submodel element",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 201, description = "Submodel element created successfully"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Submodel not found"),
        (status = 409, description = "Submodel element already exists")
    )
)]
pub async fn post_submodel_element_submodel_repo<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/submodel-elements/$metadata",
    tag = "Submodel Repository API",
    summary = "Returns the metadata attributes of all submodel elements including their hierarchy",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "Metadata of all submodel elements"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_all_submodel_elements_metadata_submodel_repo<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/submodel-elements/$value",
    tag = "Submodel Repository API",
    summary = "Returns all submodel elements including their hierarchy in the ValueOnly representation",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "All submodel elements in ValueOnly representation"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_all_submodel_elements_value_only_submodel_repo<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/submodel-elements/$reference",
    tag = "Submodel Repository API",
    summary = "Returns the References of all submodel elements",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "References of all submodel elements"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_all_submodel_elements_reference_submodel_repo<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

#[utoipa::path(
    get,
    path = "/submodels/{submodelIdentifier}/submodel-elements/$path",
    tag = "Submodel Repository API",
    summary = "Returns all submodel elements including their hierarchy in the Path notation",
    params(
        ("submodelIdentifier" = String, Path, description = "The Submodel's unique id (UTF8-BASE64-URL-encoded)")
    ),
    responses(
        (status = 200, description = "All submodel elements in Path notation"),
        (status = 404, description = "Submodel not found")
    )
)]
pub async fn get_all_submodel_elements_path_submodel_repo<S: SubmodelRepositoryService>(
    State(_service): State<Arc<S>>,
) {
    unimplemented!()
}

pub fn router(service: impl SubmodelRepositoryService) -> OpenApiRouter {
    OpenApiRouter::new()
        // /submodels Pfadgruppe
        .routes(routes!(get_all_submodels, post_submodel,))
        // /submodels/$metadata Pfad
        .routes(routes!(get_all_submodels_metadata))
        // /submodels/$value Pfad
        .routes(routes!(get_all_submodels_value_only))
        // /submodels/$reference Pfad
        .routes(routes!(get_all_submodels_reference))
        // /submodels/$path Pfad
        .routes(routes!(get_all_submodels_path))
        // /submodels/{submodelIdentifier} Pfadgruppe
        .routes(routes!(
            get_submodel_by_id,
            put_submodel_by_id,
            patch_submodel_by_id,
            delete_submodel_by_id,
        ))
        // /submodels/{submodelIdentifier}/$metadata Pfadgruppe
        .routes(routes!(
            get_submodel_by_id_metadata,
            patch_submodel_by_id_metadata,
        ))
        // /submodels/{submodelIdentifier}/$value Pfadgruppe
        .routes(routes!(
            get_submodel_by_id_value_only,
            patch_submodel_by_id_value_only,
        ))
        // /submodels/{submodelIdentifier}/$reference Pfad
        .routes(routes!(get_submodel_by_id_reference))
        // /submodels/{submodelIdentifier}/$path Pfad
        .routes(routes!(get_submodel_by_id_path))
        // /submodels/{submodelIdentifier}/submodel-elements Pfadgruppe
        .routes(routes!(
            get_all_submodel_elements_submodel_repository,
            post_submodel_element_submodel_repo,
        ))
        // /submodels/{submodelIdentifier}/submodel-elements/$metadata Pfad
        .routes(routes!(get_all_submodel_elements_metadata_submodel_repo))
        // /submodels/{submodelIdentifier}/submodel-elements/$value Pfad
        .routes(routes!(get_all_submodel_elements_value_only_submodel_repo))
        // /submodels/{submodelIdentifier}/submodel-elements/$reference Pfad
        .routes(routes!(get_all_submodel_elements_reference_submodel_repo))
        // /submodels/{submodelIdentifier}/submodel-elements/$path Pfad
        .routes(routes!(get_all_submodel_elements_path_submodel_repo))
        .with_state(Arc::new(service))
}