Skip to content

Commit 5960ab3

Browse files
committed
update docs
1 parent 9f6f3dc commit 5960ab3

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

doc/config-schema.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This document describes the schema for the librarian.yaml.
103103

104104
## DartPackage Configuration
105105

106-
[Link to code](../internal/config/language.go#L289)
106+
[Link to code](../internal/config/language.go#L301)
107107
| Field | Type | Description |
108108
| :--- | :--- | :--- |
109109
| `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.
126126

127127
## GoAPI Configuration
128128

129-
[Link to code](../internal/config/language.go#L27)
129+
[Link to code](../internal/config/language.go#L30)
130130
| Field | Type | Description |
131131
| :--- | :--- | :--- |
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. |
139139

140140
## GoModule Configuration
141141

142142
[Link to code](../internal/config/language.go#L20)
143143
| Field | Type | Description |
144144
| :--- | :--- | :--- |
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. |
148148

149149
## PythonPackage Configuration
150150

151-
[Link to code](../internal/config/language.go#L270)
151+
[Link to code](../internal/config/language.go#L282)
152152
| Field | Type | Description |
153153
| :--- | :--- | :--- |
154154
| `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.
157157

158158
## RustCrate Configuration
159159

160-
[Link to code](../internal/config/language.go#L136)
160+
[Link to code](../internal/config/language.go#L148)
161161
| Field | Type | Description |
162162
| :--- | :--- | :--- |
163163
| (embedded) | [RustDefault](#rustdefault-configuration) | |
@@ -184,7 +184,7 @@ This document describes the schema for the librarian.yaml.
184184

185185
## RustDefault Configuration
186186

187-
[Link to code](../internal/config/language.go#L38)
187+
[Link to code](../internal/config/language.go#L50)
188188
| Field | Type | Description |
189189
| :--- | :--- | :--- |
190190
| `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.
194194

195195
## RustDiscovery Configuration
196196

197-
[Link to code](../internal/config/language.go#L252)
197+
[Link to code](../internal/config/language.go#L264)
198198
| Field | Type | Description |
199199
| :--- | :--- | :--- |
200200
| `operation_id` | string | OperationID is the ID of the LRO operation type (e.g., ".google.cloud.compute.v1.Operation"). |
201201
| `pollers` | list of [RustPoller](#rustpoller-configuration) | Pollers is a list of LRO polling configurations. |
202202

203203
## RustDocumentationOverride Configuration
204204

205-
[Link to code](../internal/config/language.go#L231)
205+
[Link to code](../internal/config/language.go#L243)
206206
| Field | Type | Description |
207207
| :--- | :--- | :--- |
208208
| `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.
211211

212212
## RustModule Configuration
213213

214-
[Link to code](../internal/config/language.go#L58)
214+
[Link to code](../internal/config/language.go#L70)
215215
| Field | Type | Description |
216216
| :--- | :--- | :--- |
217217
| `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.
240240

241241
## RustPackageDependency Configuration
242242

243-
[Link to code](../internal/config/language.go#L203)
243+
[Link to code](../internal/config/language.go#L215)
244244
| Field | Type | Description |
245245
| :--- | :--- | :--- |
246246
| `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.
253253

254254
## RustPaginationOverride Configuration
255255

256-
[Link to code](../internal/config/language.go#L243)
256+
[Link to code](../internal/config/language.go#L255)
257257
| Field | Type | Description |
258258
| :--- | :--- | :--- |
259259
| `id` | string | ID is the fully qualified method ID (e.g., .google.cloud.sql.v1.Service.Method). |
260260
| `item_field` | string | ItemField is the name of the field used for items. |
261261

262262
## RustPoller Configuration
263263

264-
[Link to code](../internal/config/language.go#L261)
264+
[Link to code](../internal/config/language.go#L273)
265265
| Field | Type | Description |
266266
| :--- | :--- | :--- |
267267
| `prefix` | string | Prefix is an acceptable prefix for the URL path (e.g., "compute/v1/projects/{project}/zones/{zone}"). |

0 commit comments

Comments
 (0)