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

These endpoints enable you to manage your [pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/) in Postman. Pull requests allow reviewers to look at your changes. Reviewers can make comments on your changes and will decide whether to approve them and merge them into the parent element.

This API exposes 5 operations across 3 paths, and defines 9 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.

5 operations 3 paths 9 schemas 2 GET2 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 Pull 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 5

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

Pull Requests 5

These endpoints enable you to manage your [pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/) in Postman. Pul…

GET
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Get a collection's pull requests
getCollectionPullRequests 1 param → 200403500
POST
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Create a pull request
createCollectionPullRequest 1 param body → 200400403500
GET
/pull-requests/{pullRequestId}
APIs.io Engineering Platform Get a pull request
getPullRequest 1 param → 200403500
PUT
/pull-requests/{pullRequestId}
APIs.io Engineering Platform Update a pull request
updatePullRequest 1 param body → 200403409500
POST
/pull-requests/{pullRequestId}/tasks
APIs.io Engineering Platform Review a pull request
reviewPullRequest 1 param body → 200400403500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are pullRequestGet (14 properties), pullRequestUpdated (10 properties), pullRequestReview400ErrorActionNotAllowed (4 properties), pullRequest403ErrorRolePermissionsCollection (4 properties). Each schema is shown below with its type and property counts.

pullRequest403ErrorNoViewerAccessCollections
object
4 properties
pullRequestReview400ErrorInvalidAction
object
4 properties
forkCollection400ErrorBadForkRelation
object
4 properties
pullRequest400ErrorDuplicate
object
4 properties
pullRequest403ErrorForbidden
object
4 properties
pullRequestUpdated
object
10 properties
pullRequest403ErrorRolePermissionsCollection
object
4 properties
pullRequestReview400ErrorActionNotAllowed
object
4 properties
pullRequestGet
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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