Docs menu
On this page

Type reference

Built-in types: compute

Last updated

Services, workers, functions and the platforms they run on. They list statuses and headers but no operations, so their requests are named freely. Generated from compute.proschi; component types explains how to read and extend them.

Compute #

Code you run: a service, a worker, a function or the platform it runs on; its own requests are named freely.

  • Abstract. A node uses a type that extends it.
  • Extends: Component
  • Extended by: Service, Worker, Platform, Function
  • Kind: service
  • Protocol: HTTP
  • Statuses: 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511
  • Headers: Accept, Accept-Encoding, Accept-Language, Accept-Ranges, Age, Allow, Authorization, Cache-Control, Connection, Content-Disposition, Content-Encoding, Content-Language, Content-Length, Content-Range, Content-Type, Cookie, Date, ETag, Expires, Host, If-Match, If-Modified-Since, If-None-Match, If-Range, If-Unmodified-Since, Last-Modified, Link, Location, Origin, Range, Referer, Retry-After, Server, Set-Cookie, User-Agent, Vary, Upgrade, WWW-Authenticate, Proxy-Authorization, Strict-Transport-Security, Content-Security-Policy, Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers, Access-Control-Allow-Credentials, Access-Control-Max-Age, Access-Control-Request-Method, Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Proto, X-Real-IP, X-Request-Id, X-Correlation-Id, Traceparent, Tracestate, Idempotency-Key, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, X-API-Key, X-Content-Type-Options, X-Frame-Options, Sec-WebSocket-Key, Sec-WebSocket-Accept, Sec-WebSocket-Protocol

Service #

A program you run that answers requests, whatever it is written in.

Worker #

A background program that takes jobs or events from a queue and processes them.

HTTP Service #

A service whose requests are HTTP methods: GET, HEAD and OPTIONS read, POST, PUT, PATCH and DELETE write.

  • Abstract. A node uses a type that extends it.
  • Extends: Service › Compute › Component
  • Extended by: REST API, GraphQL
  • Kind: service
  • Protocol: HTTP
  • Icon: Service
  • Read: GET, HEAD, OPTIONS, TRACE, CONNECT
  • Write: POST, PUT, PATCH, DELETE
  • Statuses: 61 from Compute
  • Headers: 69 from Compute

REST API #

A service with a REST interface: resources over HTTP methods and status codes.

GraphQL #

A service with a GraphQL interface: queries read, mutations write.

gRPC #

A service with a gRPC interface: typed calls over HTTP/2, named by its own .proto file.

WebSocket #

A service that keeps a WebSocket open to each client and pushes messages both ways, named freely.

SOAP API #

A service with a SOAP interface: XML messages over HTTP.

Java #

A service on the JVM, written in Java.

Spring Boot #

A service built with Spring Boot.

Kotlin #

A service written in Kotlin.

Go #

A service written in Go.

Node.js #

A service on Node.js, written in JavaScript or TypeScript.

Python #

A service written in Python.

Django #

A service built with Django.

FastAPI #

A service built with FastAPI.

Flask #

A service built with Flask.

Ruby on Rails #

A service built with Ruby on Rails.

.NET #

A service on .NET, written in C#.

PHP #

A service written in PHP.

Rust #

A service written in Rust.

Elixir #

A service written in Elixir, on the Erlang VM.

Platform #

Where a service runs, drawn as the platform: it answers like the service on it.

VM #

A virtual machine running the service.

Docker #

A container running the service.

Kubernetes #

Pods on a Kubernetes cluster running the service.

Function #

A serverless function: runs per request or event and scales to zero.

Edit this page on GitHub