Files
Abhijit Mukherjeeandniravparikh05 6b8cc3163d docs: added api keys as headers for all grpc messages (#163)
* added api keys as headers for all grpc messages

Signed-off-by: mabhi <abhijit.mukherjee@infracloud.io>

* changes to have multiple api keys for auth in partner swagger docs

Signed-off-by: niravparikh05 <nir.parikh05@gmail.com>

---------

Signed-off-by: mabhi <abhijit.mukherjee@infracloud.io>
Signed-off-by: niravparikh05 <nir.parikh05@gmail.com>
Co-authored-by: niravparikh05 <nir.parikh05@gmail.com>
2023-03-30 15:20:58 +05:30

121 lines
2.9 KiB
Protocol Buffer

syntax = "proto3";
package paralus.dev.rpc.system.v3;
import "google/api/annotations.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
import "proto/types/systempb/v3/partner.proto";
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
info: {
title: "Partner Service"
version: "3.0"
contact: { name: "Paralus Dev" }
}
schemes: HTTPS
consumes: "application/json"
consumes: "application/yaml"
produces: "application/json"
produces: "application/yaml"
security_definitions : {
security : {
key : "BasicAuth"
value : {type : TYPE_BASIC}
}
security : {
key : "ApiKeyAuth"
value : {type : TYPE_API_KEY in : IN_HEADER name : "X-API-KEYID"}
}
security : {
key : "ApiTokenAuth"
value : {
type : TYPE_API_KEY in : IN_HEADER name : "X-API-TOKEN"
}
}
}
security : {
security_requirement : {
key : "BasicAuth"
value : {}
}
security_requirement : {
key : "ApiKeyAuth"
value : {}
}
security_requirement : {
key : "ApiTokenAuth"
value : {}
}
}
responses: {
key: "403"
value: {
description: "Returned when the user does not have permission to access the resource."
}
}
responses: {
key: "404"
value: {
description: "Returned when the resource does not exist."
schema: { json_schema: { type: STRING } }
}
}
};
message EmptyRequest {}
service PartnerService {
rpc CreatePartner(paralus.dev.types.system.v3.Partner)
returns (paralus.dev.types.system.v3.Partner) {
option (google.api.http) = {
post : "/auth/v3/partner"
body : "*"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
responses : {
key : "201"
value : {
description : "Returned when partner is created successfully."
}
}
};
};
rpc GetPartner(paralus.dev.types.system.v3.Partner)
returns (paralus.dev.types.system.v3.Partner) {
option (google.api.http) = {
get : "/auth/v3/partner/{metadata.name}"
};
};
rpc GetInitPartner(EmptyRequest)
returns (paralus.dev.types.system.v3.Partner) {
option (google.api.http) = {
get : "/auth/v3/partner"
};
};
rpc UpdatePartner(paralus.dev.types.system.v3.Partner)
returns (paralus.dev.types.system.v3.Partner) {
option (google.api.http) = {
put : "/auth/v3/partner/{metadata.name}"
body : "*"
};
};
rpc DeletePartner(paralus.dev.types.system.v3.Partner)
returns (paralus.dev.types.system.v3.Partner) {
option (google.api.http) = {
delete : "/auth/v3/partner/{metadata.name}"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
responses : {
key : "204"
value : {
description : "Returned when partner is deleted successfully."
}
}
};
};
}