Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Worker Versions API

The Worker Versions API from APIs.io Engineering Platform — 2 operation(s) for worker versions.

This API exposes 3 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

3 operations 2 paths 12 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Worker Versions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Worker Versions 3
GET
/accounts/{account_id}/workers/scripts/{script_name}/versions
APIs.io Engineering Platform List Versions
worker-versions-list-versions 5 params → 4XX200
POST
/accounts/{account_id}/workers/scripts/{script_name}/versions
APIs.io Engineering Platform Upload Version
worker-versions-upload-version 2 params body → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}
APIs.io Engineering Platform Get Version Detail
worker-versions-get-version-detail 3 params → 4XX200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are workers_api-response-common-failure (4 properties), workers_api-response-common (3 properties), workers_version-item-short (3 properties). Each schema is shown below with its type and property counts.

workers_version-item-short
object
3 properties
workers_version-item-full
workers_identifier
string
Identifier
workers_version_identifier
string
workers_version-item-uploaded
workers_versions-list-response
workers_versions-upload-response
workers_versions-single-response
workers_messages
array
workers_api-response-common
object
3 properties 3 required
workers_schemas-script_name
string
Name of the script.
workers_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-worker-versions-api-openapi.yml Raw ↑