Skip to content

Commit af4d3cf

Browse files
tsirysndrtsirysndr
committed
update GraphQL API docs
1 parent e0e55d0 commit af4d3cf

File tree

1 file changed

+141
-4
lines changed

1 file changed

+141
-4
lines changed

‎docs/api.md

+141-4
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,76 @@ Creates a pixi environment.
122122

123123
**type**: [Pixi](#pixi-1)
124124

125+
### googleCloudSecretManager
126+
127+
Set up Google Cloud Secret Manager Client
128+
129+
**type**: [SecretManager!](#secretmanager)
130+
131+
**Arguments for `googleCloudSecretManager`**
132+
133+
| Name | type | Description |
134+
| ------- | ----------- | ------------ |
135+
| project | [String](https://spec.graphql.org/October2021/#sec-String)! | Google Cloud Project name |
136+
| googleCredentialsFile | [String](https://spec.graphql.org/October2021/#sec-String)! | Path to the Google Credentials file |
137+
138+
### awsSecretsManager
139+
140+
Set up AWS Secrets Manager Client
141+
142+
**type**: [SecretManager!](#secretmanager)
143+
144+
**Arguments for `awsSecretsManager`**
145+
146+
| Name | type |
147+
| --------------- | ----------------------------------------------------------- |
148+
| region | [String](https://spec.graphql.org/October2021/#sec-String)! |
149+
| accessKeyId | [String](https://spec.graphql.org/October2021/#sec-String)! |
150+
| secretAccessKey | [String](https://spec.graphql.org/October2021/#sec-String)! |
151+
152+
### azureKeyvault
153+
154+
Set up Azure Key Vault Client
155+
156+
**type**: [SecretManager!](#secretmanager)
157+
158+
**Arguments for `azureKeyvault`**
159+
160+
| Name | type |
161+
| --------------- | ----------------------------------------------------------- |
162+
| clientId | [String](https://spec.graphql.org/October2021/#sec-String)! |
163+
| clientSecret | [String](https://spec.graphql.org/October2021/#sec-String)! |
164+
| tenantId | [String](https://spec.graphql.org/October2021/#sec-String)! |
165+
| keyvaultName | [String](https://spec.graphql.org/October2021/#sec-String)! |
166+
| keyvaultUrl | [String](https://spec.graphql.org/October2021/#sec-String)! |
167+
168+
### hashicorpVault
169+
170+
Set up HashiCorp Vault Client
171+
172+
**type**: [SecretManager!](#secretmanager)
173+
174+
**Arguments for `hashicorpVault`**
175+
176+
| Name | type |
177+
| --------- | ----------------------------------------------------------- |
178+
| address | [String](https://spec.graphql.org/October2021/#sec-String)! |
179+
| token | [String](https://spec.graphql.org/October2021/#sec-String)! |
180+
| cacerts | [String](https://spec.graphql.org/October2021/#sec-String) |
181+
182+
### setSecret
183+
184+
Create a new Secret
185+
186+
**type**: [Secret!](#secret)
187+
188+
**Arguments for `setSecret`**
189+
190+
| Name | type |
191+
| --------- | ----------------------------------------------------------- |
192+
| name | [String](https://spec.graphql.org/October2021/#sec-String)! |
193+
| value | [String](https://spec.graphql.org/October2021/#sec-String)! |
194+
125195
## Objects
126196

127197
[Objects](https://spec.graphql.org/June2018/#sec-Objects) in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
@@ -150,6 +220,10 @@ Fields of the Devbox object:
150220
| withFile | path: `String!`, fileId: `ID!` | [Devbox](#devbox-1) | Add file at the specified path. |
151221
| withExec | args: `[String!]!` | [Devbox](#devbox-1) | Add command to execute. |
152222
| withWorkdir | path: `String!` | [Devbox](#devbox-1) | Set the working directory. |
223+
| withEnvVariable | name: `String!`, value: `String!` | [Devbox](#devbox-1) | Add an Environment Variable |
224+
| withSecretVariable | name: `String!`, secret: `ID!` | [Devbox](#devbox-1) | Add an Secret Variable |
225+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
226+
| waitOn | port: `Int!`, timeout: `Int` | [Devbox](#devbox-1) | Wait on a service at a specific port to be ready |
153227
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
154228
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
155229

@@ -164,6 +238,10 @@ Fields of the Devenv object:
164238
| withFile | path: `String!`, fileId: `ID!` | [Devenv](#devenv-1) | Add file at the specified path. |
165239
| withExec | args: `[String!]!` | [Devenv](#devenv-1) | Add command to execute. |
166240
| withWorkdir | path: `String!` | [Devenv](#devenv-1) | Set the working directory. |
241+
| withEnvVariable | name: `String!`, value: `String!` | [Devenv](#devenv-1) | Add an Environment Variable |
242+
| withSecretVariable | name: `String!`, secret: `ID!` | [Devenv](#devenv-1) | Add an Secret Variable |
243+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
244+
| waitOn | port: `Int!`, timeout: `Int` | [Devbox](#devbox-1) | Wait on a service at a specific port to be ready |
167245
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
168246
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
169247

@@ -190,8 +268,12 @@ Fields of the Directory object:
190268
| withWorkdir | path: String! | [Directory](#directory-1) | Change the work directory |
191269
| tarCzvf | | [File](#file-1) | Compress the directory to a tar gzip archive. |
192270
| zip | | [File](#file-1) | Compress the directory to a zip archive. |
193-
| withExec | args: `[String!]!` | [Envhub](#envhub) | Add command to execute. |
194-
| withWorkdir | path: `String!` | [Envhub](#envhub) | Set the working directory. |
271+
| withExec | args: `[String!]!` | [Directory](#directory) | Add command to execute. |
272+
| withWorkdir | path: `String!` | [Directory](#directory) | Set the working directory. |
273+
| withEnvVariable | name: `String!`, value: `String!` | [Directory](#directory) | Add an Environment Variable |
274+
| withSecretVariable | name: `String!`, secret: `ID!` | [Directory](#directory) | Add an Secret Variable |
275+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
276+
| waitOn | port: `Int!`, timeout: `Int` | [Directory](#directory) | Wait on a service at a specific port to be ready |
195277
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
196278
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
197279

@@ -207,6 +289,10 @@ Fields of the Envhub object:
207289
| withFile | path: `String!`, fileId: `ID!` | [Envhub](#envhub) | Add file at the specified path. |
208290
| withExec | args: `[String!]!` | [Envhub](#envhub) | Add command to execute. |
209291
| withWorkdir | path: `String!` | [Envhub](#envhub) | Set the working directory. |
292+
| withEnvVariable | name: `String!`, value: `String!` | [Envhub](#envhub) | Add an Environment Variable |
293+
| withSecretVariable | name: `String!`, secret: `ID!` | [Envhub](#envhub) | Add an Secret Variable |
294+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
295+
| waitOn | port: `Int!`, timeout: `Int` | [Envhub](#envhub) | Wait on a service at a specific port to be ready |
210296
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
211297
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
212298

@@ -236,6 +322,10 @@ Fields of the Flox object:
236322
| withFile | path: `String!`, fileId: `ID!` | [Flox](#flox-1) | Add file at the specified path. |
237323
| withExec | args: `[String!]!` | [Flox](#flox-1) | Add command to execute. |
238324
| withWorkdir | path: `String!` | [Flox](#flox-1) | Set the working directory. |
325+
| withEnvVariable | name: `String!`, value: `String!` | [Flox](#flox-1) | Add an Environment Variable |
326+
| withSecretVariable | name: `String!`, secret: `ID!` | [Flox](#flox-1) | Add an Secret Variable |
327+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
328+
| waitOn | port: `Int!`, timeout: `Int` | [Flox](#flox-1) | Wait on a service at a specific port to be ready |
239329
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
240330
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
241331

@@ -262,6 +352,10 @@ Fields of the Mise object:
262352
| withFile | path: `String!`, fileId: `ID!` | [Mise](#mise-1) | Add file at the specified path. |
263353
| withExec | args: `[String!]!` | [Mise](#mise-1) | Add command to execute. |
264354
| withWorkdir | path: `String!` | [Mise](#mise-1) | Set the working directory. |
355+
| withEnvVariable | name: `String!`, value: `String!` | [Mise](#mise-1) | Add an Environment Variable |
356+
| withSecretVariable | name: `String!`, secret: `ID!` | [Mise](#mise-1) | Add an Secret Variable |
357+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
358+
| waitOn | port: `Int!`, timeout: `Int` | [Mise](#mise-1) | Wait on a service at a specific port to be ready |
265359
| stdout | |[String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
266360
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
267361

@@ -276,6 +370,10 @@ Fields of the Nix object:
276370
| withFile | path: `String!`, fileId: `ID!` | [Nix](#nix-1) | Add file at the specified path. |
277371
| withExec | args: `[String!]!` | [Nix](#nix-1) | Add command to execute. |
278372
| withWorkdir | path: `String!` | [Nix](#nix-1) | Set the working directory. |
373+
| withEnvVariable | name: `String!`, value: `String!` | [Nix](#nix-1) | Add an Environment Variable |
374+
| withSecretVariable | name: `String!`, secret: `ID!` | [Nix](#nix-1) | Add an Secret Variable |
375+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
376+
| waitOn | port: `Int!`, timeout: `Int` | [Nix](#nix-1) | Wait on a service at a specific port to be ready |
279377
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
280378
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
281379

@@ -290,10 +388,13 @@ Fields of the Pipeline object:
290388
| withFile | path: `String!`, fileId: `ID!` | [Pipeline](#pipeline-1) | Add file at the specified path. |
291389
| withExec | args: `[String!]!` | [Pipeline](#pipeline-1) | Add command to execute. |
292390
| withWorkdir | path: `String!` | [Pipeline](#pipeline-1) | Set the working directory. |
391+
| withEnvVariable | name: `String!`, value: `String!` | [Pipeline](#pipeline-1) | Add an Environment Variable |
392+
| withSecretVariable | name: `String!`, secret: `ID!` | [Pipeline](#pipeline-1) | Add an Secret Variable |
393+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
394+
| waitOn | port: `Int!`, timeout: `Int` | [Pipeline](#pipeline-1) | Wait on a service at a specific port to be ready |
293395
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
294396
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
295397

296-
297398
### Pixi
298399

299400
Fields of the Pixi object:
@@ -305,6 +406,10 @@ Fields of the Pixi object:
305406
| withFile | path: `String!`, fileId: `ID!` | [Pixi](#pixi-1) | Add file at the specified path. |
306407
| withExec | args: `[String!]!` | [Pixi](#pixi-1) | Add command to execute. |
307408
| withWorkdir | path: `String!` | [Pixi](#pixi-1) | Set the working directory. |
409+
| withEnvVariable | name: `String!`, value: `String!` | [Pixi](#pixi-1) | Add an Environment Variable |
410+
| withSecretVariable | name: `String!`, secret: `ID!` | [Pixi](#pixi-1) | Add an Secret Variable |
411+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
412+
| waitOn | port: `Int!`, timeout: `Int` | [Pixi](#pixi-1) | Wait on a service at a specific port to be ready |
308413
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
309414
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
310415

@@ -319,5 +424,37 @@ Fields of the Pixi object:
319424
| withFile | path: `String!`, fileId: `ID!` | [Pkgx](#pkgx-1) | Add file at the specified path. |
320425
| withExec | args: `[String!]!` | [Pkgx](#pkgx-1) | Add command to execute. |
321426
| withWorkdir | path: `String!` | [Pkgx](#pkgx-1) | Set the working directory. |
427+
| withEnvVariable | name: `String!`, value: `String!` | [Pkgx](#pkgx-1) | Add an Environment Variable |
428+
| withSecretVariable | name: `String!`, secret: `ID!` | [Pkgx](#pkgx-1) | Add an Secret Variable |
429+
| asService | name: `String!` | [Service](#service) | Convert into a Service |
430+
| waitOn | port: `Int!`, timeout: `Int` | [Pkgx](#pkgx-1) | Wait on a service at a specific port to be ready |
322431
| stdout | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard output. |
323-
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
432+
| stderr | | [String](https://spec.graphql.org/October2021/#sec-String) | Get the standard error output. |
433+
434+
### Secret
435+
436+
Fields of the Secret object:
437+
438+
| Name | Arguments | Type | Description |
439+
| ----------- | ------------------- |-------------------- | ----------------------------------- |
440+
| id | | [ID](https://spec.graphql.org/October2021/#sec-ID) | Unique identifier. |
441+
| plaintext | | `String!` | The value of the secret in plain text |
442+
| name | | `String!` | The name of the secret |
443+
| mount | | The mount point of the secret |
444+
445+
### Service
446+
447+
Fields of the Service:
448+
449+
| Name | Arguments | Type | Description |
450+
| ----------- | ------------------- |-------------------- | ----------------------------------- |
451+
| id | | [ID](https://spec.graphql.org/October2021/#sec-ID) | Unique identifier. |
452+
453+
### SecretManager
454+
455+
Fields of the SecretManager object:
456+
457+
| Name | Arguments | Type | Description |
458+
| ----------- | ------------------- |-------------------- | ----------------------------------- |
459+
| id | | [ID](https://spec.graphql.org/October2021/#sec-ID) | Unique identifier. |
460+
| getSecret | name: `String` | `[Secret!]!` | Download secrets from the Secret Provider |

0 commit comments

Comments
 (0)