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 Dependency-Graph API

Endpoints to access Dependency Graph features.

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

3 operations 3 paths 7 schemas 2 GET1 POST

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 Dependency-Graph 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 3

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

Dependency-Graph 3

Endpoints to access Dependency Graph features.

GET
/repos/{owner}/{repo}/dependency-graph/compare/{basehead}
APIs.io Engineering Platform Get a diff of the dependencies between commits
dependency-graph/diff-range 4 params → 200404403
GET
/repos/{owner}/{repo}/dependency-graph/sbom
APIs.io Engineering Platform Export a software bill of materials (SBOM) for a repository.
dependency-graph/export-sbom 2 params → 200404403
POST
/repos/{owner}/{repo}/dependency-graph/snapshots
APIs.io Engineering Platform Create a snapshot of dependencies for a repository
dependency-graph/create-repository-snapshot 2 params body → 201

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are snapshot (8 properties), dependency (5 properties), basic-error (4 properties), manifest (4 properties). Each schema is shown below with its type and property counts.

manifest
object
4 properties 1 required
basic-error
object
Basic Error
4 properties
metadata
object
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
dependency-graph-spdx-sbom
object
A schema for the SPDX JSON format returned by the Dependency Graph.
1 property 1 required
dependency
object
5 properties
snapshot
object
Create a new snapshot of a repository's dependencies.
8 properties 6 required
dependency-graph-diff
array
A diff of the dependencies between two commits.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-dependency-graph-api-openapi.yml Raw ↑