forked from keboola/keboola-as-code
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdesign.go
1786 lines (1640 loc) · 55.1 KB
/
design.go
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
//nolint:gochecknoglobals
package templates
import (
"fmt"
"strings"
"github.com/spf13/cast"
_ "goa.design/goa/v3/codegen/generator"
"goa.design/goa/v3/codegen/service"
. "goa.design/goa/v3/dsl"
"goa.design/goa/v3/eval"
"goa.design/goa/v3/expr"
"goa.design/goa/v3/http/codegen/openapi"
cors "goa.design/plugins/v3/cors/dsl"
"github.com/keboola/keboola-as-code/internal/pkg/encoding/json"
_ "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/anytype"
"github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/dependencies"
_ "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/errormsg"
_ "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/genericerror"
"github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/oneof"
_ "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/oneof"
_ "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/operationid"
. "github.com/keboola/keboola-as-code/internal/pkg/service/common/goaextension/token"
)
const (
TaskStatusProcessing = "processing"
TaskStatusSuccess = "success"
TaskStatusError = "error"
)
// API definition ------------------------------------------------------------------------------------------------------
//nolint:gochecknoinits
func init() {
dependenciesType := func(method *service.MethodData) string {
if dependencies.HasSecurityScheme("APIKey", method) {
return "dependencies.ProjectRequestScope"
}
return "dependencies.PublicRequestScope"
}
dependencies.RegisterPlugin(dependencies.Config{
Package: "github.com/keboola/keboola-as-code/internal/pkg/service/templates/dependencies",
DependenciesTypeFn: dependenciesType,
DependenciesProviderFn: func(method *service.EndpointMethodData) string {
t := dependenciesType(method.MethodData)
return fmt.Sprintf(`ctx.Value(%sCtxKey).(%s)`, t, t)
},
})
}
var _ = API("templates", func() {
Randomizer(expr.NewDeterministicRandomizer())
Title("Templates Service")
Description("A service for applying templates to Keboola projects.")
Version("1.0")
HTTP(func() {
Path("v1")
Consumes("application/json")
Produces("application/json")
})
Server("templates", func() {
Host("production", func() {
URI("https://templates.{stack}")
Variable("stack", String, "Base URL of the stack", func() {
Default("keboola.com")
Enum("keboola.com", "eu-central-1.keboola.com", "north-europe.azure.keboola.com", "eu-west-1.aws.keboola.dev", "east-us-2.azure.keboola-testing.com")
})
})
Host("localhost", func() {
URI("http://localhost:8000")
})
})
})
// Service definition --------------------------------------------------------------------------------------------------
var _ = Service("templates", func() {
Description("Service for applying templates to Keboola projects.")
// CORS
cors.Origin("*", func() {
cors.Headers("Content-Type", "X-StorageApi-Token")
cors.Methods("GET", "POST", "PUT", "DELETE")
})
// Set authentication by token to all endpoints without NoSecurity()
Security(tokenSecurity)
defer AddTokenHeaderToPayloads(tokenSecurity, "storageApiToken", "X-StorageApi-Token")
// Auxiliary endpoints ---------------------------------------------------------------------------------------------
Method("ApiRootIndex", func() {
Meta("openapi:summary", "Redirect to /v1")
Description("Redirect to /v1.")
NoSecurity()
HTTP(func() {
// Redirect / -> /v1
GET("//")
Meta("openapi:tag:documentation")
Redirect("/v1", StatusMovedPermanently)
})
})
Method("ApiVersionIndex", func() {
Meta("openapi:summary", "List API name and link to documentation.")
Description("List API name and link to documentation.")
NoSecurity()
Result(ServiceDetail)
HTTP(func() {
GET("")
Meta("openapi:tag:documentation")
Response(StatusOK)
})
})
Method("HealthCheck", func() {
NoSecurity()
Result(String, func() {
Example("OK")
})
HTTP(func() {
GET("//health-check")
Meta("openapi:generate", "false")
Response(StatusOK, func() {
ContentType("text/plain")
})
})
})
Files("/documentation/openapi.json", "openapi.json", func() {
Meta("openapi:summary", "Swagger 2.0 JSON Specification")
Meta("openapi:tag:documentation")
})
Files("/documentation/openapi.yaml", "openapi.yaml", func() {
Meta("openapi:summary", "Swagger 2.0 YAML Specification")
Meta("openapi:tag:documentation")
})
Files("/documentation/openapi3.json", "openapi3.json", func() {
Meta("openapi:summary", "OpenAPI 3.0 JSON Specification")
Meta("openapi:tag:documentation")
})
Files("/documentation/openapi3.yaml", "openapi3.yaml", func() {
Meta("openapi:summary", "OpenAPI 3.0 YAML Specification")
Meta("openapi:tag:documentation")
})
Files("/documentation/{*path}", "swagger-ui", func() {
Meta("openapi:generate", "false")
Meta("openapi:summary", "Swagger UI")
Meta("openapi:tag:documentation")
})
// Template endpoints ----------------------------------------------------------------------------------------------
Method("RepositoriesIndex", func() {
Meta("openapi:summary", "List template repositories")
Description("List all template repositories defined in the project.")
Result(Repositories)
HTTP(func() {
GET("/repositories")
Meta("openapi:tag:template")
Response(StatusOK)
})
})
Method("RepositoryIndex", func() {
Meta("openapi:summary", "Get template repository detail")
Description("Get details of specified repository. Use \"keboola\" for default Keboola repository.")
Result(Repository)
Payload(RepositoryRequest)
HTTP(func() {
GET("/repositories/{repository}")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
})
})
Method("TemplatesIndex", func() {
Meta("openapi:summary", "List templates in the repository")
Description("List all templates defined in the repository.")
Result(Templates)
Payload(RepositoryRequest)
HTTP(func() {
GET("/repositories/{repository}/templates")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
})
})
Method("TemplateIndex", func() {
Meta("openapi:summary", "Get template detail and versions")
Description("Get detail and versions of specified template.")
Result(TemplateDetail)
Payload(TemplateRequest)
HTTP(func() {
GET("/repositories/{repository}/templates/{template}")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
TemplateNotFoundError()
})
})
Method("VersionIndex", func() {
Meta("openapi:summary", "Get version detail")
Description("Get details of specified template version.")
Result(VersionDetailExtended)
Payload(TemplateVersionRequest)
HTTP(func() {
GET("/repositories/{repository}/templates/{template}/{version}")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
TemplateNotFoundError()
VersionNotFoundError()
})
})
Method("InputsIndex", func() {
Meta("openapi:summary", "Get inputs")
Description("Get inputs for the \"use\" API call.")
Result(Inputs)
Payload(TemplateVersionRequest)
HTTP(func() {
GET("/repositories/{repository}/templates/{template}/{version}/inputs")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
TemplateNotFoundError()
VersionNotFoundError()
})
})
Method("ValidateInputs", func() {
Meta("openapi:summary", "Validate inputs")
Description("Validate inputs for the \"use\" API call.\nOnly configured steps should be send.")
Result(ValidationResult)
Payload(ValidateInputsRequest)
HTTP(func() {
POST("/repositories/{repository}/templates/{template}/{version}/validate")
Meta("openapi:tag:template")
Response(StatusOK)
RepositoryNotFoundError()
TemplateNotFoundError()
VersionNotFoundError()
})
})
Method("UseTemplateVersion", func() {
Meta("openapi:summary", "Use template")
Description("Validate inputs and use template in the branch.\nOnly configured steps should be send.")
Result(Task)
Payload(UseTemplateRequest)
Error("InvalidInputs", ValidationError, "Inputs are not valid.")
HTTP(func() {
POST("/repositories/{repository}/templates/{template}/{version}/use")
Meta("openapi:tag:template")
Response(StatusAccepted)
Response("InvalidInputs", StatusBadRequest)
RepositoryNotFoundError()
TemplateNotFoundError()
VersionNotFoundError()
ProjectLockedError()
})
})
// Instance endpoints ----------------------------------------------------------------------------------------------
Method("InstancesIndex", func() {
Meta("openapi:summary", "List instances")
Result(Instances)
Payload(BranchRequest)
HTTP(func() {
GET("/project/{branch}/instances")
Meta("openapi:tag:instance")
BranchNotFoundError()
})
})
Method("InstanceIndex", func() {
Meta("openapi:summary", "Get instance detail")
Result(InstanceDetail)
Payload(InstanceRequest)
HTTP(func() {
GET("/project/{branch}/instances/{instanceId}")
Meta("openapi:tag:instance")
Response(StatusOK)
BranchNotFoundError()
RepositoryNotFoundError()
InstanceNotFoundError()
})
})
Method("UpdateInstance", func() {
Meta("openapi:summary", "Update instance name")
Result(InstanceDetail)
Payload(UpdateInstanceRequest)
HTTP(func() {
PUT("/project/{branch}/instances/{instanceId}")
Meta("openapi:tag:instance")
Response(StatusOK)
BranchNotFoundError()
InstanceNotFoundError()
ProjectLockedError()
})
})
Method("DeleteInstance", func() {
Meta("openapi:summary", "Delete instance")
Result(Task)
Payload(InstanceRequest)
HTTP(func() {
DELETE("/project/{branch}/instances/{instanceId}")
Meta("openapi:tag:instance")
Response(StatusAccepted)
BranchNotFoundError()
InstanceNotFoundError()
ProjectLockedError()
})
})
Method("UpgradeInstance", func() {
Meta("openapi:summary", "Re-generate the instance in the same or different version")
Result(Task)
Error("InvalidInputs", ValidationError, "Inputs are not valid.")
Payload(UpgradeInstanceRequest)
HTTP(func() {
POST("/project/{branch}/instances/{instanceId}/upgrade/{version}")
Meta("openapi:tag:instance")
Response(StatusAccepted)
Response("InvalidInputs", StatusBadRequest)
TemplateNotFoundError()
BranchNotFoundError()
InstanceNotFoundError()
VersionNotFoundError()
ProjectLockedError()
})
})
Method("UpgradeInstanceInputsIndex", func() {
Meta("openapi:summary", "Get inputs for upgrade operation")
Result(Inputs)
Payload(InstanceInputsRequest)
HTTP(func() {
GET("/project/{branch}/instances/{instanceId}/upgrade/{version}/inputs")
Meta("openapi:tag:instance")
Response(StatusOK)
TemplateNotFoundError()
BranchNotFoundError()
InstanceNotFoundError()
VersionNotFoundError()
})
})
Method("UpgradeInstanceValidateInputs", func() {
Meta("openapi:summary", "Validate inputs for upgrade operation")
Result(ValidationResult)
Payload(UpgradeInstanceRequest)
HTTP(func() {
POST("/project/{branch}/instances/{instanceId}/upgrade/{version}/inputs")
Meta("openapi:tag:instance")
Response(StatusOK)
TemplateNotFoundError()
BranchNotFoundError()
InstanceNotFoundError()
VersionNotFoundError()
})
})
Method("GetTask", func() {
Meta("openapi:summary", "Get task")
Description("Get details of a task.")
Result(Task)
Payload(GetTaskRequest)
HTTP(func() {
GET("/tasks/{*taskId}")
Meta("openapi:tag:configuration")
Response(StatusOK)
TaskNotFoundError()
})
})
})
// Task --------------------------------------------------------------------------------------------------------------
var TaskID = Type("TaskID", String, func() {
Meta("struct:field:type", "= task.ID", "github.com/keboola/keboola-as-code/internal/pkg/service/common/task")
Description("Unique ID of the task.")
Example("task_1234")
})
var Task = Type("Task", func() {
Description("An asynchronous task.")
Attribute("id", TaskID)
Attribute("type", String, "Task type.")
Attribute("url", String, func() {
Description("URL of the task.")
})
Attribute("status", String, func() {
values := []any{TaskStatusProcessing, TaskStatusSuccess, TaskStatusError}
Description(fmt.Sprintf("Task status, one of: %s", strings.Join(cast.ToStringSlice(values), ", ")))
Enum(values...)
})
Attribute("isFinished", Boolean, func() {
Description("Shortcut for status != \"processing\".")
})
Attribute("createdAt", String, func() {
Description("Date and time of the task creation.")
Format(FormatDateTime)
Example("2022-04-28T14:20:04.000Z")
})
Attribute("finishedAt", String, func() {
Description("Date and time of the task end.")
Format(FormatDateTime)
Example("2022-04-28T14:20:04.000Z")
})
Attribute("duration", Int64, func() {
Description("Duration of the task in milliseconds.")
Example(123456789)
})
Attribute("result", String)
Attribute("error", String)
Attribute("outputs", TaskOutputs)
Required("id", "type", "url", "status", "isFinished", "createdAt")
Example(ExampleTask())
})
var TaskOutputs = Type("TaskOutputs", func() {
Description("Outputs generated by the task.")
Attribute("instanceId", InstanceID, "ID of the created/updated template instance.")
})
var GetTaskRequest = Type("GetTaskRequest", func() {
Attribute("taskId", TaskID)
Required("taskId")
})
// Error -------------------------------------------------------------------------------------------------------
var GenericErrorType = Type("GenericError", func() {
Description("Generic error")
Attribute("statusCode", Int, "HTTP status code.", func() {
Example(StatusInternalServerError)
})
ErrorName("error", String, "Name of error.", func() {
Meta("struct:field:name", "name")
Example("templates.internalError")
})
Attribute("message", String, "Error message.", func() {
Example("Internal Error")
})
Required("statusCode", "error", "message")
})
var ProjectLockedErrorType = Type("ProjectLockedError", func() {
Description("Project locked error")
Attribute("statusCode", Int, "HTTP status code.", func() {
Example(StatusServiceUnavailable)
})
ErrorName("error", String, "Name of error.", func() {
Meta("struct:field:name", "name")
Example("templates.internalError")
})
Attribute("message", String, "Error message.", func() {
Example("The project is locked, another operation is in progress, please try again later.")
})
Attribute("retryAfter", String, "Indicates how long the user agent should wait before making a follow-up request.", func() {
Example("<http-date>/<delay-seconds>")
Docs(func() {
URL("https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After")
})
})
Required("statusCode", "error", "message", "retryAfter")
})
func GenericError(statusCode int, name, description, example string) {
// Must be called inside HTTP definition
endpoint, ok := eval.Current().(*expr.HTTPEndpointExpr)
if !ok {
eval.IncompatibleDSL()
}
// Add error to the method definition
eval.Execute(func() {
Error(name, GenericErrorType, func() {
Description(description)
Example(ExampleError(statusCode, name, example))
})
}, endpoint.MethodExpr)
// Add response to the HTTP method definition
Response(name, statusCode)
}
// ProjectLockedError - 503, see https://stackoverflow.com/questions/37116097/http-statuscode-when-waiting-for-lock-release-takes-to-long
func ProjectLockedError() {
// Must be called inside HTTP definition
endpoint, ok := eval.Current().(*expr.HTTPEndpointExpr)
if !ok {
eval.IncompatibleDSL()
}
// Add error to the method definition
name := "templates.projectLocked"
eval.Execute(func() {
Error(name, ProjectLockedErrorType, func() {
Description("Access to branch metadata must be atomic, so only one write operation can run at a time. If this error occurs, the client should make retries, see Retry-After header.")
Example(ExampleError(StatusServiceUnavailable, name, "The project is locked, another operation is in progress, please try again later."))
})
}, endpoint.MethodExpr)
// Add response to the HTTP method definition
Response(name, StatusServiceUnavailable, func() {
Header("retryAfter:Retry-After", String, "Indicates how long the user agent should wait before making a follow-up request.", func() {
Example("<http-date>/<delay-seconds>")
Docs(func() {
URL("https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After")
})
})
})
}
func RepositoryNotFoundError() {
GenericError(StatusNotFound, "templates.repositoryNotFound", "Repository not found error.", `Repository "name" not found.`)
}
func TemplateNotFoundError() {
GenericError(StatusNotFound, "templates.templateNotFound", "Template not found error.", `Template "id" not found.`)
}
func VersionNotFoundError() {
GenericError(StatusNotFound, "templates.versionNotFound", "Version not found error.", `Version "v1.2.3" not found.`)
}
func BranchNotFoundError() {
GenericError(StatusNotFound, "templates.branchNotFound", "Branch not found error.", `Branch "123" not found.`)
}
func InstanceNotFoundError() {
GenericError(StatusNotFound, "templates.instanceNotFound", "Instance not found error.", `Instance "V1StGXR8IZ5jdHi6BAmyT" not found.`)
}
func TaskNotFoundError() {
GenericError(StatusNotFound, "templates.taskNotFound", "Task not found error.", `Task "001" not found.`)
}
// Common attributes----------------------------------------------------------------------------------------------------
var tokenSecurity = APIKeySecurity("storage-api-token", func() {
Description("Storage Api Token Authentication.")
})
var RepositoryRequest = Type("RepositoryRequest", func() {
Attribute("repository", String, func() {
Example("keboola")
Description("Name of the template repository. Use \"keboola\" for default Keboola repository.")
})
Required("repository")
})
var TemplateRequest = Type("TemplateRequest", func() {
Extend(RepositoryRequest)
Attribute("template", TemplateID)
Required("template")
})
var TemplateVersionRequest = Type("TemplateVersionRequest", func() {
Extend(TemplateRequest)
templateVersionAttr()
})
var BranchRequest = Type("BranchRequest", func() {
Attribute("branch", String, func() {
Example("default")
Description("ID of the branch. Use \"default\" for default branch.")
})
Required("branch")
})
var InstanceRequest = Type("InstanceRequest", func() {
Extend(BranchRequest)
Attribute("instanceId", InstanceID)
Required("instanceId")
})
var InputsPayload = Type("InputsPayload", func() {
Attribute("steps", ArrayOf(StepPayload), "Steps with input values filled in by user.", func() {
Example([]ExampleStepPayloadData{ExampleStepPayload()})
})
Required("steps")
})
var ValidateInputsRequest = Type("ValidateInputsRequest", func() {
Extend(TemplateVersionRequest)
Extend(InputsPayload)
})
var UseTemplateRequest = Type("UseTemplateRequest", func() {
Extend(BranchRequest)
Extend(TemplateVersionRequest)
Extend(InputsPayload)
Attribute("name", String, func() {
Example("My Instance")
Description("Name of the new template instance.")
})
Required("name")
})
var UpdateInstanceRequest = Type("UpdateInstanceRequest", func() {
Extend(InstanceRequest)
Attribute("name", String, "New name of the instance.", func() {
Example("My Great Instance")
})
Required("name")
})
var UpgradeInstanceRequest = Type("UpgradeInstanceRequest", func() {
Extend(InstanceRequest)
Extend(InputsPayload)
templateVersionAttr()
})
var InstanceInputsRequest = Type("InstanceInputsRequest", func() {
Extend(InstanceRequest)
templateVersionAttr()
})
func templateVersionAttr() {
Attribute("version", String, func() {
Example("v1.2.3")
Description(`Semantic version of the template. Use "default" for default version.`)
})
Required("version")
}
func iconAttr() {
Attribute("icon", String, "Icon for UI. Component icon if it starts with \"component:...\", or a common icon if it starts with \"common:...\".", func() {
MinLength(1)
MaxLength(40)
Example("common:download")
})
}
var StepPayload = Type("StepPayload", func() {
Description("Step with input values filled in by user.")
Attribute("id", String, "Unique ID of the step.", func() {
MinLength(1)
Example("g01-s01")
})
Attribute("inputs", ArrayOf(InputValue), "Input values.", func() {
Example([]ExampleInputPayloadData{ExampleInputPayload1(), ExampleInputPayload2()})
})
Required("id", "inputs")
})
var InputValue = Type("InputValue", func() {
Description("Input value filled in by user.")
Attribute("id", String, "Unique ID of the input.", func() {
MinLength(1)
Example("g01-s01")
})
Attribute("value", Any, "Input value filled in by user in the required type.", func() {
Example("foo bar")
})
Required("id", "value")
Example(ExampleInputPayload1())
})
// Types --------------------------------------------------------------------------------------------------------------
var ServiceDetail = Type("ServiceDetail", func() {
Description("Information about the service")
Attribute("api", String, "Name of the API", func() {
Example("templates")
})
Attribute("documentation", String, "URL of the API documentation.", func() {
Example("https://templates.keboola.com/v1/documentation")
})
Required("api", "documentation")
})
var Author = Type("Author", func() {
Description("Author of template or repository.")
Attribute("name", String, "Name of the author.", func() {
MinLength(1)
Example("Keboola")
})
Attribute("url", String, "Link to the author website.", func() {
MinLength(1)
Example("https://www.keboola.com")
})
Required("name", "url")
})
var Repositories = Type("Repositories", func() {
Description("List of the repositories.")
Attribute("repositories", ArrayOf(Repository), "All template repositories defined in the project.", func() {
Example([]ExampleRepositoryData{ExampleRepository()})
})
Required("repositories")
})
var Repository = Type("Repository", func() {
Description("Template repository.")
Attribute("name", String, func() {
MinLength(1)
MaxLength(40)
Example("keboola")
Description("Template repository name. Use \"keboola\" for default Keboola repository.")
})
Attribute("url", String, "Git URL to the repository.", func() {
MinLength(1)
Example("https://github.com/keboola/keboola-as-code-templates")
})
Attribute("ref", String, "Git branch or tag.", func() {
MinLength(1)
Example("main")
})
Attribute("author", Author, func() {
Example(ExampleAuthor())
})
Required("name", "url", "ref", "author")
Example(ExampleRepository())
})
var Templates = Type("Templates", func() {
Description("List of the templates.")
Attribute("repository", Repository, "Information about the repository.")
Attribute("templates", ArrayOf(Template), "All template defined in the repository.")
Required("repository", "templates")
Example(ExampleTemplatesData{
Repository: ExampleRepository(),
Templates: []ExampleTemplateData{ExampleTemplate1(), ExampleTemplate2()},
})
})
var TemplateDetail = Type("TemplateDetail", func() {
Reference(Template)
Attribute("id")
Attribute("name")
Attribute("deprecated")
Attribute("author")
Attribute("description")
Attribute("defaultVersion")
Attribute("repository", Repository, "Information about the repository.")
Attribute("categories")
Attribute("components")
Attribute("versions", ArrayOf(TemplateVersion), "All available versions of the template.", func() {
Example(ExampleVersions1())
})
Required("id", "name", "deprecated", "author", "description", "defaultVersion", "repository", "categories", "components", "versions")
Example(ExampleTemplateDetailData{
ExampleTemplateData: ExampleTemplate1(),
Repository: ExampleRepository(),
})
})
var TemplateID = Type("templateId", String, func() {
Meta("struct:field:type", "= string")
MinLength(1)
MaxLength(40)
Example("my-template")
Description("ID of the template.")
})
var TemplateBase = Type("TemplateBase", func() {
Description("Template base information.")
Attribute("id", TemplateID)
Attribute("name", String, "Template name.", func() {
MinLength(1)
MaxLength(40)
Example("My Template")
})
Attribute("deprecated", Boolean, "Deprecated template cannot be used.")
Attribute("author", Author, func() {
Example(ExampleAuthor())
})
Attribute("description", String, "Short description of the template.", func() {
MinLength(1)
MaxLength(200)
Example("Full workflow to load all user accounts from the Service.")
})
Attribute("defaultVersion", String, "Recommended version of the template.", func() {
MinLength(1)
MaxLength(20)
Example("v1.2.3")
})
Required("id", "name", "deprecated", "author", "description", "defaultVersion")
})
var Template = Type("Template", func() {
Reference(TemplateBase)
Description("Template.")
Attribute("id")
Attribute("name")
Attribute("deprecated")
Attribute("author")
Attribute("description")
Attribute("defaultVersion")
Attribute("categories", ArrayOf(String), "List of categories the template belongs to.", func() {
Example([]string{"E-commerce", "Other", "Social Media"})
})
Attribute("components", ArrayOf(String), "List of components used in the template.", func() {
Example([]string{"ex-generic-v2", "keboola.snowflake-transformation"})
})
Attribute("versions", ArrayOf(TemplateVersion), "All available versions of the template.", func() {
Example(ExampleVersions1())
})
Required("id", "name", "deprecated", "author", "description", "defaultVersion", "categories", "components", "versions")
})
var TemplateVersion = Type("Version", func() {
Description("Template version.")
Attribute("version", String, "Semantic version.", func() {
MinLength(1)
MaxLength(20)
Example("v1.2.3")
})
Attribute("stable", Boolean, "If true, then the version is ready for production use.", func() {
Example(true)
})
Attribute("description", String, "Optional short description of the version. Can be empty.", func() {
MinLength(0)
MaxLength(40)
Example("Experimental support for new API.")
})
Required("version", "stable", "description")
Example(ExampleVersion1())
})
var VersionDetail = Type("VersionDetail", func() {
Reference(TemplateVersion)
Attribute("version")
Attribute("stable")
Attribute("description")
Attribute("components", ArrayOf(String), "List of components used in the template version.", func() {
Example([]string{"ex-generic-v2", "keboola.snowflake-transformation"})
})
Attribute("longDescription", String, "Extended description of the template in Markdown format.", func() {
MinLength(1)
Example("**Full workflow** to load all user accounts from [the Service](https://service.com). With *extended* explanation ...")
})
Attribute("readme", String, "Readme of the template version in Markdown format.", func() {
MinLength(1)
Example("Lorem markdownum quod discenda [aegide lapidem](http://www.nequeuntoffensa.io/)")
})
Required("version", "stable", "description", "components", "longDescription", "readme")
Example(ExampleVersionDetail())
})
var VersionDetailExtended = Type("VersionDetailExtended", func() {
Reference(VersionDetail)
Attribute("version")
Attribute("stable")
Attribute("description")
Attribute("components")
Attribute("longDescription")
Attribute("readme")
Attribute("repository", Repository, "Information about the repository.")
Attribute("template", Template, "Information about the template.")
Required("version", "stable", "description", "components", "longDescription", "readme", "repository", "template")
Example(ExampleVersionDetailExtendedData{
ExampleVersionDetailData: ExampleVersionDetail(),
Repository: ExampleRepository(),
Template: ExampleTemplateBase(),
})
})
var ValidationError = Type("ValidationError", func() {
ErrorName("error", String, "Name of error.", func() {
Meta("struct:field:name", "name")
Example("InvalidPayload")
})
Attribute("message", String, "Error message.", func() {
Example("Inputs are not valid.")
})
Attribute("ValidationResult", ValidationResult)
Required("error", "message", "ValidationResult")
})
var ValidationResult = Type("ValidationResult", func() {
Description("Detail of the inputs validation.")
Attribute("valid", Boolean, "True if all groups and inputs are valid.")
Attribute("stepGroups", ArrayOf(StepGroupValidationResult), "List of Details for the step groups.")
Required("valid", "stepGroups")
Example(ExampleValidationResult())
})
var StepGroupValidationResult = Type("StepGroupValidationResult", func() {
Description("Validation Detail of the step group.")
Attribute("id", String, "Step group ID.", func() {
Example("g01")
})
Attribute("valid", Boolean, "True if the required number of steps is configured and all inputs are valid.", func() {
Example(false)
})
Attribute("error", String, "Are all inputs valid?", func() {
Example("All steps must be configured.")
})
Attribute("steps", ArrayOf(StepValidationResult), "List of Details for the steps.")
Required("id", "valid", "steps")
})
var StepValidationResult = Type("StepValidationResult", func() {
Description("Validation Detail of the step.")
Attribute("id", String, "Step ID.", func() {
Example("g01-s01")
})
Attribute("configured", Boolean, "True if the step was part of the sent payload.")
Attribute("valid", Boolean, "True if all inputs in the step are valid.")
Attribute("inputs", ArrayOf(InputValidationResult), "List of Details for the inputs.")
Required("id", "configured", "valid", "inputs")
})
var InputValidationResult = Type("InputValidationResult", func() {
Description("Validation Detail of the input.")
Attribute("id", String, "Input ID.", func() {
Example("api-token")
})
Attribute("visible", Boolean, "If false, the input should be hidden to user.", func() {
Example(true)
})
Attribute("error", String, "Error message.", func() {
Example("API token cannot be empty.")
})
Required("id", "visible")
})
var Inputs = Type("Inputs", func() {
Description("List of the inputs divided to step groups and steps.")
Attribute("stepGroups", ArrayOf(StepGroup), "List of the step groups.", func() {
MinLength(1)
Example(ExampleStepGroups())
})
Attribute("initialState", ValidationResult, "Initial state - same structure as the validation result.", func() {
Example(ExampleValidationResult())
})
Required("stepGroups", "initialState")
})
var StepGroup = Type("stepGroup", func() {
Description("Step group is a container for steps.")
Attribute("id", String, "Unique ID of the step group.", func() {
Example("g01")
})
Attribute("description", String, "Description of the step group, a tooltip explaining what needs to be configured.", func() {
MinLength(1)
MaxLength(80)
Example("Choose one of the eshop platforms.")
})
Attribute("required", String, "The number of steps that must be configured.", func() {
Enum("all", "atLeastOne", "exactlyOne", "zeroOrOne", "optional")
Example("atLeastOne")
})
Attribute("steps", ArrayOf(Step), "Steps in the group.", func() {
MinLength(1)
Example([]ExampleStepData{ExampleStep1()})
})
Required("id", "description", "required", "steps")
})
var Step = Type("step", func() {
Description("Step is a container for inputs.")
Attribute("id", String, "Unique ID of the step.", func() {
MinLength(1)
Example("g01-s01")
})
iconAttr()
Attribute("name", String, "Name of the step.", func() {
MinLength(1)
MaxLength(25)
Example("Super Ecommerce")
})
Attribute("description", String, "Description of the step.", func() {
MinLength(1)
MaxLength(60)
Example("Sell online with the Super E-commerce website.")
})
Attribute("dialogName", String, "Name of the dialog with inputs.", func() {
MinLength(1)
MaxLength(25)
Example("Super Ecommerce")
})
Attribute("dialogDescription", String, "Description of the dialog with inputs.", func() {
MinLength(1)
MaxLength(200)
Example("Please configure the connection to your Super Ecommerce account.")
})
Attribute("inputs", ArrayOf(Input), "Inputs in the step.", func() {
MinLength(0)
Example(ExampleInputs())
})
Required("id", "icon", "name", "description", "dialogName", "dialogDescription", "inputs")
})
var Input = Type("input", func() {
Description("User input.")