Skip to content

Instantly share code, notes, and snippets.

View kinlane's full-sized avatar

Kin Lane kinlane

View GitHub Profile
@kinlane
kinlane / sign-up-login-keys.yml
Created October 21, 2024 16:02
Signup Login and Keys
- type: Sign-Up
url: 'https://developer.apis.io/signup/'
- type: Login
url: 'https://developer.apis.io/login/'
- type: Keys
url: 'https://developer.apis.io/keys/'
@kinlane
kinlane / plans-human-readable.yml
Created October 21, 2024 16:01
Plans - Human
- type: Plans
url: 'https://developer.apis.io/plans/'
@kinlane
kinlane / plans.yml
Created October 21, 2024 15:54
Plans
- id: starter
name: Starter
description: The default API access plan, where every new account begins, allowing the consumer to kick the tires, and see what the API is all about.
entries:
- label: API calls
description: to the search API
metric: calls
limit: 25
timeFrame: day
geo: US
@kinlane
kinlane / json-api-openapi.yml
Created October 10, 2024 17:02
JSON:API OpenAPI
openapi: 3.0.0
info:
title: JSON:API OpenAPI
description: A base OpenAPI for the JSON:API to be used as seed for new APIs.
version: 1.0.0
tags:
- name: Resources
description: An array of JSON:API resources.
@kinlane
kinlane / json-api-json-schema.json
Last active October 10, 2024 18:38
JSON:API JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "JSON:API JSON Schema",
"description": "This is a JSON Schema for responses in the JSON:API format. For more, see http://jsonapi.org.",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
@kinlane
kinlane / api-commons-snack-for-ai-send-twilio-message.yml
Last active September 27, 2024 18:01
API Commons API Snack for AI - Send Twilio Message
aid: api-commons
name: API Commons API Snack for AI - Send Twilio Message
type: Snack
description: |-
This is an API Commons Snack for artificial intelligence, providing a single API-powered capability that can be used via artificial intelligence applications.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
- Twilio
- Messages
created: '2024-09-27'
@kinlane
kinlane / problem-details-for-http-apis
Created September 27, 2024 13:27
Problem Details for HTTP APIs
openapi: 3.1.0
info:
title: Problem Details for HTTP APIs
description: |
This is a base OpenAPI for the Problem Details for HTTP APIs, as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs. This was originally developed by Bump.sh as part of their [Train Travel API template](https://bump.sh/bump-examples/doc/train-travel-api), but reduced here to provide a base just for showcasing Problem Details for HTTP APIs.
version: 1.0.0
contact:
name: API Evangelist
url: https://apievangelist.com
email: [email protected]
@kinlane
kinlane / apis-io-engineering-api-platform.yaml
Created September 23, 2024 19:07
APIs.io Engineering API Platform
aid: apis-io-engineering-platform
name: APIs.io Engineering Platform
type: Platform
description: |-
This is an index of all of the infrastructure and services used to operate the engineering side of APIs.io, providing a single manifest of all the 3rd-party suppliers we depend on for digital resources and capabilities.<br><br>The goal of this engineering platform definition is to define the platform in a way that can be federated and distributed as part of API operations, helping educate teams where they can access platform resources.
tags:
- APIs.io
- Engineering
- Platform
created: '2024-09-06'
@kinlane
kinlane / api-commons-train-travel-openapi-spectral-rules.yaml
Created August 5, 2024 19:18
api-commons-train-travel-openapi-spectral-rules
rules:
openapi-openapi-version-310-info:
description: Has latest version of OpenAPI.
message: 3.1.0 Version of OpenAPI
severity: info
given: $
then:
field: openapi
function: pattern
functionOptions:
@kinlane
kinlane / api-commons-train-travel-openapi-spectral-rules.yaml
Last active August 5, 2024 19:20
api-commons-train-travel-openapi-spectral-rules
rules:
apis-json-name-negative:
description: Name of APIs.json
message: There MUST be a name.
severity: error
given: $
then:
field: name
function: truthy
apis-json-name-positive: