Skip to content

Instantly share code, notes, and snippets.

View earth2marsh's full-sized avatar

Marsh Gardiner earth2marsh

132 followers · 11 following
View GitHub Profile
@earth2marsh
earth2marsh / readme.md
Last active December 7, 2023 17:27
quick discussion points for applying moonwalk principles
  1. Separation of concerns: how deployments break out
  2. Inclusion: Start with the implications to the path-orientation of v3, and how we would identify functions. That sets us up to be able to describe more HTTP-based synchronous APIs.
  • then refer back to separation of concerns about disentangling schemas,
  • and how that creates space for formally describing other content types?
  1. Signatures: Go deeper into what it means to have a signature orientation that unblocks #2.
  2. Semantics: How that then leads to the semantics requirement where we enshrine the meaning and purpose ("what and the why") to the mechanics ("how").
@earth2marsh
earth2marsh / bar.json
Last active June 10, 2016 00:23
JSON References Example
{
"bar": 1,
"bish": {
"$ref": "./bish.json"
}
}
@earth2marsh
earth2marsh / swagger.json
Last active August 29, 2015 14:20
Self-describing Swagger YAML
{
"swagger": "2.0",
"info": {
"description": "info.description",
"version": "info.version",
"title": "info.title",
"termsOfService": "info.termsOfService",
"contact": {
"name": "info.contact.name",
"url": "info.contact.url",
@earth2marsh
earth2marsh / swagger.json
Last active August 29, 2015 14:09
Example of JSON pointers
{
"swagger": "2.0",
"info": {
"title": "Uber API",
"description": "Move your app forward with the Uber API",
"version": "1.0.0"
},
"host": "api.uber.com",
"schemes": [
"https"
@earth2marsh
earth2marsh / example.md
Last active August 29, 2015 14:06
Deckdown example

##My Name is B. Carlson Esquire

##Life as a Dog My life is incredibly challenging.

##Life as a Dog My humans sometimes feed me, but mostly they

let me wither away starve.

@earth2marsh
earth2marsh / definition.yaml
Created September 5, 2014 02:26
---
type: "object"
$schema: "http://json-schema.org/draft-03/schema"
id: "http://jsonschema.net"
required: false
properties:
base:
type: "string"
id: "http://jsonschema.net/base"
required: false
@earth2marsh
earth2marsh / pet schema snippet.json
Last active August 29, 2015 14:05
Simple JSON example for samples
{
"responses": {
"200": {
"description": "pet response",
"schema": {
"$ref": "Pet"
},
"examples": {
"sample": {
"request": 'GET /api/pet/1 HTTP/1.1\nHost: petstore.swagger.wordnik.com\nAccept: application/json\nContent-Type: application/json',
@earth2marsh
earth2marsh / uber.yaml
Last active April 5, 2021 13:39
A Swagger YAML specification for Uber's new API
swagger: 2
info:
title: The new Uber API
description: Move your app forward with the Uber API
version: "1.0.0"
host: api.uber.com
schemes:
- https
basePath: /v1
produces:
@earth2marsh
earth2marsh / swagger.yaml
Created July 26, 2014 02:46
Petstore Samples
swagger: 2.0
info:
version: 1.0.0
title: Swagger Petstore
host: petstore.swagger.wordnik.com
basePath: /v1
license:
name: MIT
schemes:
- http
@earth2marsh
earth2marsh / Sample Payloads.xml
Last active December 26, 2015 04:28
This is an example for how you define the primary tag (like a category), a public/private tag, a sample request payload, a simple html table describing the request payload elements, and a simple table describing the response payload elements. (We'll be adding sample responses in the near future!)
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:apigee="http://api.apigee.com/wadl/2010/07/" xmlns="http://wadl.dev.java.net/2009/02"xmlns:t="urn:simplegeo:simplegeoresponse"xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd">
<resources base="https://api.enterprise.apigee.com/v1">
<!-- API Proxy-->
<resource path="o/{org_name}/apis">
<param name="baseurl" type="xsd:string" style="template" required="true"default="api.enterprise.apigee.com">
<doc>The top-level domain of the API</doc>
</param>
<param name="version" type="xsd:string" style="template" required="true" default="v1">
<doc>The version of the API</doc>
</param>