philsturgeon

{
  "name": "Example API",
  "type": "Index",
  "description": "This is an example APIs.json file, demonstrating what is possible with the API discovery specification.",
  "image": "https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg",
  "tags": [
    "Application Programming Interface",
    "API"
  ],
  "created": "2014-04-07",

philsturgeon

rules:
  cache-control-undocumented:
    description: |-
      Cache usage MUST be extensively detailed in the `description` property
      to avoid data leaks or the usage of stale data.
      
      This rule should ensure in some way that the api provider
      documented extensively the cache usage to avoid data leaks
      or usage of stale data.
      

philsturgeon

swagger: '2.0'
schemes:
  - https
host: api.giphy.com
basePath: /v1
info:
  contact:
    email: [email protected]
  description: Giphy API phantom change
  termsOfService: 'https://developers.giphy.com/'

philsturgeon

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here offset.earth/treeware

Read more about Treeware at treeware.earth

philsturgeon

{"lastUpload":"2020-05-29T11:26:30.695Z","extensionVersion":"v3.4.3"}

philsturgeon

API Specs & Docs

Style Guide

A lot of this information has been used to create linting rules for [Speccy], so just run the linter with --rules=strict for advice. It will be updated over time, as new rules are created.

File Structure

OpenAPI supports JSON Pointer via $ref keys, even when you’re writing in YAML. Swagger.io has a great guide for $ref and JSON Pointer.

philsturgeon

source 'https://rubygems.org'

gem 'faraday'
gem 'net-http-persistent'
gem 'typhoeus'
gem 'patron'
gem 'httpclient'
gem 'net-http2'

philsturgeon

Hey, I’m super lost.

Currently im trying to make API Flow work:

luckymarmot/API-Flow#149

There is an output.json which is a test case, and accoring to Postmans JSON Schema it is invalid.

I'm fixing a few (headers cannot have a null value) but the auth section is triggering errors. It looks like this:

philsturgeon

class Api::V3::CompanyPresenter
  attr_accessor :company, :includes

  def initialize(company, includes: [])
    @company = company
    @includes = Array(includes)
  end

  def as_json
    {

philsturgeon

POST /check-v1

Request

{
  "user_uuid" : "12345",
  "policy_action" : "do-a-thing"
}