Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/docs/api/generator-configs/name/rename/post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Rename Generator Config
full: true
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: >-
Rename generator configuration directory. Instances that use the
configuration are repointed at the new directory and must be stopped
beforehand.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Rename generator configuration directory. Instances that use the configuration are repointed at the new directory and must be stopped beforehand.

<APIPage document={"./public/schemas/eventum-openapi.json"} operations={[{"path":"/generator-configs/{name}/rename","method":"post"}]} />
19 changes: 19 additions & 0 deletions content/docs/api/generators/id/rename/post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Rename Generator
full: true
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: >-
Rename generator. The definition in the startup file is renamed along
with the generator, and scenario membership is kept.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Rename generator. The definition in the startup file is renamed along with the generator, and scenario membership is kept.

<APIPage document={"./public/schemas/eventum-openapi.json"} operations={[{"path":"/generators/{id}/rename","method":"post"}]} />
5 changes: 5 additions & 0 deletions content/docs/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ description: Eventum API reference
<Card href="/docs/api/generator-configs/name/post" title="Create Generator Config" description="Create generator configuration in the directory with specified name." />
<Card href="/docs/api/generator-configs/name/delete" title="Delete Generator Config" description="Delete whole generator configuration directory with specified name." />
<Card href="/docs/api/generator-configs/name/put" title="Update Generator Config" description="Update generator configuration in the directory with specified name." />
<Card href="/docs/api/generator-configs/name/rename/post" title="Rename Generator Config" description="Rename generator configuration directory. Instances that use the configuration are repointed at the new directory and must be stopped beforehand." />
<Card href="/docs/api/generator-configs/name/path/get" title="Get Generator Config Path" description="Get generator configuration path in the directory with specified name." />
<Card href="/docs/api/generator-configs/name/file-tree/get" title="Get Generator File Tree" description="Get file tree of the generator directory with specified name." />
<Card href="/docs/api/generator-configs/name/file/filepath/get" title="Get Generator File" description="Read file from specified path inside generator directory with specified name." />
Expand Down Expand Up @@ -52,6 +53,7 @@ description: Eventum API reference
<Card href="/docs/api/generators/id/delete" title="Delete Generator" description="Remove generator by its id. Stop it in case it is running." />
<Card href="/docs/api/generators/id/put" title="Update Generator" description="Update generator with provided parameters. Note that `id` path parameter takes precedence over `id` field in the body." />
<Card href="/docs/api/generators/id/status/get" title="Get Generator Status" description="Get generator status" />
<Card href="/docs/api/generators/id/rename/post" title="Rename Generator" description="Rename generator. The definition in the startup file is renamed along with the generator, and scenario membership is kept." />
<Card href="/docs/api/generators/id/start/post" title="Start Generator" description="Start generator by its id" />
<Card href="/docs/api/generators/id/stop/post" title="Stop Generator" description="Stop generator by its id" />
<Card href="/docs/api/generators/id/stats/get" title="Get Generator Stats" description="Get stats of running generator" />
Expand All @@ -68,6 +70,7 @@ description: Eventum API reference
<Card href="/docs/api/scenarios/get" title="List Scenarios" description="List all scenarios" />
<Card href="/docs/api/scenarios/name/get" title="Get Scenario" description="Get scenario details" />
<Card href="/docs/api/scenarios/name/delete" title="Delete Scenario" description="Delete scenario (remove tag from all generators)" />
<Card href="/docs/api/scenarios/name/rename/post" title="Rename Scenario" description="Rename scenario (rewrite tag in all generators that carry it)" />
<Card href="/docs/api/scenarios/name/generators/generator_id/post" title="Add Generator To Scenario" description="Add generator to scenario" />
<Card href="/docs/api/scenarios/name/generators/generator_id/delete" title="Remove Generator From Scenario" description="Remove generator from scenario" />
<Card href="/docs/api/scenarios/name/generators/generator_name/globals-usage/get" title="Get globals usage for a generator in a scenario" description="Detect globals.set/get usage in Jinja2 templates via AST analysis." />
Expand All @@ -80,4 +83,6 @@ description: Eventum API reference
<Card href="/docs/api/secrets/name/delete" title="Delete Secret Value" description="Delete secret with specified name to keyring" />
<Card href="/docs/api/secrets/name/put" title="Set Secret Value" description="Put secret with specified name to keyring" />
<Card href="/docs/api/secrets/get" title="List Secret Names" description="List all secrets names" />
<Card href="/docs/api/secrets/name/references/get" title="List Secret References" description="List projects whose configuration references the secret as `${secrets.<name>}`" />
<Card href="/docs/api/secrets/name/rename/post" title="Rename Secret Value" description="Rename secret in keyring. References to the secret in generator configurations are not rewritten." />
</Cards>
17 changes: 17 additions & 0 deletions content/docs/api/scenarios/name/rename/post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Rename Scenario
full: true
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: Rename scenario (rewrite tag in all generators that carry it)
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Rename scenario (rewrite tag in all generators that carry it)

<APIPage document={"./public/schemas/eventum-openapi.json"} operations={[{"path":"/scenarios/{name}/rename","method":"post"}]} />
19 changes: 19 additions & 0 deletions content/docs/api/secrets/name/references/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: List Secret References
full: true
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: >-
List projects whose configuration references the secret as
`${secrets.<name>}`
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

List projects whose configuration references the secret as `${secrets.<name>}`

<APIPage document={"./public/schemas/eventum-openapi.json"} operations={[{"path":"/secrets/{name}/references","method":"get"}]} />
19 changes: 19 additions & 0 deletions content/docs/api/secrets/name/rename/post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Rename Secret Value
full: true
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: >-
Rename secret in keyring. References to the secret in generator
configurations are not rewritten.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Rename secret in keyring. References to the secret in generator configurations are not rewritten.

<APIPage document={"./public/schemas/eventum-openapi.json"} operations={[{"path":"/secrets/{name}/rename","method":"post"}]} />
2 changes: 2 additions & 0 deletions content/docs/studio/instances.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Click the **Create new** button in the top right to register a new generator ins

To create an instance from an existing one, open the row's three-dot menu and choose **Clone**. The new instance points at the same project and carries over all of the original's parameters — you only pick a name for it.

To give an instance a different name, choose **Rename** in the same menu. The instance keeps its project, its parameters, and its scenario membership; only inactive instances can be renamed. Log entries written under the previous name stay in their own log file.

## Lifecycle controls

The toolbar next to the "Create new" button provides bulk actions for selected instances (use the checkboxes in each row):
Expand Down
6 changes: 5 additions & 1 deletion content/docs/studio/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ The table has the following columns:

Click **Create new** to scaffold a new generator project.

Each row has a three-dot menu for actions like deleting or duplicating the project.
Each row has a three-dot menu for actions like renaming or deleting the project.

### Renaming a project

**Rename** in the row menu changes the project name and moves its directory. Instances that use the project follow the new name automatically — the dialog lists them, and all of them must be stopped before the rename goes through.

---

Expand Down
2 changes: 2 additions & 0 deletions content/docs/studio/scenarios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The table shows all scenarios with their instance count and aggregate status. Th

Click **Create new** to create a scenario — pick a name and select instances.

**Rename** in the row menu gives a scenario a different name: the tag is rewritten on every instance that carries it. The new name has to be free, so two scenarios cannot be merged by renaming one onto the other.

## Scenario detail page

<ThemedImage
Expand Down
8 changes: 7 additions & 1 deletion content/docs/studio/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The page shows a table with three columns:

| Column | Description |
|--------|-------------|
| **Name** | The secret name (the key used in `${secrets.name}` tokens). |
| **Name** | The secret name (the key used in `${secrets.name}` tokens). Hovering the row reveals **copy** and **rename** (<TextCursorInput className="inline" size={14} />) buttons next to it. |
| **Value** | The secret value, masked with asterisks by default. |
| **Actions** | Three buttons per row: **reveal** (<Eye className="inline" size={14} />), **edit** (<Pencil className="inline" size={14} />), and **delete** (<Trash2 className="inline" size={14} />). |

Expand All @@ -47,6 +47,12 @@ Click the **reveal** (<Eye className="inline" size={14} />) button next to a sec

Click the **edit** (<Pencil className="inline" size={14} />) button to edit an existing secret's value. The field becomes editable and you can save the updated value.

### Renaming secrets

Hover the row and click the **rename** (<TextCursorInput className="inline" size={14} />) button next to the secret name to give it a different name. The value is kept under the new name.

The dialog lists the projects whose configuration reads the secret as `${secrets.name}`. Those tokens keep the old name — update them yourself, otherwise the affected generators fail to load.

### Deleting secrets

Click the **delete** (<Trash2 className="inline" size={14} />) button to remove a secret from the keyring. This is irreversible — any generator configs referencing `${secrets.name}` for the deleted secret will fail to load until the secret is re-created.
Expand Down
2 changes: 2 additions & 0 deletions mdx-components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
GraduationCap,
Pencil,
Save,
TextCursorInput,
Trash2,
} from 'lucide-react';
import type { MDXComponents } from 'mdx/types';
Expand Down Expand Up @@ -43,6 +44,7 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents {
GraduationCap,
Pencil,
Save,
TextCursorInput,
Trash2,
...components,
};
Expand Down
Loading