raptor

module
v0.0.0-...-8396750 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 14, 2024 License: Apache-2.0

README

Raptor

Build, Deploy, and Run your applications on the edge.

Installation

Work in progress and rough on the edges. Documentation on how to install and run Raptor on your own machines is in the making.

API Server Endpoints

/status

Get server status

  • Method: GET
  • Response Content-Type: application/json

Request Body: empty

Example Response:

{
  "status": "ok"
}

/endpoint/<id>

Get Endpoint by ID

  • Method: GET

  • Response Content-Type: application/json

  • Request Body: empty

Example Response:

{
  "id": "09248ef6-c401-4601-8928-5964d61f2c61",
  "name": "My first run app",
  "url": "http://0.0.0.0:4000/09248ef6-c401-4601-8928-5964d61f2c61",
  "active_deploy_id": "aeacab67-91d6-45c1-ae29-f27922b0fcf0",
  "deploy_history": [
    {
      "id": "aeacab67-91d6-45c1-ae29-f27922b0fcf0",
      "endpoint_id": "09248ef6-c401-4601-8928-5964d61f2c61",
      "hash": "c4dd6753109e47b317a4fc792d231b64",
      "created_at": "2023-12-29T12:19:20.594726Z"
    }
  ],
  "created_at": "2023-12-29T12:19:20.574321Z"
}

/endpoint

Create a new endpoint

  • Method: POST
  • Request Content-Type: application/json
  • Response Content-Type: application/json

Example Request Body:

{
  "name": "my-endpoint"
}

Example Response Body:

{
  "id": "2488b7be-e3d3-4e4c-8f79-13d9d568483d",
  "name": "my-endpoint",
  "url": "http://0.0.0.0:4000/2488b7be-e3d3-4e4c-8f79-13d9d568483d",
  "active_deploy_id": "00000000-0000-0000-0000-000000000000",
  "deploy_history": [],
  "created_at": "2023-12-29T12:08:20.542039Z"
}

/endpoint/<id>/deploy

Deploy Wasm Blob to Endpoint

  • Method: POST
  • Request Content-Type: application/octet-stream
  • Response Content-Type: application/json

Request Body: WASM file

Example Response:

{
  "id": "e2a1ceea-d19e-4231-adc9-995ac61bdaf0",
  "endpoint_id": "2488b7be-e3d3-4e4c-8f79-13d9d568483d",
  "hash": "75b196bcd44611d9f74d62ed16a54e03",
  "created_at": "2023-12-29T12:12:39.91252Z"
}

Wasm Server Endpoints

/<endpoint-id>

Call the Wasm function

  • Method: ALL
  • Request Content-Type: any
  • Response Content-Type: any

Request Body: any (passed to function)

Response Body: any (returned from function)

Directories

Path Synopsis
cmd
api
cli
examples
go
internal
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL