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

Look for stuff on GitHub.

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

7 operations 7 paths 23 schemas 7 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 Search 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 7

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

Search 7

Look for stuff on GitHub.

GET
/search/code
APIs.io Engineering Platform Search code
search/code 5 params → 200304503422403
GET
/search/commits
APIs.io Engineering Platform Search commits
search/commits 5 params → 200304
GET
/search/issues
APIs.io Engineering Platform Search issues and pull requests
search/issues-and-pull-requests 5 params → 200503422304403
GET
/search/labels
APIs.io Engineering Platform Search labels
search/labels 6 params → 200304404403422
GET
/search/repositories
APIs.io Engineering Platform Search repositories
search/repos 5 params → 200503422304
GET
/search/topics
APIs.io Engineering Platform Search topics
search/topics 3 params → 200304
GET
/search/users
APIs.io Engineering Platform Search users
search/users 5 params → 200304503422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), repo-search-result-item (89 properties), minimal-repository (87 properties), issue-search-result-item (35 properties). Each schema is shown below with its type and property counts.

nullable-simple-user
object
A GitHub user.
21 properties 18 required
commit-search-result-item
object
Commit Search Result Item
12 properties 11 required
search-result-text-matches
array
topic-search-result-item
object
Topic Search Result Item
16 properties 11 required
nullable-integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
repository
object
A repository on GitHub.
95 properties 73 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
nullable-milestone
object
A collection of related issues and pull requests.
16 properties 16 required
issue-search-result-item
object
Issue Search Result Item
35 properties 22 required
basic-error
object
Basic Error
4 properties
reaction-rollup
object
10 properties 10 required
validation-error
object
Validation Error
3 properties 2 required
simple-user
object
A GitHub user.
21 properties 18 required
user-search-result-item
object
User Search Result Item
34 properties 19 required
minimal-repository
object
Minimal Repository
87 properties 46 required
label-search-result-item
object
Label Search Result Item
9 properties 8 required
verification
object
4 properties 4 required
nullable-license-simple
object
License Simple
6 properties 5 required
author-association
string
How the author is associated with the repository.
security-and-analysis
object
3 properties
code-search-result-item
object
Code Search Result Item
13 properties 8 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
repo-search-result-item
object
Repo Search Result Item
89 properties 74 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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