github.com/argoproj/argo-cd/v2@v2.10.9/server/gpgkey/gpgkey.proto (about)

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