Manage OpenAPI via GitHub Demo website screenshot

Manage OpenAPI via GitHub Demo

This is a demo repository showing how GitHub can be used to manage an API contract using an APIs.json index plus an OpenAPI definition and supporting artifacts. The API used in the demo is the APIs.io Search API, which exposes search and submission endpoints over the APIs.io index. The repository is referenced by an API Evangelist blog post on managing OpenAPI in GitHub.

Manage OpenAPI via GitHub Demo publishes 2 APIs on the APIs.io network: APIs API and Search API. Tagged areas include APIs.json, Demo, GitHub, OpenAPI, and Reference.

The Manage OpenAPI via GitHub Demo catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

41.8/100 thin ▬ flat Agent 26/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemium
2 APIs
APIs.jsonDemoGitHubOpenAPIReferenceSearch

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 41.8/100 · thin
Contract Quality 16.7 / 25
Developer Ergonomics 0.0 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.1 / 13
Governance 6.3 / 12
Discoverability 6.9 / 10
Agent readiness — 26/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 0 / 10
MCP Server 0 / 12
Machine-Readable Auth 0 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/demo-openapi: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 2

Individual APIs this provider publishes, each with its own machine-readable definition.

Manage OpenAPI via GitHub Demo APIs API

Index of HTTP application programming interfaces.

Manage OpenAPI via GitHub Demo Search API

Search using a cloud search engine.

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Demo Openapi Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Demo Openapi Context

2 classes · 7 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Manage OpenAPI via GitHub Demo API Rules

5 rules · 1 errors 4 warnings

SPECTRAL

Security Posture 1

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Resources

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

Access & Security 1

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Company 1

The organization behind the API

Other 3

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: demo-openapi
name: Manage OpenAPI via GitHub Demo
url: https://raw.githubusercontent.com/api-evangelist/demo-openapi/refs/heads/main/apis.yml
kind: contract
accessModel:
  pricing: freemium
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Freemium
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
position: Producer
access: 1st-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/demo-openapi.png
tags:
- APIs.json
- Demo
- GitHub
- OpenAPI
- Reference
- Search
created: '2024-10-31'
modified: '2026-04-28'
specificationVersion: '0.19'
description: This is a demo repository showing how GitHub can be used to manage an API contract using an APIs.json index plus
  an OpenAPI definition and supporting artifacts. The API used in the demo is the APIs.io Search API, which exposes search
  and submission endpoints over the APIs.io index. The repository is referenced by an API Evangelist blog post on managing
  OpenAPI in GitHub.
apis:
- aid: demo-openapi:demo-openapi-apis-api
  name: Manage OpenAPI via GitHub Demo APIs API
  description: Index of HTTP application programming interfaces.
  humanURL: https://developer.apis.io/documentation/
  baseURL: https://search-api.apis.io/
  tags:
  - APIs
  properties:
  - type: OpenAPI
    url: openapi/demo-openapi-apis-api-openapi.yml
  - type: Documentation
    url: https://developer.apis.io/documentation/
  - type: OpenAPIReview
    url: openapi/openapi-review.yml
  - type: Rules
    url: rules/apis-io-search-api-rules.yml
  - type: Capabilities
    url: capabilities/apis-io-search-api-capabilities.yml
  - type: Teams
    url: common/team.yml
  - type: UseCases
    url: common/use-cases.yml
- aid: demo-openapi:demo-openapi-search-api
  name: Manage OpenAPI via GitHub Demo Search API
  description: Search using a cloud search engine.
  humanURL: https://developer.apis.io/documentation/
  baseURL: https://search-api.apis.io/
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/demo-openapi-search-api-openapi.yml
  - type: Documentation
    url: https://developer.apis.io/documentation/
  - type: OpenAPIReview
    url: openapi/openapi-review.yml
  - type: Rules
    url: rules/apis-io-search-api-rules.yml
  - type: Capabilities
    url: capabilities/apis-io-search-api-capabilities.yml
  - type: Teams
    url: common/team.yml
  - type: UseCases
    url: common/use-cases.yml
common:
- type: DomainSecurity
  url: security/demo-openapi-domain-security.yml
- type: BlogPost
  url: https://github.com/api-evangelist/demo-openapi
- type: CanonicalRepo
  url: https://github.com/api-evangelist/search-api
- type: APIsIo
  url: https://apis.io
- type: Developer
  url: https://developer.apis.io
- type: SupportEmail
  url: mailto:kin@apievangelist.com
- type: Vocabulary
  url: vocabulary/demo-openapi-vocabulary.yml
- type: JSONLD
  url: json-ld/demo-openapi-context.jsonld
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com