github.com/argoproj/argo-cd@v1.8.7/server/gpgkey/gpgkey.proto (about)

     1  syntax = "proto3";
     2  option go_package = "github.com/argoproj/argo-cd/pkg/apiclient/gpgkey";
     3  
     4  // GPG public key service
     5  //
     6  // GPG public key API performs CRUD actions against GnuPGPublicKey resources
     7  package gpgkey;
     8  
     9  import "gogoproto/gogo.proto";
    10  import "google/api/annotations.proto";
    11  import "github.com/argoproj/argo-cd/pkg/apis/application/v1alpha1/generated.proto";
    12  
    13  // Message to query the server for configured GPG public keys
    14  message GnuPGPublicKeyQuery {
    15    // The GPG key ID to query for
    16    string keyID = 1;
    17  }
    18  
    19  // Request to create one or more public keys on the server
    20  message GnuPGPublicKeyCreateRequest {
    21    // Raw key data of the GPG key(s) to create
    22    github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.GnuPGPublicKey publickey = 1;
    23    // Whether to upsert already existing public keys
    24    bool upsert = 2;
    25  }
    26  
    27  // Response to a public key creation request
    28  message GnuPGPublicKeyCreateResponse {
    29    // List of GPG public keys that have been created
    30    github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.GnuPGPublicKeyList created = 1;
    31    // List of key IDs that haven been skipped because they already exist on the server
    32    repeated string skipped = 2;
    33  }
    34  
    35  // Generic (empty) response for GPG public key CRUD requests
    36  message GnuPGPublicKeyResponse {}
    37  
    38  // GPGKeyService implements API for managing GPG public keys on the server
    39  service GPGKeyService {
    40    // List all available repository certificates
    41    rpc List(GnuPGPublicKeyQuery) returns (github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.GnuPGPublicKeyList) {
    42      option (google.api.http).get = "/api/v1/gpgkeys";
    43    }
    44  
    45    // Get information about specified GPG public key from the server
    46    rpc Get(GnuPGPublicKeyQuery) returns (github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.GnuPGPublicKey) {
    47      option (google.api.http).get = "/api/v1/gpgkeys/{keyID}";
    48    }
    49  
    50    // Create one or more GPG public keys in the server's configuration
    51    rpc Create(GnuPGPublicKeyCreateRequest) returns (GnuPGPublicKeyCreateResponse) {
    52      option (google.api.http) = {
    53        post: "/api/v1/gpgkeys"
    54        body: "publickey"
    55      };
    56    }
    57  
    58    // Delete specified GPG public key from the server's configuration
    59    rpc Delete(GnuPGPublicKeyQuery) returns (GnuPGPublicKeyResponse) {
    60      option (google.api.http).delete = "/api/v1/gpgkeys";
    61    }
    62  }