Skip to content

Commit d427a86

Browse files
authored
chore(external docs): rengen component docs (#23737)
1 parent 6a5eecc commit d427a86

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

website/cue/reference/generated/configuration.cue

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,40 @@ generated: configuration: configuration: {
304304
required: true
305305
relevant_when: "type = \"exec\""
306306
}
307+
protocol: {
308+
type: object: options: {
309+
backend_config: {
310+
type: "*": {}
311+
description: """
312+
The configuration to pass to the secrets executable. This is the `config` field in the
313+
backend request. Refer to the documentation of your `backend_type `to see which options
314+
are required to be set.
315+
"""
316+
required: false
317+
relevant_when: "version = \"v1_1\""
318+
}
319+
backend_type: {
320+
type: string: {}
321+
description: "The name of the backend. This is `type` field in the backend request."
322+
required: true
323+
relevant_when: "version = \"v1_1\""
324+
}
325+
version: {
326+
required: false
327+
type: string: {
328+
enum: {
329+
v1: "Expect the command to fetch the configuration options itself."
330+
v1_1: "Configuration options to the command are to be curried upon each request."
331+
}
332+
default: "v1"
333+
}
334+
description: "The protocol version."
335+
}
336+
}
337+
description: "Settings for the protocol between Vector and the secrets executable."
338+
required: false
339+
relevant_when: "type = \"exec\""
340+
}
307341
timeout: {
308342
type: uint: default: 5
309343
description: "The timeout, in seconds, to wait for the command to complete."

0 commit comments

Comments
 (0)