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 Schema API

The **Schema** endpoints enable you to manage your API definitions. These endpoints also support multi-file schema.

This API exposes 6 operations across 4 paths, and defines 11 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.

6 operations 4 paths 11 schemas 1 DELETE3 GET1 POST1 PUT

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 Schema 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 6

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

Schema 6

The Schema endpoints enable you to manage your API definitions. These endpoints also support multi-file schema.

POST
/apis/{apiId}/schemas
APIs.io Engineering Platform Create a schema
createApiSchema 2 params body → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}
APIs.io Engineering Platform Get a schema
getApiSchema 5 params → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}/files
APIs.io Engineering Platform Get schema files
getApiSchemaFiles 6 params → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
APIs.io Engineering Platform Get schema file contents
getApiSchemaFileContents 5 params → 200400401403404422500
PUT
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
APIs.io Engineering Platform Create or update a schema file
createUpdateApiSchemaFile 4 params body → 200400401403404422500
DELETE
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
APIs.io Engineering Platform Delete a schema file
deleteApiSchemaFile 4 params → 204400401403404422500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are featureUnavailable403Error (4 properties), api403ErrorForbidden (3 properties), apiSchema400ErrorNotLinked (3 properties), apiSchema404ErrorNotFound (3 properties). Each schema is shown below with its type and property counts.

apiSchema400ErrorNotLinked
object
3 properties
v10HeaderMissing
object
2 properties
api404ErrorInstanceNotFound
object
3 properties
apiVersionId
string
featureUnavailable403Error
object
4 properties
limit
integer
apiSchema403ErrorForbidden
object
3 properties
apiSchema404ErrorNotFound
object
3 properties
cursor
string
api403ErrorForbidden
object
3 properties
apiSchema400ErrorInvalidParams
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-schema-api-openapi.yml Raw ↑