Repository navigation
Secret Manager doesn't tell me which parameters are required #7794
Description
Looking at this ol favorite:
const sm = new SecretManagerServiceClient();
const [secrets] = await sm.listSecrets({
parent: 'projects/el-gato',
});Looking at the listSecrets method, I see it takes an options bag. Great! I dig deeper:
listSecrets(request: protos.google.cloud.secretmanager.v1.IListSecretsRequest, options?: gax.CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecret[], protos.google.cloud.secretmanager.v1.IListSecretsRequest | null, protos.google.cloud.secretmanager.v1.IListSecretsResponse]>;Ok, fine, what does IListSecretsRequest look like:
/** Properties of a ListSecretsRequest. */
interface IListSecretsRequest {
/** ListSecretsRequest parent */
parent?: (string|null);
/** ListSecretsRequest pageSize */
pageSize?: (number|null);
/** ListSecretsRequest pageToken */
pageToken?: (string|null);
}This has 2 separate problems:
-
I have no idea which of these parameters are required. I know that when I ran my code without it, I got an exception for not passing a
parent:) -
I have no idea what any of these properties mean (I mean I do, but a mortal wouldn't). Aren't there better descriptions somewhere for these properties in the protos?
Activity
alexander-fenster commentedon Sep 3, 2020
This one is a valid bugreport / feature request. We do have comments in protos, but apparently protobuf.js ignores the
//-style comments (it wants/* */-style comments). I even proposed the hacky way to fix it googleapis/gapic-generator-typescript#150 but we decided it must be fixed in protobuf.js.I think there might be an option for that, I'll try to figure out.
alexander-fenster commentedon Sep 3, 2020
re: required fields - we mark required fields in protos (with annotations) but those annotations don't map well into the types generated by
pbts. I need to think how to make it better.