More docs

Ironclad · Oct 12, 2023 · 1b96c1a · 1b96c1a
1 parent 1d55f5c
commit 1b96c1a
Show file tree

Hide file tree

Showing 15 changed files with 406 additions and 8 deletions.
diff --git a/packages/docs/docs/node-reference/assets/graph-output-node-example-01-2.png b/packages/docs/docs/node-reference/assets/graph-output-node-example-01-2.png
diff --git a/packages/docs/docs/node-reference/assets/graph-output-node-example-01.png b/packages/docs/docs/node-reference/assets/graph-output-node-example-01.png
diff --git a/packages/docs/docs/node-reference/assets/graph-output-node.png b/packages/docs/docs/node-reference/assets/graph-output-node.png
diff --git a/packages/docs/docs/node-reference/assets/hash-node-example-01.png b/packages/docs/docs/node-reference/assets/hash-node-example-01.png
diff --git a/packages/docs/docs/node-reference/assets/hash-node.png b/packages/docs/docs/node-reference/assets/hash-node.png
diff --git a/packages/docs/docs/node-reference/assets/http-call-node-example-01.png b/packages/docs/docs/node-reference/assets/http-call-node-example-01.png
diff --git a/packages/docs/docs/node-reference/assets/http-call-node-example-02.png b/packages/docs/docs/node-reference/assets/http-call-node-example-02.png
diff --git a/packages/docs/docs/node-reference/assets/http-call-node.png b/packages/docs/docs/node-reference/assets/http-call-node.png
diff --git a/packages/docs/docs/node-reference/assets/if-else-node-example-01.png b/packages/docs/docs/node-reference/assets/if-else-node-example-01.png
diff --git a/packages/docs/docs/node-reference/assets/if-else-node-example-02.png b/packages/docs/docs/node-reference/assets/if-else-node-example-02.png
diff --git a/packages/docs/docs/node-reference/assets/if-else-node.png b/packages/docs/docs/node-reference/assets/if-else-node.png
diff --git a/packages/docs/docs/node-reference/graph-output.mdx b/packages/docs/docs/node-reference/graph-output.mdx
@@ -1,5 +1,93 @@
 ---
-title: 'Graph Output'
+id: graph-output
+title: Graph Output Node
+sidebar_label: Graph Output
 ---
 
-# Graph Output Node
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+![Graph Output Node Screenshot](./assets/graph-output-node.png)
+
+## Overview
+
+The Graph Output Node is used to define the outputs of a graph. Each instance of this node represents an individual output of the graph. The value passed into this node becomes part of the overall output of the graph.
+
+When a graph is used as a subgraph, each Graph Output Node in the graph turns into an output port on the subgraph node.
+
+<Tabs
+  defaultValue="inputs"
+  values={[
+    {label: 'Inputs', value: 'inputs'},
+    {label: 'Outputs', value: 'outputs'},
+    {label: 'Editor Settings', value: 'settings'},
+  ]
+}>
+
+<TabItem value="inputs">
+
+## Inputs
+
+| Title | Data Type | Description                                                                                                                      | Default Value | Notes |
+| ----- | --------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----- |
+| Value | `any`     | The value to be outputted from the graph. The data type of the value should match the data type configured in the node settings. | (required)    |       |
+
+</TabItem>
+
+<TabItem value="outputs">
+
+## Outputs
+
+| Title        | Data Type | Description                                                                                                                    | Notes |
+| ------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------ | ----- |
+| Value Output | `any`     | The value that was passed into the node. The data type of the output will match the data type configured in the node settings. |       |
+
+</TabItem>
+
+<TabItem value="settings">
+
+## Editor Settings
+
+| Setting   | Description                                                                                                                                                                                                         | Default Value | Use Input Toggle | Input Data Type |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------- | --------------- |
+| ID        | The ID of the output. This will be used as the name and ID of the output port of the graph.                                                                                                                         | `output`      | No               | `string`        |
+| Data Type | The data type of the value to be outputted from the graph. This should match the data type of the value passed into the node. If the data type of the input data does not match, it will be coerced into this type. | `string`      | No               | N/A             |
+
+</TabItem>
+
+</Tabs>
+
+## Example 1: Define an output for a graph
+
+1. Create a [Text Node](./text.mdx) and set the value to `Hello, world!`.
+2. Create a Graph Output Node and set the ID to `greeting` and the Data Type to `String`.
+3. Connect the Text Node to the `Value` input of the Graph Output Node.
+4. Create another graph, and add a [Subgraph Node](./subgraph.mdx) to the graph. Set the Subgraph Node's Graph ID to the ID of the graph created in step 1.
+5. Run the graph. You should see the `greeting` output of the subgraph is "Hello, world!"
+
+![Graph Output Node Example 1](./assets/graph-output-node-example-01.png)
+![Graph Output Node Example 1](./assets/graph-output-node-example-01-2.png)
+
+## Error Handling
+
+The Graph Output Node will error if the data type of the value passed into the node does not match the data type configured in the node settings.
+
+## FAQ
+
+**Q: Can I have multiple Graph Output Nodes in a graph?**
+
+A: Yes, you can have multiple Graph Output Nodes in a graph. Each Graph Output Node represents an individual output of the graph. The ID of each Graph Output Node should be unique.
+
+**Q: What happens if the ID of a Graph Output Node is not unique?**
+
+A: If the ID of a Graph Output Node is not unique, the output of the graph will contain the value of the last Graph Output Node with that ID that was processed.
+
+**Q: Can I use the Graph Output Node to output an array or an object?**
+
+A: Yes, you can use the Graph Output Node to output any data type. The data type of the value passed into the node should match the data type configured in the node settings.
+
+## See Also
+
+- [Graph Input Node](./graph-input.mdx)
+- [Subgraph Node](./subgraph.mdx)
+- [Data Types](../user-guide/data-types.md)
diff --git a/packages/docs/docs/node-reference/hash.mdx b/packages/docs/docs/node-reference/hash.mdx
@@ -1,5 +1,88 @@
 ---
-title: 'Hash'
+id: hash
+title: Hash Node
+sidebar_label: Hash
 ---
 
-# Hash Node
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+![Hash Node Screenshot](./assets/hash-node.png)
+
+## Overview
+
+The Hash Node computes a hash of the input value using the configured hash function. It supports MD5, SHA-1, SHA-256, and SHA-512 hash algorithms. This node can be useful for generating unique IDs, checksums, and other purposes.
+
+<Tabs
+  defaultValue="inputs"
+  values={[
+    {label: 'Inputs', value: 'inputs'},
+    {label: 'Outputs', value: 'outputs'},
+    {label: 'Editor Settings', value: 'settings'},
+  ]
+}>
+
+<TabItem value="inputs">
+
+## Inputs
+
+| Title | Data Type | Description              | Default Value | Notes                                                          |
+| ----- | --------- | ------------------------ | ------------- | -------------------------------------------------------------- |
+| Input | `string`  | The string to be hashed. | (required)    | The input will be coerced into a string if it is not a string. |
+
+</TabItem>
+
+<TabItem value="outputs">
+
+## Outputs
+
+| Title | Data Type | Description                   | Notes |
+| ----- | --------- | ----------------------------- | ----- |
+| Hash  | `string`  | The hash of the input string. |       |
+
+</TabItem>
+
+<TabItem value="settings">
+
+## Editor Settings
+
+| Setting   | Description                                                              | Default Value | Use Input Toggle | Input Data Type |
+| --------- | ------------------------------------------------------------------------ | ------------- | ---------------- | --------------- |
+| Algorithm | The hash algorithm to use. Options are MD5, SHA-1, SHA-256, and SHA-512. | SHA-256       | No               | N/A             |
+
+</TabItem>
+
+</Tabs>
+
+## Example 1: Hash a string
+
+1. Create a [Text Node](./text.mdx) and set the value to `Hello, World!`.
+2. Create a Hash Node and connect the Text Node to its `Input` port.
+3. Run the graph. The `Hash` output of the Hash Node should contain the hash of the string `Hello, World!`.
+
+![Hash Node Example 1](./assets/hash-node-example-01.png)
+
+## Error Handling
+
+The Hash Node will error if the `Input` is not provided or if an unsupported hash algorithm is specified.
+
+## FAQ
+
+**Q: Can I use the Hash Node to hash a number or other non-string value?**
+
+A: Yes, you can. The Hash Node will automatically convert non-string inputs into strings before hashing them.
+
+**Q: Can I use the Hash Node to hash a password?**
+
+A: It is not recommended to have passwords in Rivet. If you need to hash a password, you should do so outside of Rivet.
+
+**Q: Can I use the Hash Node to generate a unique ID for a piece of data?**
+
+A: Yes, you can use the Hash Node to generate a unique repeatable ID for a piece of data by hashing the data. This can be used with the [Vector Store Node](./vector-store.mdx) to store the data in a vector store with the ID as the key.
+
+## See Also
+
+- [Text Node](./text.mdx)
+- [Number Node](./number.mdx)
+- [Vector Store Node](./vector-store.mdx)
+- [RNG Node](./rng.mdx)
diff --git a/packages/docs/docs/node-reference/http-call.mdx b/packages/docs/docs/node-reference/http-call.mdx
@@ -1,5 +1,120 @@
 ---
-title: 'HTTP Call'
+id: http-call
+title: HTTP Call Node
+sidebar_label: HTTP Call
 ---
 
-# HTTP Call Node
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+![HTTP Call Node Screenshot](./assets/http-call-node.png)
+
+## Overview
+
+The HTTP Call Node allows you to make an HTTP call to a specified URL with a given method, headers, and body. This node is particularly useful when you need to interact with external APIs or services.
+
+The HTTP Call Node uses the Fetch API to make HTTP requests. It supports all HTTP methods (GET, POST, PUT, DELETE, etc.) and allows you to specify custom headers and a request body.
+
+:::caution
+When using the default [browser executor](../user-guide/executors.md), you have to worry about [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) when making HTTP requests to external APIs. If the API you are trying to call does not support CORS to `http://tauri.local` (most do not), you will run into CORS problems. This can manifest as an error `fetch failed` in the output panel.
+
+This can be worked around by using the [Node executor](../user-guide/executors.md) in Rivet, which does not do CORS checks.
+:::
+
+<Tabs
+  defaultValue="inputs"
+  values={[
+    {label: 'Inputs', value: 'inputs'},
+    {label: 'Outputs', value: 'outputs'},
+    {label: 'Editor Settings', value: 'settings'},
+  ]
+}>
+
+<TabItem value="inputs">
+
+## Inputs
+
+The HTTP call node only has inputs when the [Editor Settings](#editor-settings) are set to use input toggles. See that section for more information.
+
+</TabItem>
+
+<TabItem value="outputs">
+
+## Outputs
+
+| Title       | Data Type | Description                                                                             | Notes                                                                   |
+| ----------- | --------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| Body        | `string`  | The body of the HTTP response.                                                          | If the response body is not a string, this output will not be ran.      |
+| JSON        | `object`  | If the response body is a JSON object, this output will contain the parsed JSON object. | If the response body is not a JSON object, this output will not be ran. |
+| Status Code | `number`  | The status code of the HTTP response.                                                   |                                                                         |
+| Headers     | `object`  | The headers of the HTTP response.                                                       |                                                                         |
+
+</TabItem>
+
+<TabItem value="settings">
+
+## Editor Settings
+
+| Setting                      | Description                                                                                                                                                                                         | Default Value | Use Input Toggle | Input Data Type |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------- | --------------- |
+| Method                       | The HTTP method to use for the request (GET, POST, PUT, DELETE, etc.).                                                                                                                              | GET           | Yes              | `string`        |
+| URL                          | The URL to make the HTTP request to.                                                                                                                                                                | (empty)       | Yes              | `string`        |
+| Headers                      | An object representing the headers to include in the HTTP request.                                                                                                                                  | (empty)       | Yes              | `object`        |
+| Body                         | The body of the HTTP request. This is typically used for POST or PUT requests. The value passed in here is not JSON stringified, so if you need a JSON body, use the [To JSON](./to-json.mdx) node. | (empty)       | Yes              | `string`        |
+| Error on non-200 status code | If enabled, the node will error if the status code of the HTTP response is not 200.                                                                                                                 | True          | No               | N/A             |
+
+</TabItem>
+
+</Tabs>
+
+## Example 1: Make a GET request to an API
+
+1. Create an HTTP Call Node and set the `Method` to `GET` and the `URL` to `https://jsonplaceholder.typicode.com/todos/1`.
+2. Run the graph. You should see all of the response data, such as the headers, response code, and body, in the output panel.
+
+![HTTP Call Node Example 1](./assets/http-call-node-example-01.png)
+
+## Example 2: Make a POST request to an API
+
+1. Create an HTTP Call Node and set the `Method` to `POST` and the `URL` to `https://jsonplaceholder.typicode.com/posts`. Enable the "Use Input" toggle on the "Body" setting to enable the input port for Body.
+2. Create an [Object Node](./object.mdx) and set the object to:
+
+```json
+{
+  "title": "foo",
+  "body": "bar",
+  "userId": 1
+}
+```
+
+3. Create a [To JSON Node](./to-json.mdx) and connect the Object Node to the `Data` input of the To JSON Node. Connect the To JSON Node to the `Body` input of the HTTP Call Node.
+4. Create an [Extract Object Path](./extract-object-path.mdx) Node and connect the `JSON` output of the HTTP Call Node to the `Object` input of the Extract Object Path Node. Set the `Path` to `$.id`.
+5. Run the graph. You should see the created ID of the post in the Extract Object Path Node's output panel.
+
+![HTTP Call Node Example 2](./assets/http-call-node-example-02.png)
+
+## Error Handling
+
+The HTTP Call Node will error if the HTTP request fails for any reason, such as a network error or if the server returns an error status code. If the `Error on non-200 status code` setting is enabled, the node will also error if the status code of the HTTP response is not 200.
+
+## FAQ
+
+**Q: Can I use the HTTP Call Node to make requests to any API?**
+
+A: Yes, you can use the HTTP Call Node to make requests to any API that supports the HTTP methods GET, POST, PUT, or DELETE.
+
+**Q: Can I use the HTTP Call Node to send JSON in the request body?**
+
+A: Yes, you can use a [Text Node](./text.mdx) to create a JSON string and connect it to the `Body` input of the HTTP Call Node.
+
+**Q: Can I use the HTTP Call Node to handle API authentication?**
+
+A: Yes, you can include authentication headers in the `Headers` input of the HTTP Call Node. However, for security reasons, you should not hardcode sensitive information like API keys in your graphs. Instead, consider using a [Context Node](./context.mdx) to securely pass in sensitive information from the host application.
+
+## See Also
+
+- [To JSON Node](./to-json.mdx)
+- [Extract JSON Node](./extract-json.mdx)
+- [Extract Object Path Node](./extract-object-path.mdx)
+- [Text Node](./text.mdx)
+- [Context Node](./context.mdx)