csolution-rpc/api/csolution-openapi.yml at ef480da25854c1c1f93f20e6ea7457c53aba1384 · Open-CMSIS-Pack/csolution-rpc · GitHub

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.1.0
info:
  title: csolution rpc
  version: 0.0.4
  description: Specification of remote procedure call methods for CMSIS csolution integration
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://localhost:3000

paths:
  /rpc/GetVersion:
    post:
      summary: Get version
      description: Get version of csolution rpc server
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetVersionRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetVersionResponse'}}}
  /rpc/Shutdown:
    post:
      summary: Shutdown
      description: Shutdown csolution rpc server
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/ShutdownRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/ShutdownResponse'}}}
  /rpc/Apply:
    post:
      summary: Apply component selection changes
      description: Apply component selection changes for the given context
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/ApplyRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/ApplyResponse'}}}
  /rpc/Resolve:
    post:
      summary: Resolve trivial component dependencies
      description: Resolve trivial component dependencies for the given context
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/ResolveRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/ResolveResponse'}}}
  /rpc/LoadPacks:
    post:
      summary: Load installed and local packs
      description: Load packs indexed in the CMSIS_PACK_ROOT
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/LoadPacksRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/LoadPacksResponse'}}}
  /rpc/LoadSolution:
    post:
      summary: Load solution
      description: Load solution
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/LoadSolutionRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/LoadSolutionResponse'}}}
  /rpc/GetUsedItems:
    post:
      summary: Get used items
      description: Get used items
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetUsedItemsRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetUsedItemsResponse'}}}
  /rpc/GetPacksInfo:
    post:
      summary: Get packs information
      description: Get installed and local packs information
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetPacksInfoRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetPacksInfoResponse'}}}
  /rpc/GetDeviceList:
    post:
      summary: Get device list
      description: Get list of filtered devices
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetDeviceListRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetDeviceListResponse'}}}
  /rpc/GetDeviceInfo:
    post:
      summary: Get device data for specified device
      description: Get device data for specified device
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetDeviceInfoRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetDeviceInfoResponse'}}}
  /rpc/GetBoardList:
    post:
      summary: Get board list
      description: Get list of filtered boards
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetBoardListRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetBoardListResponse'}}}
  /rpc/GetBoardInfo:
    post:
      summary: Get data for specified board
      description: Get data for specified board
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetBoardInfoRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetBoardInfoResponse'}}}
  /rpc/GetComponentsTree:
    post:
      summary: Get components tree
      description: Get tree of filtered components, APIs, bundles and taxonomy information
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetComponentsTreeRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetComponentsTreeResponse'}}}
  /rpc/SelectComponent:
    post:
      summary: Select component
      description: Select component
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/SelectComponentRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/SelectComponentResponse'}}}
  /rpc/SelectVariant:
    post:
      summary: Select variant
      description: Select variant
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/SelectVariantRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/SelectVariantResponse'}}}
  /rpc/SelectBundle:
    post:
      summary: Select bundle
      description: Select bundle
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/SelectBundleRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/SelectBundleResponse'}}}
  /rpc/ValidateComponents:
    post:
      summary: Validate components list
      description: Validate components list
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/ValidateComponentsRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/ValidateComponentsResponse'}}}
  /rpc/GetLogMessages:
    post:
      summary: Get logged messages
      description: Get info, errors and warnings logged during processing
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetLogMessagesRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetLogMessagesResponse'}}}
  /rpc/GetDraftProjects:
    post:
      summary: Get draft projects
      description: Get reference applications, examples and solution templates
      tags: [/rpc]
      requestBody:
        content: {application/json: {schema: {$ref: '#/components/schemas/GetDraftProjectsRequest'}}}
      responses:
        '200':
          description: OK
          content: {application/json: {schema: {$ref: '#/components/schemas/GetDraftProjectsResponse'}}}

components:
  schemas:
    SuccessResult:
      type: object
      properties:
        success:
          type: boolean
          description: true if requested operation has been performed successfully or selection has been modified
        message:
          type: string
          description: optional error/warning/info message
      required:
        - success
    Common:
      type: object
      properties:
        id:
          type: string
          description: Identifier
        description:
          type: string
          description: Description
        doc:
          type: string
          description: Documentation
      required:
        - id
    PackElement:
      allOf:
        - $ref: '#/components/schemas/Common'
        - properties:
            pack:
              type: string
              description: Originating pack ID
    Pack:
      allOf:
        - $ref: '#/components/schemas/Common'
        - properties:
            overview:
              type: string
              description: Pack overview
            used:
              type: boolean
              description: True when pack is used in the current context
            references:
              type: array
              description: List of yml files where the pack is referenced
              items:
                type: string
    PacksInfo:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            packs:
              type: array
              description: List of packs information
              items:
                $ref: '#/components/schemas/Pack'
          required:
            - packs
    DebugInterface:
      type: object
      properties:
        adapter:
          type: string
          description: Debug adapter type
        connector:
          type: string
          description: Connector type
      required:
        - adapter
    Processor:
      type: object
      properties:
        name:
          type: string
          description: Processor name within device, optional
        core:
          type: string
          description: Processor core type
        attributes:
          type: object
          additionalProperties:
            type: string
      required:
        - core
    Memory:
      type: object
      properties:
        name:
          type: string
          description: Memory name/ID
        size:
          type: string
          description: Memory size
        access:
          type: string
          description: Memory access permissions
      required:
        - core
    Device:
      allOf:
        - $ref: '#/components/schemas/PackElement'
        - properties:
            family:
              type: string
              description: Device family
            subFamily:
              type: string
              description: Device subfamily, optional
            processors:
              type: array
              items:
                $ref: '#/components/schemas/Processor'
            memories:
              type: array
              items:
                $ref: '#/components/schemas/Memory'
    DeviceList:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            devices:
              type: array
              description: List of devices
              items:
                $ref: '#/components/schemas/Device'
          required:
            - devices
    DeviceInfo:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            device:
              $ref: '#/components/schemas/Device'
          required:
            - device
    Board:
      allOf:
        - $ref: '#/components/schemas/PackElement'
        - properties:
            image:
              type: string
              description: Link to file or URL with board image
            devices:
              type: array
              description: List of mounted and compatible devices
              items:
                $ref: '#/components/schemas/Device'
            memories:
              type: array
              items:
                $ref: '#/components/schemas/Memory'
            debugInterfaces:
              type: array
              description: List of supported debug interfaces
              items:
                $ref: '#/components/schemas/DebugInterface'

    BoardList:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            boards:
              type: array
              description: List of boards
              items:
                $ref: '#/components/schemas/Board'
          required:
            - boards
    BoardInfo:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            board:
              $ref: '#/components/schemas/Board'
          required:
            - board
    Component:
      allOf:
        - $ref: '#/components/schemas/Common'
        - properties:
            pack:
              type: string
              description: Pack that defines this component
            implements:
              type: string
              description: Refers to the API that the component is based on
            maxInstances:
              type: integer
              description: Maximum of supported component instances
          required:
            - pack
    Options:
      type: object
      properties:
        layer:
          type: string
          description: Absolute path to .clayer.yml file
        explicitVersion:
          type: string
          description: 'Version requirement in SemVer syntax: https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#name-conventions empty '
        explicitVendor:
          type: boolean
          description: Flag to prefix component ID with vendor when adding component to project or layer, false
    ComponentInstance:
      type: object
      properties:
        id:
          type: string
          description: Identifier
        selectedCount:
          type: integer
          description: Number of selected instances
        generator:
          type: string
          description: Associated generator name
        fixed:
          type: boolean
          description: Component cannot be unselected
        options:
          $ref: '#/components/schemas/Options'
        resolvedComponent:
          $ref: '#/components/schemas/Component'
      required:
        - id
        - selectedCount
    CtItem:
      type: object
      properties:
        name:
          type: string
          description: Name of element
        result:
          type: string
          description: 'Condition result: https://github.com/Open-CMSIS-Pack/devtools/blob/tools/projmgr/2.8.0/libs/rtemodel/include/RteItem.h#L78-L95'
      required:
        - name
    CtVariant:
      allOf:
        - $ref: '#/components/schemas/CtItem'
        - type: object
          properties:
            components:
              type: array
              description: Version-sorted components
              items:
                $ref: '#/components/schemas/Component'
          required:
            - components
    CtAggregate:
      allOf:
        - $ref: '#/components/schemas/CtItem'
        - type: object
          properties:
            id:
              type: string
              description: Identifier
            activeVariant:
              type: string
              description: Variant
            activeVersion:
              type: string
              description: Version
            selectedCount:
              type: integer
              description: Number of selected instances
            generator:
              type: string
              description: Associated generator name
            fixed:
              type: boolean
              description: Component cannot be unselected
            variants:
              type: array
              items:
                $ref: '#/components/schemas/CtVariant'
            options:
              $ref: '#/components/schemas/Options'
          required:
            - id
            - variants
    CtTreeItem:
      allOf:
        - $ref: '#/components/schemas/CtItem'
        - type: object
          properties:
            cgroups:
              type: array
              items:
                $ref: '#/components/schemas/CtGroup'
            aggregates:
              type: array
              items:
                $ref: '#/components/schemas/CtAggregate'
    Api:
      description: Api
      allOf:
        - $ref: '#/components/schemas/Common'
    Taxonomy:
      description: Taxonomy
      allOf:
        - $ref: '#/components/schemas/Common'
    CtGroup:
      allOf:
        - $ref: '#/components/schemas/CtTreeItem'
        - type: object
          properties:
            api:
              $ref: '#/components/schemas/Api'
            taxonomy:
              $ref: '#/components/schemas/Taxonomy'
    Bundle:
      description: Bundle
      allOf:
        - $ref: '#/components/schemas/Common'
    CtBundle:
      allOf:
        - $ref: '#/components/schemas/CtTreeItem'
        - type: object
          properties:
            bundle:
              $ref: '#/components/schemas/Bundle'
    CtClass:
      allOf:
        - $ref: '#/components/schemas/CtItem'
        - type: object
          properties:
            taxonomy:
              $ref: '#/components/schemas/Taxonomy'
            activeBundle:
              type: string
            bundles:
              type: array
              items:
                $ref: '#/components/schemas/CtBundle'
          required:
            - bundles
    CtRoot:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            classes:
              type: array
              description: Array of Component Classes
              items:
                $ref: '#/components/schemas/CtClass'
          required:
            - classes
    Condition:
      type: object
      properties:
        expression:
          type: string
          description: Condition expression (accept, require, deny ...)
        aggregates:
          type: array
          description: List of aggregates related to this condition
          items:
            type: string
      required:
        - expression
    Result:
      type: object
      properties:
        result:
          type: string
          description: 'Condition result: https://github.com/Open-CMSIS-Pack/devtools/blob/tools/projmgr/2.8.0/libs/rtemodel/include/RteItem.h#L78-L95'
        id:
          type: string
          description: Component or API identifier
        aggregates:
          type: array
          description: List of aggregates related to this result
          items:
            type: string
        conditions:
          type: array
          description: List of conditions related to this result
          items:
            $ref: '#/components/schemas/Condition'
      required:
        - id
        - result
    Results:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            result:
              type: string
              description: 'Condition result: https://github.com/Open-CMSIS-Pack/devtools/blob/tools/projmgr/2.8.0/libs/rtemodel/include/RteItem.h#L78-L95'
            validation:
              type: array
              items:
                $ref: '#/components/schemas/Result'
          required:
            - result
    UsedItems:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            components:
              type: array
              items:
                $ref: '#/components/schemas/ComponentInstance'
            packs:
              type: array
              items:
                $ref: '#/components/schemas/Pack'
          required:
            - components
            - packs
    LogMessages:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            info:
              type: array
              items:
                type: string
            errors:
              type: array
              items:
                type: string
            warnings:
              type: array
              items:
                type: string

    DraftProjectsFilter:
      type: object
      properties:
        board:
          type: string
          description: Board Identifier
        device:
          type: string
          description: Device Identifier
        environments:
          type: array
          items:
            type: string
          description: Environment names
    ExampleEnvironment:
      type: object
      properties:
        name:
          type: string
          description: Name of the environment
        file:
          type: string
          description: Project file to be loaded
        folder:
          type: string
          description: Folder containing all example files
      required:
        - name
        - file
        - folder
    ExampleProject:
      type: object
      properties:
        name:
          type: string
          description: Name of the example
        description:
          type: string
          description: Brief description
        doc:
          type: string
          description: Document that describes the example
        version:
          type: string
          description: Example version number
        archive:
          type: string
          description: Archive file containing all files and sub-folders
        pack:
          type: string
          description: Pack identifier
        environments:
          type: array
          items:
            $ref: '#/components/schemas/ExampleEnvironment'
          description: List of environments
        components:
          type: array
          items:
            type: string
          description: List of related components
        categories:
          type: array
          items:
            type: string
          description: List of categories
        keywords:
          type: array
          items:
            type: string
          description: List of keywords
      required:
        - name
        - description
        - doc
        - environments
        - pack
    SolutionTemplate:
      type: object
      properties:
        name:
          type: string
          description: Name of the template
        description:
          type: string
          description: Brief description
        file:
          type: string
          description: Name of the *.csolution.yml file
        folder:
          type: string
          description: Folder containing the template
        copyTo:
          type: string
          description: Path to copy the template into the csolution project
        pack:
          type: string
          description: Pack identifier
      required:
        - name
        - description
        - file
        - folder
        - pack
    DraftProjectsInfo:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            examples:
              type: array
              items:
                $ref: '#/components/schemas/ExampleProject'
            refApps:
              type: array
              items:
                $ref: '#/components/schemas/ExampleProject'
            templates:
              type: array
              items:
                $ref: '#/components/schemas/SolutionTemplate'

    GetVersionRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request'
        - properties:
            method:
              type: string
              const: GetVersion
    GetVersionResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
        - properties:
            version:
              type: string
              description: Tool version
            apiVersion:
              type: string
              description: API version
    GetVersionResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/GetVersionResult'
    ShutdownRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request'
        - properties:
            method:
              type: string
              const: Shutdown
    ShutdownResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/SuccessResult'
    ApplyRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: Apply
            params:
              type: object
              properties:
                context:
                  type: string
              required:
                - context
    ApplyResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/SuccessResult'
    ResolveRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: Resolve
            params:
              type: object
              properties:
                context:
                  type: string
              required:
                - context
    ResolveResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/SuccessResult'
    LoadPacksRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request'
        - properties:
            method:
              type: string
              const: LoadPacks
    LoadPacksResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/SuccessResult'
    LoadSolutionRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: LoadSolution
            params:
              type: object
              properties:
                solution:
                  type: string
              required:
                - solution
    LoadSolutionResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/SuccessResult'
    GetPacksInfoRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetPacksInfo
            params:
              type: object
              properties:
                context:
                  type: string
              required:
                - context
    GetPacksInfoResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/PacksInfo'
    GetUsedItemsRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetUsedItems
            params:
              type: object
              properties:
                context:
                  type: string
              required:
                - context
    GetUsedItemsResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/UsedItems'
    GetDeviceListRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetDeviceList
            params:
              type: object
              properties:
                context:
                  type: string
                  description: Optional context to limit the list to packs used in the context
                namePattern:
                  type: string
                  description: Optional device name pattern containing wildcards
                vendor:
                  type: string
                  description: Optional vendor name to limit device list to the requested vendor
    GetDeviceListResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/DeviceList'
    GetDeviceInfoRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetDeviceInfo
            params:
              type: object
              properties:
                id:
                  type: string
                  description: Device ID in the format Vendor::Name, vendor prefix is optional
              required:
                - id
    GetDeviceInfoResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/DeviceInfo'
    GetBoardListRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetBoardList
            params:
              type: object
              properties:
                context:
                  type: string
                  description: Optional context to limit the list to packs used in the context
                namePattern:
                  type: string
                  description: Optional device name pattern containing wildcards
                vendor:
                  type: string
                  description: Optional vendor name to limit device list to the requested vendor
    GetBoardListResponse:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-response'
        - properties:
            result:
              $ref: '#/components/schemas/BoardList'
    GetBoardInfoRequest:
      allOf:
        - $ref: '#/x-jsonrpc-envelope-request-with-params'
        - properties:
            method:
              type: string
              const: GetBoardInfo
            params: