update api docs

fluentci-io · Apr 3, 2024 · b2d00e8 · b2d00e8
1 parent 08a7331
commit b2d00e8
Showing 1 changed file with 21 additions and 11 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -147,6 +147,7 @@ Fields of the Devbox object:
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID) | Unique identifier.                  |
 | withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Devbox](#devbox-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Devbox](#devbox-1) | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Devbox](#devbox-1) | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard output.            |
@@ -159,7 +160,8 @@ Fields of the Devenv object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)               | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Devenv](#devenv-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Devenv](#devenv-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Devenv](#devenv-1) | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Devenv](#devenv-1) | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)           | Get the standard output.            |
@@ -183,7 +185,8 @@ Fields of the Directory object:
 | pixi       |           | [Pixi](#pixi-1)     | Setup Pixi from the directory    |
 | mise       |           | [Mise](#mise-1)     | Setup Mise from the directory    |
 | envhub     |           | [Envhub](#envhub) | Setup Envhub from the directory    |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Directory](#directory-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Directory](#directory-1) | Add file at the specified path.            |
 | withWorkdir  | path: String!           | [Directory](#directory-1)       | Change the work directory  |
 | tarCzvf     |                     | [File](#file-1)              | Compress the directory to a tar gzip archive. |
 | zip          |                    | [File](#file-1)              | Compress the directory to a zip archive.      |
@@ -200,7 +203,8 @@ Fields of the Envhub object:
 | ----------- | ---------------------- |-------------------- | ----------------------------------- |
 | id          |                        | [ID](https://spec.graphql.org/October2021/#sec-ID)               | Unique identifier.                  |
 | use         | environment: `String!` | [Envhub](#envhub)   | Use the environment.                |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Envhub](#envhub) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Envhub](#envhub) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!`    | [Envhub](#envhub)   | Add command to execute.             |
 | withWorkdir |  path: `String!`        | [Envhub](#envhub)   | Set the working directory.          |
 | stdout      |                        | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard output.            |
@@ -228,7 +232,8 @@ Fields of the Flox object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)             | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Flox](#flox-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Flox](#flox-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Flox](#flox-1)     | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Flox](#flox-1)     | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)           | Get the standard output.            |
@@ -253,7 +258,8 @@ Fields of the Mise object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)              | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Mise](#mise-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Mise](#mise-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Mise](#mise-1)     | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Mise](#mise-1)     | Set the working directory.          |
 | stdout      |                     |[String](https://spec.graphql.org/October2021/#sec-String)           | Get the standard output.            |
@@ -266,7 +272,8 @@ Fields of the Nix object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)              | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Nix](#nix-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Nix](#nix-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Nix](#nix-1) | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Nix](#nix-1) | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard output.            |
@@ -279,7 +286,8 @@ Fields of the Pipeline object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)               | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Pipeline](#pipeline-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Pipeline](#pipeline-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Pipeline](#pipeline-1) | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Pipeline](#pipeline-1) | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)           | Get the standard output.            |
@@ -293,7 +301,8 @@ Fields of the Pixi object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)                | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Pixi](#pixi-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Pixi](#pixi-1) | Add file at the specified path.            |
 | withExec    |  args: `[String!]!` | [Pixi](#pixi-1) | Add command to execute.             |
 | withWorkdir |  path: `String!`     | [Pixi](#pixi-1) | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard output.            |
@@ -306,8 +315,9 @@ Fields of the Pixi object:
 | Name        | Arguments           | Type                | Description                         |
 | ----------- | ------------------- |-------------------- | ----------------------------------- |
 | id          |                     | [ID](https://spec.graphql.org/October2021/#sec-ID)                | Unique identifier.                  |
-| withCache   |  path: `String!`, cacheId: `ID!` | [Devbox](#devbox-1) | Add Cache            |
-| withExec    |  args: `[String!]!` | [Pixi](#pixi-1)     | Add command to execute.             |
-| withWorkdir |  path: `String!`     | [Pixi](#pixi-1)     | Set the working directory.          |
+| withCache   |  path: `String!`, cacheId: `ID!` | [Pkgx](#pkgx-1) | Add Cache            |
+| withFile    |  path: `String!`, fileId: `ID!` | [Pkgx](#pkgx-1) | Add file at the specified path.            |
+| withExec    |  args: `[String!]!` | [Pkgx](#pkgx-1)     | Add command to execute.             |
+| withWorkdir |  path: `String!`     | [Pkgx](#pkgx-1)     | Set the working directory.          |
 | stdout      |                     | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard output.            |
 | stderr      |                     | [String](https://spec.graphql.org/October2021/#sec-String)            | Get the standard error output.      |