-
Notifications
You must be signed in to change notification settings - Fork 7
/
openapi.yaml
1228 lines (1221 loc) · 37.7 KB
/
openapi.yaml
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- url: 'https://api.hel.fi/helerm/v1'
description: Production endpoint
info:
title: Helerm
description: >
Helsinki Electronic Records Management Classification System (helerm) OpenAPI specification.
version: ''
security:
- JWTAuth: []
paths:
/classification/:
get:
tags:
- classification
summary: Get a list of classifications
parameters:
- $ref: '#/components/parameters/paginationPage'
- $ref: '#/components/parameters/paginationPageSize'
- $ref: '#/components/parameters/includeRelated'
responses:
'200':
description: An array of classifications with pagination meta data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Classification'
'/classification/{classification_id}/':
get:
tags:
- classification
summary: Get a classification by its ID
parameters:
- name: classification_id
in: path
required: true
description: ID of the classification to fetch
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Classification'
'404':
$ref: '#/components/responses/NotFound'
/function/:
get:
tags:
- function
summary: Get a list of functions
parameters:
- $ref: '#/components/parameters/paginationPage'
- $ref: '#/components/parameters/paginationPageSize'
- name: valid_at
in: query
description: Return only functions that are valid at the given time
schema:
type: string
format: dateTime
- name: version
in: query
description: Return given version of the functions
schema:
type: integer
- name: state
in: query
description: With value "approved" return only the latest approved versions of the functions
schema:
type: string
enum:
- approved
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Function'
'/function/{function_id}/':
get:
tags:
- function
summary: Get a function by its ID
parameters:
- name: function_id
in: path
required: true
description: ID of the function to fetch
schema:
type: string
- name: valid_at
in: query
description: Return function only if it is valid at the given time
schema:
type: string
format: dateTime
- name: version
in: query
description: Return given version of the function
schema:
type: integer
- name: state
in: query
description: With value "approved" return the latest approved version of the function
schema:
type: string
enum:
- approved
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Function'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- function
summary: Create a new version of a function
description: >-
To update a function ie. to create a new version of it, PUT method must
be used. All new versions start from state "draft", and this cannot be changed with PUT.
parameters:
- name: function_id
in: path
required: true
description: ID of the function to put
schema:
type: string
- $ref: '#/components/parameters/includeApproved'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Function'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/NotAuthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Function'
description: The new function version data
required: true
patch:
tags:
- function
summary: Change a function's metadata (state, validity times)
description: 'To change a function''s state or validity times, PATCH method must be used. This will not affect the function''s version number.'
parameters:
- name: function_id
in: path
required: true
description: ID of the function to update
schema:
type: string
responses:
'200':
description: The function was updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Function'
'401':
$ref: '#/components/responses/NotAuthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
requestBody:
content:
application/json:
schema:
type: object
properties:
state:
description: Function state
type: string
enum:
- draft
- sent_for_review
- waiting_for_approval
- approved
example: sent_for_review
description: The new function version data
required: true
/attribute/:
get:
tags:
- attribute
summary: Get a list of attributes
parameters:
- $ref: '#/components/parameters/paginationPage'
- $ref: '#/components/parameters/paginationPageSize'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Attribute'
'/attribute/{attribute_id}/':
get:
tags:
- attribute
summary: Get a attribute by its ID
parameters:
- name: attribute_id
in: path
required: true
description: ID of the attribute to fetch
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Attribute'
'404':
$ref: '#/components/responses/NotFound'
/attribute/schemas/:
get:
tags:
- attribute
summary: Get attribute schemas
description: >-
Fetch schemas for the attributes dictionary for each structural element
(Function, Phase, Action, Record) in JSON Schema draft v4 format.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
function:
$ref: '#/components/schemas/AttributeSchema'
phase:
$ref: '#/components/schemas/AttributeSchema'
action:
$ref: '#/components/schemas/AttributeSchema'
record:
$ref: '#/components/schemas/AttributeSchema'
/template/:
get:
tags:
- template
summary: Get a list of function templates
parameters:
- $ref: '#/components/parameters/paginationPage'
- $ref: '#/components/parameters/paginationPageSize'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Template'
'/template/{template_id}/':
get:
tags:
- template
summary: Get a function template by its ID
parameters:
- name: template_id
in: path
required: true
description: ID of the function template to fetch
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Template'
'404':
$ref: '#/components/responses/NotFound'
/export/jhs191/:
get:
tags:
- export
summary: Get an export of the data
description: >
Get an export of the data in JHS191 XML format.
externalDocs:
description: JHS191 Recommendation (in Finnish), contains the schema for the XML
url: http://www.jhs-suositukset.fi/web/guest/jhs/recommendations/191
responses:
'200':
description: OK
content:
application/xml:
schema:
$ref: '#/components/schemas/tos:Tos'
/bulk-update/:
get:
tags:
- bulk-update
summary: Get a list of bulk updates
parameters:
- name: include_approved
in: query
description: Return all bulk updates. By default approved bulk updates are left out
schema:
type: integer
format: boolean
responses:
200:
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/BulkUpdate'
'404':
$ref: '#/components/responses/NotFound'
post:
tags:
- bulk-update
summary: Create new bulk update
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/NotAuthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/bulk-update/{bulk_update_id}/:
get:
tags:
- bulk_update
summary: Get a bulk update by its ID
parameters:
- name: bulk_update_id
in: path
required: true
description: ID of the bulk update to fetch
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdate'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- bulk_update
description: Change a bulk update's metadata and changeset
parameters:
- name: bulk_update_id
in: path
required: true
description: ID of the bulk update to update
schema:
type: string
responses:
'200':
description: The bulk update was updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdate'
'401':
$ref: '#/components/responses/NotAuthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/bulk-update/{bulk_update_id}/approve/:
post:
tags:
- bulk_update
description: Approve bulk update and apply its changes
parameters:
- name: bulk_update_id
in: path
required: true
description: ID of the bulk update to update
schema:
type: string
responses:
'200':
description: The bulk update was approved succesfully
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/NotAuthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
securitySchemes:
# TODO this isn't completely correct, as this means Authorization: Bearer <JWT token> instead of helerm's Authorization: JWT <JWT token>
JWTAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
RelatedClassification:
type: object
example:
id: 150c41a055804f7d97f1ee47be2d109d
version: 1
properties:
id:
description: Unique identifier
type: string
version:
description: Classification version number
type: integer
readOnly: true
Classification:
type: object
example:
id: 150c41a055804f7d97f1ee47be2d109d
created_at: '2017-08-28T09:25:22.097Z'
modified_at: '2017-08-28T09:25:22.190Z'
modified_by: 'Matti Meikäläinen'
version: 2
state: 'draft'
valid_from: '2017-08-28T09:25:22.097Z'
valid_to: '2018-08-28T09:25:22.097Z'
version_history:
state: 'draft'
version: 1
modified_at: '2017-08-28T20:46:34.796669Z'
valid_from: '2017-08-28T20:46:34.796644Z'
valid_to: '2017-08-28T20:46:34.796644Z'
modified_by: Matti Meikäläinen
code: 00 00
title: Hallintoasioiden ohjaus
parent: {}
description: Hallintoasioiden ohjaus on tarkkaa puuhaa
description_internal: Hallintoasioiden ohjaus on tarkkaa puuhaa
related_classification: Katso myös tehtäväluokka 00
additional_information: Lisätietoja tehtäväluokasta
phases: []
function_allowed: true
function: ffb1c68e3d024464bdb85a1876cfe446
function_state: draft
function_attributes: {}
properties:
id:
description: Unique identifier
type: string
created_at:
description: Creation time
type: string
format: dateTime
modified_at:
description: Last modification time
type: string
format: dateTime
modified_by:
description: First and last name of User
type: string
nullable: true
version:
description: Classification version number
type: integer
readOnly: true
state:
description: Classification state
type: string
enum:
- draft
- sent_for_review
- waiting_for_approval
- approved
valid_from:
type: string
format: date
description: The classification is valid starting from this date
valid_to:
type: string
format: date
description: The classification is valid until this date
version_history:
$ref: '#/components/schemas/VersionHistory'
code:
description: Classification code
type: string
title:
description: Title
type: string
parent:
$ref: '#/components/schemas/RelatedClassification'
description:
description: Description
type: string
description_internal:
description: Internal description
type: string
related_classification:
description: Notes about related classifications
type: string
additional_information:
description: Additional information
type: string
phases:
description: Phases related to the function. Served only on demand with 'include_related' query parameter.
type: array
items:
$ref: '#/components/schemas/Phase'
function_allowed:
description: Is it possible to create a function for this classification
type: boolean
function:
description: ID of the function that is related to this classification
type: string
function_state:
description: State of the function that is related to this classification
type: string
enum:
- draft
- sent_for_review
- waiting_for_approval
- approved
function_attributes:
$ref: '#/components/schemas/AttributeDict'
Function:
type: object
description: Function represents a handling process (käsittelyprosessi) in the JHS 191 data model
example:
id: a45949a848b54573bdad856f8a524f12
attributes: {}
version: 4
function_id: '00'
name: Hallintoasiat
parent: {}
classification: 112d25ac6dab4e59b9827f94ac2c06fe
created_at: '2017-08-25T10:10:00.346962Z'
modified_at: '2017-08-25T10:10:00.347001Z'
state: draft
valid_from: '2017-06-25'
valid_to: '2017-07-25'
version_history:
state: 'draft'
version: 1
modified_at: '2017-08-28T20:46:34.796669Z'
valid_from: '2017-08-28T20:46:34.796644Z'
valid_to: '2017-08-28T20:46:34.796644Z'
modified_by: Matti Meikäläinen
modified_by: 'Matti Meikäläinen'
classification_code: 01 00 00
classification_title: Työnantaja- ja henkilöstöpolitiikka
phases: []
properties:
id:
description: Unique identifier
type: string
readOnly: true
attributes:
$ref: '#/components/schemas/AttributeDict'
version:
description: Function version number
type: integer
readOnly: true
function_id:
description: Classification code of the function's classification
type: string
deprecated: true
name:
description: Title of the function's classification
type: string
deprecated: true
parent:
description: ID of the parent of the function's classification
type: string
deprecated: true
classification:
$ref: '#/components/schemas/RelatedClassification'
created_at:
description: Creation time
type: string
format: dateTime
readOnly: true
modified_at:
description: Last modification time
type: string
format: dateTime
readOnly: true
state:
description: Function state
type: string
enum:
- draft
- sent_for_review
- waiting_for_approval
- approved
valid_from:
type: string
format: date
description: The function is valid starting from this date
valid_to:
type: string
format: date
description: The function is valid until this date
version_history:
$ref: '#/components/schemas/VersionHistory'
modified_by:
description: First and last name of User
type: string
nullable: true
classification_code:
description: Classification code of this function's classification
type: string
classifition_title:
description: Title of this function's classification
phases:
type: array
items:
$ref: '#/components/schemas/Phase'
Phase:
description: |
Phase represents a top level action (toimenpide) in the JHS 191 data model.
In helerm there is a fixed two-tier structure Phase (parent) - Action (child), whereas in JHS an action can have 0..n levels of parent actions.
type: object
example:
id: 932284ee92004e77800abaeb90b3426f
attributes:
RetentionPeriodStart: Asian lopullinen ratkaisu
RetentionReason: >-
Ei sp: Yleishallinto 1 - kunnallisten asiakirjojen
säilytysaikasuositus
PublicityClass: Julkinen
TypeSpecifier: Neuvonta/Ohjaus
name: Neuvonta/Ohjaus
function: 20a6601de0bc4ca9a31755082e031282
actions: []
created_at: '2017-08-25T10:10:16.921Z'
modified_at: '2017-08-25T10:10:16.921Z'
index: 1
properties:
id:
description: Unique identifier
type: string
readOnly: true
attributes:
description: Attributes
type: string
name:
description: Name, populated from TypeSpecifier or PhaseType attribute
type: string
readOnly: true
function:
description: ID of the parent Function of the Phase
type: string
actions:
type: array
items:
$ref: '#/components/schemas/Action'
created_at:
description: Creation time
type: string
format: dateTime
readOnly: true
modified_at:
description: Last modification time
type: string
format: dateTime
readOnly: true
index:
description: Index number
type: integer
Action:
description: |
Action represents a top level action (toimenpide) in the JHS 191 data model.
In helerm there is a fixed two-tier structure Phase (parent) - Action (child), whereas in JHS an action can have 0..n levels of parent actions.
type: object
example:
id: c05f256a7a4e406cac5f194de7dd0df8
attributes:
TypeSpecifier: Neuvontapyynnön vastaanottaminen
name: Neuvontapyynnön vastaanottaminen
phase: 932284ee92004e77800abaeb90b3426f
records: []
created_at: '2017-08-25T10:10:16.925874Z'
modified_at: '2017-08-25T10:10:16.925901Z'
index: 1
properties:
id:
description: Unique identifier
type: string
readOnly: true
attributes:
$ref: '#/components/schemas/AttributeDict'
name:
description: Name, populated from TypeSpecifier or ActionType attribute
type: string
readOnly: true
phase:
description: ID of the parent Phase of the Action
type: string
records:
type: array
items:
$ref: '#/components/schemas/Record'
created_at:
description: Creation time
type: string
format: dateTime
readOnly: true
modified_at:
description: Last modification time
type: string
format: dateTime
index:
description: Index number
type: integer
Record:
type: object
example:
id: 05326c23c6cd4cce932ecd226e5424ec
attributes:
RetentionPeriodOffice: Säilytetään sähköisesti
TypeSpecifier: neuvontapyyntö
RecordType: pyyntö
ProtectionClass: 'Ei suojeluluokkaa, sähköinen asiakirja'
PublicityClass: Julkinen
SocialSecurityNumber: Ei sisällä henkilötunnusta
RetentionPeriodTotal: Säilytetään sähköisesti
InformationSystem: sähköposti
RetentionPeriodStart: Asian lopullinen ratkaisu
RetentionReason: >-
Ei sp: Yleishallinto 1 - kunnallisten asiakirjojen
säilytysaikasuositus
StorageOrder: Säilytetään sähköisesti
PersonalData: Sisältää henkilötietoja
name: neuvontapyyntö
action: c05f256a7a4e406cac5f194de7dd0df8
parent: null
created_at: '2017-08-25T10:10:16.927508Z'
modified_at: '2017-08-25T10:10:16.927535Z'
index: 1
properties:
id:
description: Unique identifier
type: string
readOnly: true
attributes:
$ref: '#/components/schemas/AttributeDict'
name:
description: Name, populated from TypeSpecifier or RecordType attribute
type: string
readOnly: true
action:
description: ID of the parent Action of the Record
type: string
parent:
description: ID of the parent Record of the Record. Needed for Record attachments, they are declared as child Records.
type: string
created_at:
description: Creation time
type: string
format: dateTime
readOnly: true
modified_at:
description: Last modification time
type: string
format: dateTime
readOnly: true
index:
description: Index number
type: integer
Attribute:
type: object
example:
id: 8d4af5242cc64dad962fa0ab6b37ed58
values:
- id: 735c6cc11b8b4625a3e9eb80e3f490e9
created_at: '2017-08-28T20:46:34.796644Z'
modified_at: '2017-08-28T20:46:34.796669Z'
value: '1'
index: 1
group: Ryhmä X
created_at: '2017-08-28T20:45:23.163092Z'
modified_at: '2017-08-28T20:48:48.093356Z'
identifier: Restriction.ProtectionLevel
name: Suojaustaso
index: 9
help_text: ''
properties:
id:
description: Unique identifier
type: string
values:
type: array
items:
$ref: '#/components/schemas/AttributeValue'
group:
description: Attribute group
type: string
created_at:
description: Creation time
type: string
format: dateTime
modified_at:
description: Last modification time
type: string
format: dateTime
identifier:
description: >-
The attribute identifier that is used in the attributes dictionary
when referring to this attribute
type: string
name:
description: Title of the attribute
type: string
index:
description: Index number
type: integer
help_text:
description: Brief information about the attribute
type: string
AttributeValue:
type: object
example:
id: 735c6cc11b8b4625a3e9eb80e3f490e9
created_at: '2017-08-28T20:46:34.796644Z'
modified_at: '2017-08-28T20:46:34.796669Z'
value: '1'
index: 1
properties:
id:
description: Unique identifier
type: string
created_at:
description: Creation time
type: string
format: dateTime
modified_at:
description: Last modification time
type: string
format: dateTime
value:
description: The actual value
type: string
index:
description: Index number
type: integer
AttributeDict:
type: object
description: |
Key value store that contains attributes and their values for a structural element. Keys are attribute identifiers.
An attribute cannot have empty or null value, in that case the whole field is omitted from the dict.
Example:
{
"StorageOrder": "Säilytetään sähköisesti",
"PersonalData": "Sisältää henkilötietoja"
}
example:
StorageOrder: Säilytetään sähköisesti
PersonalData: Sisältää henkilötietoja
additionalProperties: true
AttributeSchema:
example:
properties:
ProcessStatus:
type: string
ActionType:
type: string
InformationSystem:
type: string
AdditionalInformation:
type: string
TypeSpecifier:
type: string
$schema: 'http://json-schema.org/draft-04/schema#'
type: object
additionalProperties: false
type: object
Template:
type: object
example:
id: bb29ec518a5a4c0cbcb9606e86bc022f
attributes: {}
phases: []
created_at: '2017-08-25T10:11:49.788923Z'
modified_at: '2017-08-25T13:23:50.410024Z'
name: Ahjo-moduuli
properties:
id:
description: Unique identifier
type: string
attributes:
$ref: '#/components/schemas/AttributeDict'
phases:
type: array
items:
$ref: '#/components/schemas/Phase'
created_at:
description: Creation time
type: string
format: dateTime
modified_at:
description: Last modification time
type: string
format: dateTime
name:
description: Name of the function template
type: string
Pagination:
type: object
properties:
count:
type: integer
next:
type: string
previous:
type: string
VersionHistory:
type: object
example:
state: 'draft'
version: 1
modified_at: '2017-08-28T20:46:34.796669Z'
valid_from: '2017-08-28T20:46:34.796644Z'
valid_to: '2017-08-28T20:46:34.796644Z'
modified_by: Matti Meikäläinen
properties:
state:
description: Object state
type: string
enum:
- draft
- sent_for_review
- waiting_for_approval
- approved
version:
description: Object version number