Skip to content

Instantly share code, notes, and snippets.

@taras
Last active September 3, 2019 19:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save taras/4d8ddd3bdd906e2b293ce58ee256062f to your computer and use it in GitHub Desktop.
Save taras/4d8ddd3bdd906e2b293ce58ee256062f to your computer and use it in GitHub Desktop.

URL: /companies

{
	"data": [
		{
			"id": "ABCDE",
			"type": "company",
			"attributes": {
				"name": "ABCDE Inc"
			},
			"relationships": {
				"users": [
					"data: {
						"id": "USER-1",
						"type": "user"
					},
					{
						"id": "USER-2",
						"type": "user"
					}
				]
			}
		}
	]
}

URL: /companies?include=users

{
	"data": [
		{
			"id": "JOHN-DEER-INC",
			"type": "company",
			"attributes": {
				"name": "John Deer Inc"
			},
			"relationships": {
				"users": {
                    "data": [
					{
						"id": "USER-1",
						"type": "user"
					},
					{
						"id": "USER-2",
						"type": "user"
					}
				]
                }
			}
		}
	],
	"included": [
		{
			"id": "USER-1",
			"type": "user",
			"attributes": {
				"name": "John Deer"
			},
			"relationships": {
				"company": {
					"id": "ABCDE",
					"type": "company"
				}
			}
		},
		{
			"id": "USER-2",
			"type": "user",
			"attributes": {
				"name": "John Deer"
			},
			"relationships": {
				"company": {
					"id": "ABCDE",
					"type": "company"
				}
			}
		}
	]
}

URL: /companies/${id}

{
	"data": {
		"id": "ABCDE",
		"type": "company",
		"attributes": {
			"name": "ABCDE Inc"
		},
		"relationships": {
			"users": {
                data: [
				{
					"id": "USER-1",
					"type": "user"
				},
				{
					"id": "USER-2",
					"type": "user"
				}
            ]
            }
		}
	}
}

URL: /companies/${id}?include=users

{
	"data": {
		"id": "JOHN-DEER-INC",
		"type": "company",
		"attributes": {
			"name": "John Deer Inc"
		},
		"relationships": {
			"users": [
				{
					"id": "USER-1",
					"type": "user"
				},
				{
					"id": "USER-2",
					"type": "user"
				}
			]
		}
	},
	"included": [
		{
			"id": "USER-1",
			"type": "user",
			"attributes": {
				"name": "John Deer"
			},
			"relationships": {
				"company": {
					"id": "ABCDE",
					"type": "company"
				}
			}
		},
		{
			"id": "USER-2",
			"type": "user",
			"attributes": {
				"name": "John Deer"
			},
			"relationships": {
				"company": {
					"id": "ABCDE",
					"type": "company"
				}
			}
		}
	]
}
{"swagger":"2.0","info":{"title":"Example JSON:API Server","version":"0.1.1","description":"This is the API description block that shows up in the swagger.json","termsOfService":"http://example.com/termsOfService","contact":{"name":"API Contact","email":"apicontact@holidayextras.com","url":"docs.hapi.holidayextras.com"},"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"}},"basePath":"/rest","schemes":["http"],"consumes":["application/vnd.api+json"],"produces":["application/vnd.api+json"],"parameters":{"sort":{"name":"sort","in":"query","description":"Sort resources as per the JSON:API specification","required":false,"type":"string"},"include":{"name":"include","in":"query","description":"Fetch additional resources as per the JSON:API specification","required":false,"type":"string"},"filter":{"name":"filter","in":"query","description":"Filter resources as per the JSON:API specification","required":false,"type":"string"},"fields":{"name":"fields","in":"query","description":"Limit response payloads as per the JSON:API specification","required":false,"type":"string"},"page":{"name":"page","in":"query","description":"Pagination namespace","required":false,"type":"string"}},"paths":{"/articles":{"get":{"tags":["articles"],"description":"Search for articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"articles search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/articles"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["articles"],"description":"Create a new instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/articles"}}}}],"responses":{"201":{"description":"articles create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/articles"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}":{"get":{"tags":["articles"],"description":"Get a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/articles"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["articles"],"description":"Delete an instance of articles","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["articles"],"description":"Update an instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/articles"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/articles"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/author":{"get":{"tags":["people"],"description":"Get the author instance of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/relationships/author":{"get":{"tags":["people","articles"],"description":"Get the author relationship of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["people","articles"],"description":"Create the author relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"people create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["people","articles"],"description":"Update the author relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["people","articles"],"description":"Delete the author relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/tags":{"get":{"tags":["tags"],"description":"Get the tags instances of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tags"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/relationships/tags":{"get":{"tags":["tags","articles"],"description":"Get the tags relationship of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["tags","articles"],"description":"Create the tags relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"tags create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["tags","articles"],"description":"Update the tags relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["tags","articles"],"description":"Delete the tags relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/photos":{"get":{"tags":["photos"],"description":"Get the photos instances of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/photos"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/relationships/photos":{"get":{"tags":["photos","articles"],"description":"Get the photos relationship of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["photos","articles"],"description":"Create the photos relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"photos create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["photos","articles"],"description":"Update the photos relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["photos","articles"],"description":"Delete the photos relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/comments":{"get":{"tags":["comments"],"description":"Get the comments instances of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/comments"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/articles/{id}/relationships/comments":{"get":{"tags":["comments","articles"],"description":"Get the comments relationship of a specific instance of articles","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["comments","articles"],"description":"Create the comments relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"comments create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["comments","articles"],"description":"Update the comments relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["comments","articles"],"description":"Delete the comments relationship of a specific instance of articles","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/autoincrement":{"get":{"tags":["autoincrement"],"description":"Search for autoincrement","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"autoincrement search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/autoincrement"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["autoincrement"],"description":"Create a new instance of autoincrement","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/autoincrement"}}}}],"responses":{"201":{"description":"autoincrement create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/autoincrement"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/autoincrement/{id}":{"get":{"tags":["autoincrement"],"description":"Get a specific instance of autoincrement","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"autoincrement find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/autoincrement"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["autoincrement"],"description":"Delete an instance of autoincrement","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"autoincrement delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["autoincrement"],"description":"Update an instance of autoincrement","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/autoincrement"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"autoincrement update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/autoincrement"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/brokenResponse":{"get":{"tags":["brokenResponse"],"description":"Search for brokenResponse","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"brokenResponse search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/brokenResponse"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["brokenResponse"],"description":"Create a new instance of brokenResponse","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/brokenResponse"}}}}],"responses":{"201":{"description":"brokenResponse create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/brokenResponse"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/brokenResponse/{id}":{"get":{"tags":["brokenResponse"],"description":"Get a specific instance of brokenResponse","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"brokenResponse find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/brokenResponse"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["brokenResponse"],"description":"Delete an instance of brokenResponse","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"brokenResponse delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["brokenResponse"],"description":"Update an instance of brokenResponse","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/brokenResponse"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"brokenResponse update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/brokenResponse"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/comments":{"get":{"tags":["comments"],"description":"Search for comments","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"comments search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/comments"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["comments"],"description":"Create a new instance of comments","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/comments"}}}}],"responses":{"201":{"description":"comments create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/comments"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/comments/{id}":{"get":{"tags":["comments"],"description":"Get a specific instance of comments","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/comments"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["comments"],"description":"Delete an instance of comments","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["comments"],"description":"Update an instance of comments","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/comments"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"comments update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/comments"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/comments/{id}/author":{"get":{"tags":["people"],"description":"Get the author instance of a specific instance of comments","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/comments/{id}/relationships/author":{"get":{"tags":["people","comments"],"description":"Get the author relationship of a specific instance of comments","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["people","comments"],"description":"Create the author relationship of a specific instance of comments","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"people create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["people","comments"],"description":"Update the author relationship of a specific instance of comments","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["people","comments"],"description":"Delete the author relationship of a specific instance of comments","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/people":{"get":{"tags":["people"],"description":"Search for people","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"people search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/people"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["people"],"description":"Create a new instance of people","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/people"}}}}],"responses":{"201":{"description":"people create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/people/{id}":{"get":{"tags":["people"],"description":"Get a specific instance of people","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["people"],"description":"Delete an instance of people","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["people"],"description":"Update an instance of people","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/people"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/photos":{"get":{"tags":["photos"],"description":"Search for photos","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"photos search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/photos"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["photos"],"description":"Create a new instance of photos","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/photos"}}}}],"responses":{"201":{"description":"photos create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/photos"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/photos/{id}":{"get":{"tags":["photos"],"description":"Get a specific instance of photos","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/photos"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["photos"],"description":"Update an instance of photos","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/photos"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"photos update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/photos"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/photos/{id}/photographer":{"get":{"tags":["people"],"description":"Get the photographer instance of a specific instance of photos","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/people"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/photos/{id}/relationships/photographer":{"get":{"tags":["people","photos"],"description":"Get the photographer relationship of a specific instance of photos","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["people","photos"],"description":"Create the photographer relationship of a specific instance of photos","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"people create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["people","photos"],"description":"Update the photographer relationship of a specific instance of photos","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["people","photos"],"description":"Delete the photographer relationship of a specific instance of photos","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"people delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tags":{"get":{"tags":["tags"],"description":"Search for tags","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"tags search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/tags"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["tags"],"description":"Create a new instance of tags","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/tags"}}}}],"responses":{"201":{"description":"tags create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tags"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tags/{id}":{"get":{"tags":["tags"],"description":"Get a specific instance of tags","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tags"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["tags"],"description":"Delete an instance of tags","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["tags"],"description":"Update an instance of tags","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/tags"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tags"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tags/{id}/parent":{"get":{"tags":["tags"],"description":"Get the parent instance of a specific instance of tags","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tags"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tags/{id}/relationships/parent":{"get":{"tags":["tags"],"description":"Get the parent relationship of a specific instance of tags","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["tags"],"description":"Create the parent relationship of a specific instance of tags","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"tags create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["tags"],"description":"Update the parent relationship of a specific instance of tags","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["tags"],"description":"Delete the parent relationship of a specific instance of tags","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tags delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples":{"get":{"tags":["tuples"],"description":"Search for tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"}],"responses":{"200":{"description":"tuples search response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"$ref":"#/definitions/tuples"}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["tuples"],"description":"Create a new instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/tuples"}}}}],"responses":{"201":{"description":"tuples create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tuples"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples/{id}":{"get":{"tags":["tuples"],"description":"Get a specific instance of tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tuples find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tuples"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["tuples"],"description":"Delete an instance of tuples","parameters":[{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tuples delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["tuples"],"description":"Update an instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/tuples"}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"tuples update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/tuples"}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples/{id}/media":{"get":{"tags":["articles"],"description":"Get the media instances of a specific instance of tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/articles"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples/{id}/relationships/media":{"get":{"tags":["articles","tuples"],"description":"Get the media relationship of a specific instance of tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["articles","tuples"],"description":"Create the media relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"articles create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["articles","tuples"],"description":"Update the media relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["articles","tuples"],"description":"Delete the media relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples/{id}/preferred":{"get":{"tags":["articles"],"description":"Get the preferred instance of a specific instance of tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"$ref":"#/definitions/articles"},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}},"/tuples/{id}/relationships/preferred":{"get":{"tags":["articles","tuples"],"description":"Get the preferred relationship of a specific instance of tuples","parameters":[{"$ref":"#/parameters/sort"},{"$ref":"#/parameters/include"},{"$ref":"#/parameters/filter"},{"$ref":"#/parameters/fields"},{"$ref":"#/parameters/page"},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles find response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}},"included":{"type":"array","items":{"type":"object"}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"post":{"tags":["articles","tuples"],"description":"Create the preferred relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"201":{"description":"articles create response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"patch":{"tags":["articles","tuples"],"description":"Update the preferred relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles update response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}},"delete":{"tags":["articles","tuples"],"description":"Delete the preferred relationship of a specific instance of tuples","parameters":[{"in":"body","name":"body","description":"New or partial resource","required":true,"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},{"name":"id","in":"path","description":"id of specific instance to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"articles delete response","schema":{"type":"object","required":["jsonapi","meta","links"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error"}}}}}},"definitions":{"articles":{"description":"Represents the core content, people love to read articles.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"title":{"description":"The articles title, should be between 8 and 15 words","type":"string"},"content":{"description":"The main body of the article, provided as HTML","type":"string"},"created":{"description":"The date on which the article was created, YYYY-MM-DD","type":"string"},"status":{"description":"The status of the article - draft, ready, published","type":"string"},"views":{"description":"Number of views for this article","type":"number"}},"required":["title","content"]},"relationships":{"type":"object","properties":{"author":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}},"tags":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"photos":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"comments":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"autoincrement":{"description":"Demonstration of a resource with an auto-incrementing ID","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"name":{"description":"The name of the item","type":"string"}}},"relationships":{"type":"object","properties":{}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"brokenResponse":{"description":"Example demonstrating error handling of broken responses","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"boolean":{"type":"boolean"},"number":{"type":"number"}}},"relationships":{"type":"object","properties":{}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"comments":{"description":"Allow people to attach short messages to articles","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"body":{"description":"The tag name","type":"string"},"timestamp":{"description":"The date on which the comment was created, YYYY-MM-DD","type":"string"}},"required":["body"]},"relationships":{"type":"object","properties":{"author":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}},"article":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"people":{"description":"Used to attribute work to specific people.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"firstname":{"description":"The persons first name","type":"string"},"lastname":{"description":"The persons last name","type":"string"},"email":{"description":"The persons preferred contact email address","type":"string"}}},"relationships":{"type":"object","properties":{"articles":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"photos":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"photos":{"description":"Used to represent all the images in the system.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"title":{"description":"The photos title","type":"string"},"url":{"description":"A url that resolves to the photograph","type":"string"},"height":{"description":"The photos height in pixels","type":"number"},"width":{"description":"The photos width in pixels","type":"number"},"raw":{"description":"File in RAW format","type":"boolean"},"tags":{"description":"Tags for the photo","type":"array"}},"required":["url"]},"relationships":{"type":"object","properties":{"photographer":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}},"articles":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"tags":{"description":"Used to group resources together, useful for finding related resources.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"name":{"description":"The tag name","type":"string"}}},"relationships":{"type":"object","properties":{"articles":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"parent":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}},"children":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"tuples":{"description":"A demonstration of a polymorphic relationship","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"media":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}},"preferred":{"type":"object","properties":{"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}},"data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"meta":{"type":"object"}}}}}}},"links":{"type":"object","properties":{"self":{"type":"string"}}},"meta":{"type":"object"}}},"error":{"type":"object","required":["jsonapi","meta","links","errors"],"properties":{"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string"}}},"meta":{"type":"object"},"links":{"type":"object","properties":{"self":{"type":"string"}}},"errors":{"type":"array","items":{"type":"object","required":["status","code","title","detail"],"properties":{"status":{"type":"string"},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"object"}}}}}}},"security":[{"APIKeyHeader":[]}],"securityDefinitions":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Auth"}}}
swagger: '2.0'
info:
title: 'Example JSON:API Server'
version: 0.1.1
description: This is the API description block that shows up in the swagger.json
termsOfService: 'http://example.com/termsOfService'
contact:
name: API Contact
email: apicontact@holidayextras.com
url: docs.hapi.holidayextras.com
license:
name: MIT
url: 'http://opensource.org/licenses/MIT'
basePath: /rest
schemes:
- http
consumes:
- application/vnd.api+json
produces:
- application/vnd.api+json
parameters:
sort:
name: sort
in: query
description: 'Sort resources as per the JSON:API specification'
required: false
type: string
include:
name: include
in: query
description: 'Fetch additional resources as per the JSON:API specification'
required: false
type: string
filter:
name: filter
in: query
description: 'Filter resources as per the JSON:API specification'
required: false
type: string
fields:
name: fields
in: query
description: 'Limit response payloads as per the JSON:API specification'
required: false
type: string
page:
name: page
in: query
description: Pagination namespace
required: false
type: string
paths:
/articles:
get:
tags:
- articles
description: Search for articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: articles search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/articles'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- articles
description: Create a new instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/articles'
responses:
'201':
description: articles create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/articles'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}':
get:
tags:
- articles
description: Get a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/articles'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- articles
description: Delete an instance of articles
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- articles
description: Update an instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/articles'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/articles'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/author':
get:
tags:
- people
description: Get the author instance of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/relationships/author':
get:
tags:
- people
- articles
description: Get the author relationship of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- people
- articles
description: Create the author relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: people create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- people
- articles
description: Update the author relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- people
- articles
description: Delete the author relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/tags':
get:
tags:
- tags
description: Get the tags instances of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tags'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/relationships/tags':
get:
tags:
- tags
- articles
description: Get the tags relationship of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- tags
- articles
description: Create the tags relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: tags create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- tags
- articles
description: Update the tags relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- tags
- articles
description: Delete the tags relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/photos':
get:
tags:
- photos
description: Get the photos instances of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/photos'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/relationships/photos':
get:
tags:
- photos
- articles
description: Get the photos relationship of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- photos
- articles
description: Create the photos relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: photos create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- photos
- articles
description: Update the photos relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- photos
- articles
description: Delete the photos relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/comments':
get:
tags:
- comments
description: Get the comments instances of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/comments'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/articles/{id}/relationships/comments':
get:
tags:
- comments
- articles
description: Get the comments relationship of a specific instance of articles
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- comments
- articles
description: Create the comments relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: comments create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- comments
- articles
description: Update the comments relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- comments
- articles
description: Delete the comments relationship of a specific instance of articles
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/autoincrement:
get:
tags:
- autoincrement
description: Search for autoincrement
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: autoincrement search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/autoincrement'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- autoincrement
description: Create a new instance of autoincrement
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/autoincrement'
responses:
'201':
description: autoincrement create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/autoincrement'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/autoincrement/{id}':
get:
tags:
- autoincrement
description: Get a specific instance of autoincrement
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: autoincrement find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/autoincrement'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- autoincrement
description: Delete an instance of autoincrement
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: autoincrement delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- autoincrement
description: Update an instance of autoincrement
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/autoincrement'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: autoincrement update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/autoincrement'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/brokenResponse:
get:
tags:
- brokenResponse
description: Search for brokenResponse
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: brokenResponse search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/brokenResponse'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- brokenResponse
description: Create a new instance of brokenResponse
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/brokenResponse'
responses:
'201':
description: brokenResponse create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/brokenResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/brokenResponse/{id}':
get:
tags:
- brokenResponse
description: Get a specific instance of brokenResponse
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: brokenResponse find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/brokenResponse'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- brokenResponse
description: Delete an instance of brokenResponse
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: brokenResponse delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- brokenResponse
description: Update an instance of brokenResponse
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/brokenResponse'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: brokenResponse update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/brokenResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/comments:
get:
tags:
- comments
description: Search for comments
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: comments search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/comments'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- comments
description: Create a new instance of comments
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/comments'
responses:
'201':
description: comments create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/comments'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/comments/{id}':
get:
tags:
- comments
description: Get a specific instance of comments
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/comments'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- comments
description: Delete an instance of comments
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- comments
description: Update an instance of comments
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/comments'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: comments update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/comments'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/comments/{id}/author':
get:
tags:
- people
description: Get the author instance of a specific instance of comments
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/comments/{id}/relationships/author':
get:
tags:
- people
- comments
description: Get the author relationship of a specific instance of comments
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- people
- comments
description: Create the author relationship of a specific instance of comments
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: people create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- people
- comments
description: Update the author relationship of a specific instance of comments
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- people
- comments
description: Delete the author relationship of a specific instance of comments
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/people:
get:
tags:
- people
description: Search for people
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: people search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/people'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- people
description: Create a new instance of people
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/people'
responses:
'201':
description: people create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/people/{id}':
get:
tags:
- people
description: Get a specific instance of people
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- people
description: Delete an instance of people
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- people
description: Update an instance of people
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/people'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/photos:
get:
tags:
- photos
description: Search for photos
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: photos search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/photos'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- photos
description: Create a new instance of photos
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/photos'
responses:
'201':
description: photos create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/photos'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/photos/{id}':
get:
tags:
- photos
description: Get a specific instance of photos
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/photos'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- photos
description: Update an instance of photos
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/photos'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: photos update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/photos'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/photos/{id}/photographer':
get:
tags:
- people
description: Get the photographer instance of a specific instance of photos
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/people'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/photos/{id}/relationships/photographer':
get:
tags:
- people
- photos
description: Get the photographer relationship of a specific instance of photos
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- people
- photos
description: Create the photographer relationship of a specific instance of photos
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: people create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- people
- photos
description: Update the photographer relationship of a specific instance of photos
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- people
- photos
description: Delete the photographer relationship of a specific instance of photos
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: people delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/tags:
get:
tags:
- tags
description: Search for tags
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: tags search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/tags'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- tags
description: Create a new instance of tags
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/tags'
responses:
'201':
description: tags create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tags'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tags/{id}':
get:
tags:
- tags
description: Get a specific instance of tags
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tags'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- tags
description: Delete an instance of tags
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- tags
description: Update an instance of tags
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/tags'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tags'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tags/{id}/parent':
get:
tags:
- tags
description: Get the parent instance of a specific instance of tags
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tags'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tags/{id}/relationships/parent':
get:
tags:
- tags
description: Get the parent relationship of a specific instance of tags
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- tags
description: Create the parent relationship of a specific instance of tags
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: tags create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- tags
description: Update the parent relationship of a specific instance of tags
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- tags
description: Delete the parent relationship of a specific instance of tags
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tags delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
/tuples:
get:
tags:
- tuples
description: Search for tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
responses:
'200':
description: tuples search response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
$ref: '#/definitions/tuples'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- tuples
description: Create a new instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/tuples'
responses:
'201':
description: tuples create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tuples'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tuples/{id}':
get:
tags:
- tuples
description: Get a specific instance of tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tuples find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tuples'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- tuples
description: Delete an instance of tuples
parameters:
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tuples delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- tuples
description: Update an instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
$ref: '#/definitions/tuples'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: tuples update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/tuples'
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tuples/{id}/media':
get:
tags:
- articles
description: Get the media instances of a specific instance of tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/articles'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tuples/{id}/relationships/media':
get:
tags:
- articles
- tuples
description: Get the media relationship of a specific instance of tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- articles
- tuples
description: Create the media relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: articles create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- articles
- tuples
description: Update the media relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- articles
- tuples
description: Delete the media relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tuples/{id}/preferred':
get:
tags:
- articles
description: Get the preferred instance of a specific instance of tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
$ref: '#/definitions/articles'
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
'/tuples/{id}/relationships/preferred':
get:
tags:
- articles
- tuples
description: Get the preferred relationship of a specific instance of tuples
parameters:
- $ref: '#/parameters/sort'
- $ref: '#/parameters/include'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/page'
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles find response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
included:
type: array
items:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
post:
tags:
- articles
- tuples
description: Create the preferred relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'201':
description: articles create response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
patch:
tags:
- articles
- tuples
description: Update the preferred relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles update response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
delete:
tags:
- articles
- tuples
description: Delete the preferred relationship of a specific instance of tuples
parameters:
- in: body
name: body
description: New or partial resource
required: true
schema:
type: object
properties:
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
- name: id
in: path
description: id of specific instance to lookup
required: true
type: string
responses:
'200':
description: articles delete response
schema:
type: object
required:
- jsonapi
- meta
- links
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
required:
- self
properties:
self:
type: string
first:
type: string
last:
type: string
next:
type: string
prev:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
default:
description: Unexpected error
schema:
$ref: '#/definitions/error'
definitions:
articles:
description: 'Represents the core content, people love to read articles.'
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
title:
description: 'The articles title, should be between 8 and 15 words'
type: string
content:
description: 'The main body of the article, provided as HTML'
type: string
created:
description: 'The date on which the article was created, YYYY-MM-DD'
type: string
status:
description: 'The status of the article - draft, ready, published'
type: string
views:
description: Number of views for this article
type: number
required:
- title
- content
relationships:
type: object
properties:
author:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
tags:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
photos:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
comments:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
autoincrement:
description: Demonstration of a resource with an auto-incrementing ID
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
name:
description: The name of the item
type: string
relationships:
type: object
properties: {}
links:
type: object
properties:
self:
type: string
meta:
type: object
brokenResponse:
description: Example demonstrating error handling of broken responses
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
boolean:
type: boolean
number:
type: number
relationships:
type: object
properties: {}
links:
type: object
properties:
self:
type: string
meta:
type: object
comments:
description: Allow people to attach short messages to articles
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
body:
description: The tag name
type: string
timestamp:
description: 'The date on which the comment was created, YYYY-MM-DD'
type: string
required:
- body
relationships:
type: object
properties:
author:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
article:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
people:
description: Used to attribute work to specific people.
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
firstname:
description: The persons first name
type: string
lastname:
description: The persons last name
type: string
email:
description: The persons preferred contact email address
type: string
relationships:
type: object
properties:
articles:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
photos:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
photos:
description: Used to represent all the images in the system.
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
title:
description: The photos title
type: string
url:
description: A url that resolves to the photograph
type: string
height:
description: The photos height in pixels
type: number
width:
description: The photos width in pixels
type: number
raw:
description: File in RAW format
type: boolean
tags:
description: Tags for the photo
type: array
required:
- url
relationships:
type: object
properties:
photographer:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
articles:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
tags:
description: 'Used to group resources together, useful for finding related resources.'
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
name:
description: The tag name
type: string
relationships:
type: object
properties:
articles:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
parent:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
children:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
tuples:
description: A demonstration of a polymorphic relationship
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties: {}
relationships:
type: object
properties:
media:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
preferred:
type: object
properties:
meta:
type: object
links:
type: object
properties:
self:
type: string
related:
type: string
data:
type: object
required:
- type
- id
properties:
type:
type: string
id:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
meta:
type: object
error:
type: object
required:
- jsonapi
- meta
- links
- errors
properties:
jsonapi:
type: object
required:
- version
properties:
version:
type: string
meta:
type: object
links:
type: object
properties:
self:
type: string
errors:
type: array
items:
type: object
required:
- status
- code
- title
- detail
properties:
status:
type: string
code:
type: string
title:
type: string
detail:
type: object
security:
- APIKeyHeader: []
securityDefinitions:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Auth
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment