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

The **Comments** endpoints enable you to manage comments on an API element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/discussing-your-work/) to collaborate and discuss your work with your teammates in Postman.

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

21 operations 11 paths 6 schemas 5 DELETE5 GET6 POST5 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 Comments 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 21

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

Comments 21

The Comments endpoints enable you to manage comments on an API element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/di…

GET
/apis/{apiId}/comments
APIs.io Engineering Platform Get an API's comments
getApiComments 1 param → 200400401403404500
POST
/apis/{apiId}/comments
APIs.io Engineering Platform Create an API comment
createApiComment 1 param body → 201400401403404500
PUT
/apis/{apiId}/comments/{commentId}
APIs.io Engineering Platform Update an API's comment
updateApiComment 2 params body → 200400401403404500
DELETE
/apis/{apiId}/comments/{commentId}
APIs.io Engineering Platform Delete an API's comment
deleteApiComment 2 params → 204400401403404500
GET
/collections/{collectionId}/comments
APIs.io Engineering Platform Get a collection's comments
getCollectionComments 1 param → 200401403404500
POST
/collections/{collectionId}/comments
APIs.io Engineering Platform Create a collection comment
createCollectionComment 1 param body → 201401403404500
PUT
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Update a collection's comment
updateCollectionComment 2 params body → 200401403404500
DELETE
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Delete a collection's comment
deleteCollectionComment 2 params → 204401403404500
GET
/collections/{collectionId}/folders/{folderId}/comments
APIs.io Engineering Platform Get a folder's comments
getFolderComments 2 params → 200401403404500
POST
/collections/{collectionId}/folders/{folderId}/comments
APIs.io Engineering Platform Create a folder comment
createFolderComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/folders/{folderId}/comments/{commentId}
APIs.io Engineering Platform Update a folder's comment
updateFolderComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/folders/{folderId}/comments/{commentId}
APIs.io Engineering Platform Delete a folder's comment
deleteFolderComment 3 params → 204401403404500
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}/responses/{responseId}/comments
APIs.io Engineering Platform Get a response's comments
getResponseComments 2 params → 200401403404500
POST
/collections/{collectionId}/responses/{responseId}/comments
APIs.io Engineering Platform Create a response comment
createResponseComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/responses/{responseId}/comments/{commentId}
APIs.io Engineering Platform Update a response's comment
updateResponseComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/responses/{responseId}/comments/{commentId}
APIs.io Engineering Platform Delete a response's comment
deleteResponseComment 3 params → 204401403404500
POST
/comments-resolutions/{threadId}
APIs.io Engineering Platform Resolve a comment thread
resolveCommentThread 1 param → 204401404500

Schemas 6

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

commentCreateUpdate
object
Information about the comment.
2 properties 1 required
commentResponse
object
1 property
comment403Error
object
4 properties
v10HeaderMissing
object
2 properties
commentCreatedUpdated
object
1 property
featureUnavailable403Error
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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