# API Commons — Starter APIs.json
#
# The smallest APIs.json document that validates: one index, one API, and the
# properties a consumer actually needs to find their way in.
#
# APIs.json is the discovery layer. The OpenAPI describes ONE API's surface;
# this describes where an API lives, who runs it, and which artifacts exist
# alongside it — documentation, a portal, a changelog, a license.
#
# Written against specificationVersion 0.22 and validated against
# https://github.com/apis-json/api-json — see README.md.
#
# https://apisjson.org

aid: apis.json
name: Example API
type: Index
description: |-
  An example APIs.json index, demonstrating what is possible with the API
  discovery specification. Replace this with a description of your organization
  and the APIs it publishes.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
- Application Programming Interface
- API
created: '2026-08-17'
modified: '2026-08-17'
url: https://example.com/apis.yml
specificationVersion: '0.22'

apis:

- aid: apis.json:example-api
  name: Example API
  description: >-
    Details about a specific API, telling a consumer what is possible with it.
    One entry per API; add as many as you publish.
  image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
  humanURL: https://example.com
  baseURL: https://api.example.com
  tags:
  - API
  - Application Programming Interface
  properties:
  # The properties are the point. Each one is a machine-readable pointer to a
  # thing a consumer or an agent would otherwise have to go hunting for.
  # The full vocabulary lives at https://apicommons.org/common/
  - type: OpenAPI
    url: https://example.com/openapi.yml
  - type: Documentation
    url: https://example.com/docs
  - type: Portal
    url: https://example.com/developers
  - type: GettingStarted
    url: https://example.com/docs/getting-started
  - type: Authentication
    url: https://example.com/docs/authentication
  - type: ChangeLog
    url: https://example.com/changelog
  - type: StatusPage
    url: https://status.example.com
  - type: TermsOfService
    url: https://example.com/terms
  contact:
  - FN: Example
    email: support@example.com

common:
# Properties that apply to every API in this index, so you do not repeat them.
- type: Portal
  url: https://example.com/developers
- type: TermsOfService
  url: https://example.com/terms
- type: PrivacyPolicy
  url: https://example.com/privacy

include:
# Point at other APIs.json indexes to compose a network out of them.
- name: Another Example Index
  url: https://another.example.com/apis.yml

maintainers:
- FN: Example
  email: info@example.com