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

The Sdktypes API from APIs.io Engineering Platform — 2 operation(s) for sdktypes.

This API exposes 2 operations across 2 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.

2 operations 2 paths 11 schemas 2 GET

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 Sdktypes 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 2

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

Sdktypes 2
GET
/sdktypes/{sdktype_id}
Gets an SDK type.
GetSdkType 8 params → 200480481482483
GET
/sdktypes
Gets SDK types
GetSdkTypes 9 params → 200480481482483

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SdkConfigurationProperty (5 properties), SdkType (4 properties), SdkTypes (2 properties). Each schema is shown below with its type and property counts.

Boolean
boolean
String
string
ListOfSdkConfigurationProperty
array
NotFoundException
TooManyRequestsException
BadRequestException
ListOfSdkType
array
UnauthorizedException
SdkTypes
object
The collection of SdkType instances.
2 properties
SdkType
object
A type of SDK that API Gateway can generate.
4 properties
SdkConfigurationProperty
object
A configuration property of an SDK type.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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