Skip to content

chore(rivetkit): add actor router to the openapi spec #3441

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

Open
wants to merge 1 commit into
base: 11-10-fix_rivetkit_skip_sending_rivetkit_messages_to_conns_that_do_not_support_it
Choose a base branch
from
+469 −3
Open

chore(rivetkit): add actor router to the openapi spec #3441

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
331 changes: 331 additions & 0 deletions rivetkit-openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,337 @@
}
}
}
},
"/actors/names": {
"get": {
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "namespace",
"in": "query"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"names": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": {
"nullable": true
}
}
},
"required": [
"metadata"
]
}
}
},
"required": [
"names"
]
}
}
}
},
"400": {
"description": "User error"
},
"500": {
"description": "Internal error"
}
}
}
},
"/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