You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/config-schema.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ This document describes the schema for the librarian.yaml.
103
103
104
104
## DartPackage Configuration
105
105
106
-
[Link to code](../internal/config/language.go#L289)
106
+
[Link to code](../internal/config/language.go#L301)
107
107
| Field | Type | Description |
108
108
| :--- | :--- | :--- |
109
109
|`api_keys_environment_variables`| string | APIKeysEnvironmentVariables is a comma-separated list of environment variable names that can contain API keys (e.g., "GOOGLE_API_KEY,GEMINI_API_KEY"). |
@@ -126,29 +126,29 @@ This document describes the schema for the librarian.yaml.
126
126
127
127
## GoAPI Configuration
128
128
129
-
[Link to code](../internal/config/language.go#L27)
129
+
[Link to code](../internal/config/language.go#L30)
130
130
| Field | Type | Description |
131
131
| :--- | :--- | :--- |
132
-
|`client_directory`| string ||
133
-
|`disable_gapic`| bool ||
134
-
|`import_path`| string ||
135
-
|`nested_protos`| list of string ||
136
-
|`no_rest_numeric_enums`| bool ||
137
-
|`path`| string ||
138
-
|`proto_package`| string ||
132
+
|`client_directory`| string |ClientDirectory is the directory where the client is generated, relative to Library.Output.|
133
+
|`disable_gapic`| bool |DisableGAPIC determines whether to generate the GAPIC client.|
134
+
|`import_path`| string |ImportPath is the Go import path for the API.|
135
+
|`nested_protos`| list of string |NestedProtos is a list of nested proto files.|
136
+
|`no_rest_numeric_enums`| bool |NoRESTNumericEnums determines whether to use numeric enums in REST requests. Use No prefix because we want the default value to be `false`, otherwise lots of libraries will have an additional configuration.|
137
+
|`path`| string |Path is the source path.|
138
+
|`proto_package`| string |ProtoPackage is the proto package name.|
139
139
140
140
## GoModule Configuration
141
141
142
142
[Link to code](../internal/config/language.go#L20)
143
143
| Field | Type | Description |
144
144
| :--- | :--- | :--- |
145
-
|`delete_generation_output_paths`| list of string ||
146
-
|`go_apis`| list of [GoAPI](#goapi-configuration) (optional) ||
147
-
|`module_path_version`| string ||
145
+
|`delete_generation_output_paths`| list of string |DeleteGenerationOutputPaths is a list of paths to delete before generation.|
146
+
|`go_apis`| list of [GoAPI](#goapi-configuration) (optional) |GoAPIs is a list of Go-specific API configurations.|
147
+
|`module_path_version`| string |ModulePathVersion is the version of the Go module path.|
148
148
149
149
## PythonPackage Configuration
150
150
151
-
[Link to code](../internal/config/language.go#L270)
151
+
[Link to code](../internal/config/language.go#L282)
152
152
| Field | Type | Description |
153
153
| :--- | :--- | :--- |
154
154
|`opt_args`| list of string | OptArgs contains additional options passed to the generator, where the options are common to all apis. Example: ["warehouse-package-name=google-cloud-batch"]|
@@ -157,7 +157,7 @@ This document describes the schema for the librarian.yaml.
157
157
158
158
## RustCrate Configuration
159
159
160
-
[Link to code](../internal/config/language.go#L136)
160
+
[Link to code](../internal/config/language.go#L148)
@@ -184,7 +184,7 @@ This document describes the schema for the librarian.yaml.
184
184
185
185
## RustDefault Configuration
186
186
187
-
[Link to code](../internal/config/language.go#L38)
187
+
[Link to code](../internal/config/language.go#L50)
188
188
| Field | Type | Description |
189
189
| :--- | :--- | :--- |
190
190
|`package_dependencies`| list of [RustPackageDependency](#rustpackagedependency-configuration) (optional) | PackageDependencies is a list of default package dependencies. These are inherited by all libraries. If a library defines its own package_dependencies, the library-specific ones take precedence over these defaults for dependencies with the same name. |
@@ -194,15 +194,15 @@ This document describes the schema for the librarian.yaml.
194
194
195
195
## RustDiscovery Configuration
196
196
197
-
[Link to code](../internal/config/language.go#L252)
197
+
[Link to code](../internal/config/language.go#L264)
198
198
| Field | Type | Description |
199
199
| :--- | :--- | :--- |
200
200
|`operation_id`| string | OperationID is the ID of the LRO operation type (e.g., ".google.cloud.compute.v1.Operation"). |
201
201
|`pollers`| list of [RustPoller](#rustpoller-configuration)| Pollers is a list of LRO polling configurations. |
202
202
203
203
## RustDocumentationOverride Configuration
204
204
205
-
[Link to code](../internal/config/language.go#L231)
205
+
[Link to code](../internal/config/language.go#L243)
206
206
| Field | Type | Description |
207
207
| :--- | :--- | :--- |
208
208
|`id`| string | ID is the fully qualified element ID (e.g., .google.cloud.dialogflow.v2.Message.field). |
@@ -211,7 +211,7 @@ This document describes the schema for the librarian.yaml.
211
211
212
212
## RustModule Configuration
213
213
214
-
[Link to code](../internal/config/language.go#L58)
214
+
[Link to code](../internal/config/language.go#L70)
215
215
| Field | Type | Description |
216
216
| :--- | :--- | :--- |
217
217
|`disabled_rustdoc_warnings`| yaml.StringSlice | DisabledRustdocWarnings specifies rustdoc lints to disable. An empty slice explicitly enables all warnings. |
@@ -240,7 +240,7 @@ This document describes the schema for the librarian.yaml.
240
240
241
241
## RustPackageDependency Configuration
242
242
243
-
[Link to code](../internal/config/language.go#L203)
243
+
[Link to code](../internal/config/language.go#L215)
244
244
| Field | Type | Description |
245
245
| :--- | :--- | :--- |
246
246
|`name`| string | Name is the dependency name. It is listed first so it appears at the top of each dependency entry in YAML. |
@@ -253,15 +253,15 @@ This document describes the schema for the librarian.yaml.
253
253
254
254
## RustPaginationOverride Configuration
255
255
256
-
[Link to code](../internal/config/language.go#L243)
256
+
[Link to code](../internal/config/language.go#L255)
257
257
| Field | Type | Description |
258
258
| :--- | :--- | :--- |
259
259
|`id`| string | ID is the fully qualified method ID (e.g., .google.cloud.sql.v1.Service.Method). |
260
260
|`item_field`| string | ItemField is the name of the field used for items. |
261
261
262
262
## RustPoller Configuration
263
263
264
-
[Link to code](../internal/config/language.go#L261)
264
+
[Link to code](../internal/config/language.go#L273)
265
265
| Field | Type | Description |
266
266
| :--- | :--- | :--- |
267
267
|`prefix`| string | Prefix is an acceptable prefix for the URL path (e.g., "compute/v1/projects/{project}/zones/{zone}"). |
0 commit comments