Skip to content

Commit 7626976

Browse files
committed
docs: update docs (#3534)
1 parent fac923f commit 7626976

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+3991
-3878
lines changed

Cargo.lock

Lines changed: 47 additions & 47 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -119,17 +119,17 @@ Deploy Rivet Actors anywhere - from serverless platforms to your own infrastruct
119119
- [Node.js](https://www.rivet.dev/docs/actors/quickstart/backend)
120120
- [Bun](https://www.rivet.dev/docs/actors/quickstart/backend)
121121
- [Deno](https://github.com/rivet-dev/rivetkit/tree/9a3d850aee45167eadf249fdbae60129bf37e818/examples/deno)
122-
- [Vercel](https://www.rivet.dev/docs/deploy/vercel) *(1-Click Deploy)*
122+
- [Vercel](https://www.rivet.dev/docs/connect/vercel) *(1-Click Deploy)*
123123
- [Railway](https://railway.com/deploy/rivet) *(1-Click Deploy)*
124124
- [Durable Objects](https://www.rivet.dev/docs/actors/quickstart/backend)
125-
- [Kubernetes](https://www.rivet.dev/docs/deploy/kubernetes)
126-
- [AWS ECS](https://www.rivet.dev/docs/deploy/aws-ecs)
127-
- [Google Cloud Run](https://www.rivet.dev/docs/deploy/gcp-cloud-run)
128-
- [Hetzner](https://www.rivet.dev/docs/deploy/hetzner)
129-
- [VM & Bare Metal](https://www.rivet.dev/docs/deploy/vm-and-bare-metal)
130-
- [AWS Lambda](https://www.rivet.dev/docs/deploy/aws-lambda) *(On The Roadmap)*
131-
- [Supabase](https://www.rivet.dev/docs/deploy/supabase) *(On The Roadmap)*
132-
- [Freestyle](https://www.rivet.dev/docs/deploy/freestyle) *(On The Roadmap)*
125+
- [Kubernetes](https://www.rivet.dev/docs/connect/kubernetes)
126+
- [AWS ECS](https://www.rivet.dev/docs/connect/aws-ecs)
127+
- [Google Cloud Run](https://www.rivet.dev/docs/connect/gcp-cloud-run)
128+
- [Hetzner](https://www.rivet.dev/docs/connect/hetzner)
129+
- [VM & Bare Metal](https://www.rivet.dev/docs/connect/vm-and-bare-metal)
130+
- [AWS Lambda](https://www.rivet.dev/docs/connect/aws-lambda) *(On The Roadmap)*
131+
- [Supabase](https://www.rivet.dev/docs/connect/supabase) *(On The Roadmap)*
132+
- [Freestyle](https://www.rivet.dev/docs/connect/freestyle) *(On The Roadmap)*
133133

134134
## Works With Your Tools
135135

engine/artifacts/openapi.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

frontend/src/app/dialogs/connect-manual-serverfull-frame.tsx

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rivetkit-asyncapi/asyncapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"asyncapi": "3.0.0",
33
"info": {
44
"title": "RivetKit WebSocket Protocol",
5-
"version": "2.0.24",
5+
"version": "2.0.25-rc.1",
66
"description": "WebSocket protocol for bidirectional communication between RivetKit clients and actors"
77
},
88
"channels": {

rivetkit-openapi/openapi.json

Lines changed: 278 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.0",
33
"info": {
4-
"version": "2.0.24",
4+
"version": "2.0.25-rc.1",
55
"title": "RivetKit API"
66
},
77
"components": {
@@ -387,6 +387,283 @@
387387
}
388388
}
389389
}
390+
},
391+
"/gateway/{actorId}/health": {
392+
"get": {
393+
"parameters": [
394+
{
395+
"name": "actorId",
396+
"in": "path",
397+
"required": true,
398+
"schema": {
399+
"type": "string"
400+
},
401+
"description": "The ID of the actor to target"
402+
}
403+
],
404+
"responses": {
405+
"200": {
406+
"description": "Health check",
407+
"content": {
408+
"text/plain": {
409+
"schema": {
410+
"type": "string"
411+
}
412+
}
413+
}
414+
}
415+
}
416+
}
417+
},
418+
"/gateway/{actorId}/action/{action}": {
419+
"post": {
420+
"parameters": [
421+
{
422+
"name": "actorId",
423+
"in": "path",
424+
"required": true,
425+
"schema": {
426+
"type": "string"
427+
},
428+
"description": "The ID of the actor to target"
429+
},
430+
{
431+
"name": "action",
432+
"in": "path",
433+
"required": true,
434+
"schema": {
435+
"type": "string"
436+
},
437+
"description": "The name of the action to execute"
438+
}
439+
],
440+
"requestBody": {
441+
"content": {
442+
"application/json": {
443+
"schema": {
444+
"type": "object",
445+
"properties": {
446+
"args": {}
447+
},
448+
"additionalProperties": false
449+
}
450+
}
451+
}
452+
},
453+
"responses": {
454+
"200": {
455+
"description": "Action executed successfully",
456+
"content": {
457+
"application/json": {
458+
"schema": {
459+
"type": "object",
460+
"properties": {
461+
"output": {}
462+
},
463+
"additionalProperties": false
464+
}
465+
}
466+
}
467+
},
468+
"400": {
469+
"description": "Invalid action"
470+
},
471+
"500": {
472+
"description": "Internal error"
473+
}
474+
}
475+
}
476+
},
477+
"/gateway/{actorId}/request/{path}": {
478+
"get": {
479+
"parameters": [
480+
{
481+
"name": "actorId",
482+
"in": "path",
483+
"required": true,
484+
"schema": {
485+
"type": "string"
486+
},
487+
"description": "The ID of the actor to target"
488+
},
489+
{
490+
"name": "path",
491+
"in": "path",
492+
"required": true,
493+
"schema": {
494+
"type": "string"
495+
},
496+
"description": "The HTTP path to forward to the actor"
497+
}
498+
],
499+
"responses": {
500+
"200": {
501+
"description": "Response from actor's raw HTTP handler"
502+
}
503+
}
504+
},
505+
"post": {
506+
"parameters": [
507+
{
508+
"name": "actorId",
509+
"in": "path",
510+
"required": true,
511+
"schema": {
512+
"type": "string"
513+
},
514+
"description": "The ID of the actor to target"
515+
},
516+
{
517+
"name": "path",
518+
"in": "path",
519+
"required": true,
520+
"schema": {
521+
"type": "string"
522+
},
523+
"description": "The HTTP path to forward to the actor"
524+
}
525+
],
526+
"responses": {
527+
"200": {
528+
"description": "Response from actor's raw HTTP handler"
529+
}
530+
}
531+
},
532+
"put": {
533+
"parameters": [
534+
{
535+
"name": "actorId",
536+
"in": "path",
537+
"required": true,
538+
"schema": {
539+
"type": "string"
540+
},
541+
"description": "The ID of the actor to target"
542+
},
543+
{
544+
"name": "path",
545+
"in": "path",
546+
"required": true,
547+
"schema": {
548+
"type": "string"
549+
},
550+
"description": "The HTTP path to forward to the actor"
551+
}
552+
],
553+
"responses": {
554+
"200": {
555+
"description": "Response from actor's raw HTTP handler"
556+
}
557+
}
558+
},
559+
"delete": {
560+
"parameters": [
561+
{
562+
"name": "actorId",
563+
"in": "path",
564+
"required": true,
565+
"schema": {
566+
"type": "string"
567+
},
568+
"description": "The ID of the actor to target"
569+
},
570+
{
571+
"name": "path",
572+
"in": "path",
573+
"required": true,
574+
"schema": {
575+
"type": "string"
576+
},
577+
"description": "The HTTP path to forward to the actor"
578+
}
579+
],
580+
"responses": {
581+
"200": {
582+
"description": "Response from actor's raw HTTP handler"
583+
}
584+
}
585+
},
586+
"patch": {
587+
"parameters": [
588+
{
589+
"name": "actorId",
590+
"in": "path",
591+
"required": true,
592+
"schema": {
593+
"type": "string"
594+
},
595+
"description": "The ID of the actor to target"
596+
},
597+
{
598+
"name": "path",
599+
"in": "path",
600+
"required": true,
601+
"schema": {
602+
"type": "string"
603+
},
604+
"description": "The HTTP path to forward to the actor"
605+
}
606+
],
607+
"responses": {
608+
"200": {
609+
"description": "Response from actor's raw HTTP handler"
610+
}
611+
}
612+
},
613+
"head": {
614+
"parameters": [
615+
{
616+
"name": "actorId",
617+
"in": "path",
618+
"required": true,
619+
"schema": {
620+
"type": "string"
621+
},
622+
"description": "The ID of the actor to target"
623+
},
624+
{
625+
"name": "path",
626+
"in": "path",
627+
"required": true,
628+
"schema": {
629+
"type": "string"
630+
},
631+
"description": "The HTTP path to forward to the actor"
632+
}
633+
],
634+
"responses": {
635+
"200": {
636+
"description": "Response from actor's raw HTTP handler"
637+
}
638+
}
639+
},
640+
"options": {
641+
"parameters": [
642+
{
643+
"name": "actorId",
644+
"in": "path",
645+
"required": true,
646+
"schema": {
647+
"type": "string"
648+
},
649+
"description": "The ID of the actor to target"
650+
},
651+
{
652+
"name": "path",
653+
"in": "path",
654+
"required": true,
655+
"schema": {
656+
"type": "string"
657+
},
658+
"description": "The HTTP path to forward to the actor"
659+
}
660+
],
661+
"responses": {
662+
"200": {
663+
"description": "Response from actor's raw HTTP handler"
664+
}
665+
}
666+
}
390667
}
391668
}
392669
}

0 commit comments

Comments
 (0)