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 Collection Requests API

The **Collection Requests** endpoints enable you to manage collection requests.

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

8 operations 4 paths 7 schemas 2 DELETE2 GET2 POST2 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 Collection Requests 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 8

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

Collection Requests 8

The Collection Requests endpoints enable you to manage collection requests.

POST
/collections/{collectionId}/requests
APIs.io Engineering Platform Create a request
createCollectionRequest 2 params body → 200400401500
GET
/collections/{collectionId}/requests/{requestId}/comments
APIs.io Engineering Platform Get a request's comments
getRequestComments 2 params → 200401403404500
POST
/collections/{collectionId}/requests/{requestId}/comments
APIs.io Engineering Platform Create a request comment
createRequestComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/requests/{requestId}/comments/{commentId}
APIs.io Engineering Platform Update a request's comment
updateRequestComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/requests/{requestId}/comments/{commentId}
APIs.io Engineering Platform Delete a request's comment
deleteRequestComment 3 params → 204401403404500
GET
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Get a request
getCollectionRequest 5 params → 200401404500
PUT
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Update a request
updateCollectionRequest 2 params body → 200400401404500
DELETE
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Delete a request
deleteCollectionRequest 2 params → 200401404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are comment403Error (4 properties), commentCreateUpdate (2 properties), commentCreatedUpdated (1 property), commentResponse (1 property). Each schema is shown below with its type and property counts.

collectionRequestId
string
commentCreateUpdate
object
Information about the comment.
2 properties 1 required
collectionFolderId
string
commentResponse
object
1 property
comment403Error
object
4 properties
commentCreatedUpdated
object
1 property
booleanQuery
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-collection-requests-api-openapi.yml Raw ↑