summaryrefslogtreecommitdiffstats
path: root/components/model-catalog/proto-definition/proto/BluePrintManagement.proto
blob: ee8bd25400c52033b0b6980b1d491a2f44cab2be (plain)
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
syntax = "proto3";
import "google/protobuf/struct.proto";
import "BluePrintCommon.proto";
option java_multiple_files = true;
package org.onap.ccsdk.cds.controllerblueprints.management.api;

message BluePrintUploadInput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    FileChunk fileChunk = 2;
    org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 3;
    // Extra optional dynamic properties used during upload.
    google.protobuf.Struct properties = 4;
}

message BluePrintDownloadInput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 2;
    // Extra optional dynamic properties used to download.
    google.protobuf.Struct properties = 3;
}

message BluePrintRemoveInput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 2;
    // Extra optional dynamic properties used to remove.
    google.protobuf.Struct properties = 3;
}

message BluePrintBootstrapInput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    bool loadCBA = 2;
    bool loadModelType = 3;
    bool loadResourceDictionary = 4;
}

message BluePrintManagementOutput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    // Optional file chunk sent back to the client for Enrich and Download this is mandatory.
    FileChunk fileChunk = 2;
    org.onap.ccsdk.cds.controllerblueprints.common.api.Status status = 3;
    // Extra optional dynamic properties.
    google.protobuf.Struct properties = 4;
}

// Get the list of workflows available for a given blueprintName/Version
message BluePrintGetWorkflowsInput {
    org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
    string blueprintName = 2;
    string blueprintVersion = 3;
}

message FileChunk {
    bytes chunk = 1;
}
// Values used in BluePrintDownloadInput/actionIdentifiers/action
enum DownloadAction {
    // Default is SEARCH the cba and download the cba
    SEARCH = 0;
    // Download the starter cba with corresponding property options
    STARTER = 1;
    // clone cba with corresponding property options
    CLONE = 2;
}

enum UploadAction {
    // Default is DRAFT
    DRAFT = 0;
    ENRICH = 1;
    VALIDATE = 2;
    PUBLISH = 3;
}

enum RemoveAction {
    // Delete CBA from database, deploy path and clean cache.
    DEFAULT = 0;
}

service BluePrintManagementService {
    rpc downloadBlueprint (BluePrintDownloadInput) returns (BluePrintManagementOutput);
    rpc uploadBlueprint (BluePrintUploadInput) returns (BluePrintManagementOutput);
    rpc removeBlueprint (BluePrintRemoveInput) returns (BluePrintManagementOutput);
    rpc bootstrapBlueprint (BluePrintBootstrapInput) returns (BluePrintManagementOutput);
    rpc getWorkflows(BluePrintGetWorkflowsInput) returns (BluePrintManagementOutput);
}