components/model-catalog/proto-definition/proto/BluePrintManagement.proto

   1 syntax = "proto3";
   2 import "google/protobuf/struct.proto";
   3 import "BluePrintCommon.proto";
   4 option java_multiple_files = true;
   5 package org.onap.ccsdk.cds.controllerblueprints.management.api;
   6
   7 message BluePrintUploadInput {
   8     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
   9     FileChunk fileChunk = 2;
  10     org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 3;
  11     // Extra optional dynamic properties used during upload.
  12     google.protobuf.Struct properties = 4;
  13 }
  14
  15 message BluePrintDownloadInput {
  16     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
  17     org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 2;
  18     // Extra optional dynamic properties used to download.
  19     google.protobuf.Struct properties = 3;
  20 }
  21
  22 message BluePrintRemoveInput {
  23     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
  24     org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers actionIdentifiers = 2;
  25     // Extra optional dynamic properties used to remove.
  26     google.protobuf.Struct properties = 3;
  27 }
  28
  29 message BluePrintBootstrapInput {
  30     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
  31     bool loadCBA = 2;
  32     bool loadModelType = 3;
  33     bool loadResourceDictionary = 4;
  34 }
  35
  36 message BluePrintManagementOutput {
  37     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
  38     // Optional file chunk sent back to the client for Enrich and Download this is mandatory.
  39     FileChunk fileChunk = 2;
  40     org.onap.ccsdk.cds.controllerblueprints.common.api.Status status = 3;
  41     // Extra optional dynamic properties.
  42     google.protobuf.Struct properties = 4;
  43 }
  44
  45 // Get the list of workflows available for a given blueprintName/Version
  46 message BluePrintGetWorkflowsInput {
  47     org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader commonHeader = 1;
  48     string blueprintName = 2;
  49     string blueprintVersion = 3;
  50 }
  51
  52 message FileChunk {
  53     bytes chunk = 1;
  54 }
  55 // Values used in BluePrintDownloadInput/actionIdentifiers/action
  56 enum DownloadAction {
  57     // Default is SEARCH the cba and download the cba
  58     SEARCH = 0;
  59     // Download the starter cba with corresponding property options
  60     STARTER = 1;
  61     // clone cba with corresponding property options
  62     CLONE = 2;
  63 }
  64
  65 enum UploadAction {
  66     // Default is DRAFT
  67     DRAFT = 0;
  68     ENRICH = 1;
  69     VALIDATE = 2;
  70     PUBLISH = 3;
  71 }
  72
  73 enum RemoveAction {
  74     // Delete CBA from database, deploy path and clean cache.
  75     DEFAULT = 0;
  76 }
  77
  78 service BluePrintManagementService {
  79     rpc downloadBlueprint (BluePrintDownloadInput) returns (BluePrintManagementOutput);
  80     rpc uploadBlueprint (BluePrintUploadInput) returns (BluePrintManagementOutput);
  81     rpc removeBlueprint (BluePrintRemoveInput) returns (BluePrintManagementOutput);
  82     rpc bootstrapBlueprint (BluePrintBootstrapInput) returns (BluePrintManagementOutput);
  83     rpc getWorkflows(BluePrintGetWorkflowsInput) returns (BluePrintManagementOutput);
  84 }