github.com/cloudwan/edgelq-sdk@v1.15.4/alerting/proto/v1/document.proto (about)

     1  syntax = "proto3";
     2  
     3  package ntt.alerting.v1;
     4  
     5  import "google/api/resource.proto";
     6  import "goten-sdk/types/meta.proto";
     7  
     8  option go_package = "github.com/cloudwan/edgelq-sdk/alerting/resources/v1/document;document";
     9  option java_multiple_files = true;
    10  option java_outer_classname = "DocumentProto";
    11  option java_package = "com.ntt.alerting.pb.v1";
    12  
    13  // Document can be attached to Policy, TsCondition or LogCondition
    14  // resources. They should contain documentation that can be relevant when
    15  // diagnosing & resolving alerts.
    16  // They are especially important for AI Agent handling.
    17  message Document {
    18    option (google.api.resource) = {
    19      type : "alerting.edgelq.com/Document"
    20      pattern : "projects/{project}/documents/{document}"
    21    };
    22  
    23    // Name of Document
    24    // When creating a new instance, this field is optional and if not provided,
    25    // it will be generated automatically. Last ID segment must conform to the
    26    // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
    27    string name = 1;
    28  
    29    // Metadata is an object with information like create, update and delete time
    30    // (for async deleted resources), has user labels/annotations, sharding
    31    // information, multi-region syncing information and may have non-schema
    32    // owners (useful for taking ownership of resources belonging to lower level
    33    // services by higher ones).
    34    goten.types.Meta metadata = 2;
    35  
    36    // Document title
    37    string title = 3;
    38  
    39    // Documentation content for operators
    40    string content = 4;
    41  
    42    // documentation mime type. Only `"text/markdown"` is supported.
    43    string mime_type = 5;
    44  }