Skip to content

docs: update docs #3534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: update docs #3534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
94 changes: 47 additions & 47 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,17 @@ Deploy Rivet Actors anywhere - from serverless platforms to your own infrastruct
- [Node.js](https://www.rivet.dev/docs/actors/quickstart/backend)
- [Bun](https://www.rivet.dev/docs/actors/quickstart/backend)
- [Deno](https://github.com/rivet-dev/rivetkit/tree/9a3d850aee45167eadf249fdbae60129bf37e818/examples/deno)
- [Vercel](https://www.rivet.dev/docs/deploy/vercel) *(1-Click Deploy)*
- [Vercel](https://www.rivet.dev/docs/connect/vercel) *(1-Click Deploy)*
- [Railway](https://railway.com/deploy/rivet) *(1-Click Deploy)*
- [Durable Objects](https://www.rivet.dev/docs/actors/quickstart/backend)
- [Kubernetes](https://www.rivet.dev/docs/deploy/kubernetes)
- [AWS ECS](https://www.rivet.dev/docs/deploy/aws-ecs)
- [Google Cloud Run](https://www.rivet.dev/docs/deploy/gcp-cloud-run)
- [Hetzner](https://www.rivet.dev/docs/deploy/hetzner)
- [VM & Bare Metal](https://www.rivet.dev/docs/deploy/vm-and-bare-metal)
- [AWS Lambda](https://www.rivet.dev/docs/deploy/aws-lambda) *(On The Roadmap)*
- [Supabase](https://www.rivet.dev/docs/deploy/supabase) *(On The Roadmap)*
- [Freestyle](https://www.rivet.dev/docs/deploy/freestyle) *(On The Roadmap)*
- [Kubernetes](https://www.rivet.dev/docs/connect/kubernetes)
- [AWS ECS](https://www.rivet.dev/docs/connect/aws-ecs)
- [Google Cloud Run](https://www.rivet.dev/docs/connect/gcp-cloud-run)
- [Hetzner](https://www.rivet.dev/docs/connect/hetzner)
- [VM & Bare Metal](https://www.rivet.dev/docs/connect/vm-and-bare-metal)
- [AWS Lambda](https://www.rivet.dev/docs/connect/aws-lambda) *(On The Roadmap)*
- [Supabase](https://www.rivet.dev/docs/connect/supabase) *(On The Roadmap)*
- [Freestyle](https://www.rivet.dev/docs/connect/freestyle) *(On The Roadmap)*

## Works With Your Tools

Expand Down
2 changes: 1 addition & 1 deletion engine/artifacts/openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions frontend/src/app/dialogs/connect-manual-serverfull-frame.tsx
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rivetkit-asyncapi/asyncapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"asyncapi": "3.0.0",
"info": {
"title": "RivetKit WebSocket Protocol",
"version": "2.0.24",
"version": "2.0.25-rc.1",
"description": "WebSocket protocol for bidirectional communication between RivetKit clients and actors"
},
"channels": {
Expand Down
279 changes: 278 additions & 1 deletion rivetkit-openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.0",
"info": {
"version": "2.0.24",
"version": "2.0.25-rc.1",
"title": "RivetKit API"
},
"components": {
Expand Down Expand Up @@ -387,6 +387,283 @@
}
}
}
},
"/gateway/{actorId}/health": {
"get": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
}
],
"responses": {
"200": {
"description": "Health check",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/gateway/{actorId}/action/{action}": {
"post": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "action",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The name of the action to execute"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"args": {}
},
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Action executed successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"output": {}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid action"
},
"500": {
"description": "Internal error"
}
}
}
},
"/gateway/{actorId}/request/{path}": {
"get": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"post": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"put": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"delete": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"patch": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"head": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
},
"options": {
"parameters": [
{
"name": "actorId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the actor to target"
},
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The HTTP path to forward to the actor"
}
],
"responses": {
"200": {
"description": "Response from actor's raw HTTP handler"
}
}
}
}
}
}
Loading
Loading