Patchstorage API Docs API Reference

Welcome to Patchstorage Read-Only API documentation page!

Current Alpha API schema will be locked on 2020-05-01 and alpha/ prefix will be changed with v1/. If you found any issues or have any suggestions or schema chage requests let us know here - https://bit.ly/38oTtXh.

If you have any other questions, please contact us via hello@patchstorage.com.

API Endpoint
https://patchstorage.com/api/alpha
Schemes: https
Version: 0.1.1

patch

Returns a list of patch objects.

GET /patches/
page: integer 1
in query

Current page of the collection.

per_page: integer 10
in query

Maximum number of items to be returned.

search: string
in query

Limit results to those matching a string.

before: string
in query

Limit response to items published before a given ISO8601 compliant date.

after: string
in query

Limit response to items published after a given ISO8601 compliant date.

exclude: string
in query

Ensure result set excludes specific IDs.

include: string
in query

Limit result set to specific IDs.

offset: integer
in query

Offset the result set by a specific number of items.

order: string asc, desc desc
in query

Order sort attribute ascending or descending.

orderby: string author, date, id, modified, relevance, slug, title date
in query

Sort items by object attribute.

slug: string[]
in query

Limit result set to items with one or more specific slugs.

author: string
in query

Limit result set to all items by specific authors. Comma separated author IDs.

author_exclude: string
in query

Ensure result set excludes items by specific authors. Comma separated author IDs.

categories: integer[]
in query

Limit result set to all items that have categories (IDs) assigned.

categories_exclude: integer[]
in query

Limit result set to all items except ones that have categories (IDs) assigned.

tags: integer[]
in query

Limit result set to all items that have tags (IDs) assigned.

tags_exclude: integer[]
in query

Limit result set to all items except ones that have tags (IDs) assigned.

platforms: integer[]
in query

Limit result set to all items that have platforms (IDs) assigned.

platforms_exclude: integer[]
in query

Limit result set to all items except ones that have platforms (IDs) assigned.

states: integer[]
in query

Limit result set to all items that have states (IDs) assigned.

states_exclude: integer[]
in query

Limit result set to all items except ones that have states (IDs) assigned.

200 OK

Success

type
400 Bad Request

Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "self": "string",
    "link": "string",
    "created_at": "string",
    "updated_at": "string",
    "slug": "string",
    "title": "string",
    "excerpt": "string",
    "comment_count": "integer",
    "view_count": "integer",
    "like_count": "integer",
    "download_count": "integer",
    "categories": [
      {
        "id": "integer",
        "slug": "string",
        "name": "string"
      }
    ],
    "tags": [
      {
        "id": "integer",
        "slug": "string",
        "name": "string"
      }
    ],
    "platform": {
      "id": "integer",
      "slug": "string",
      "name": "string"
    },
    "state": {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  }
]
Response Headers (200 OK)
X-WP-Total

Count of all objects in collection.

integer
X-WP-TotalPages

Count of pages available in collection based on 'per_page' query parameter value.

integer
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

Returns a specific patch object.

GET /patches/{id}/
id: integer
in path

Unique identifier for the object.

200 OK

Success

404 Not Found

Not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "link": "string",
  "created_at": "string",
  "updated_at": "string",
  "slug": "string",
  "title": "string",
  "excerpt": "string",
  "content": "string",
  "code": "string",
  "files": [
    {
      "id": "integer",
      "url": "string",
      "filesize": "integer",
      "filename": "string"
    }
  ],
  "artwork": {
    "url": "string"
  },
  "preview_url": "string",
  "source_code_url": "string",
  "revision": "string",
  "comment_count": "integer",
  "view_count": "integer",
  "like_count": "integer",
  "download_count": "integer",
  "author": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "categories": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "tags": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "platform": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "state": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "license": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "custom_license_text": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

platform

Returns a list of platform objects.

GET /platforms/
200 OK

Success

type
Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "self": "string",
    "description": "string",
    "slug": "string",
    "name": "string"
  }
]
Response Headers (200 OK)
X-WP-Total

Count of all objects in collection.

integer
X-WP-TotalPages

Count of pages available in collection based on 'per_page' query parameter value.

integer

Returns a specific platform object.

GET /platforms/{id}/
id: integer
in path

Unique identifier for the object.

200 OK

Success

404 Not Found

Not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "self": "string",
  "description": "string",
  "slug": "string",
  "name": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

category

Returns a list of category objects.

GET /categories/
200 OK

Success

type
Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "self": "string",
    "description": "string",
    "slug": "string",
    "name": "string"
  }
]
Response Headers (200 OK)
X-WP-Total

Count of all objects in collection.

integer
X-WP-TotalPages

Count of pages available in collection based on 'per_page' query parameter value.

integer

Returns a specific category object.

GET /categories/{id}/
id: integer
in path

Unique identifier for the object.

200 OK

Success

404 Not Found

Not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "self": "string",
  "description": "string",
  "slug": "string",
  "name": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

state

Returns a list of state objects.

GET /states/
200 OK

Success

type
Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "self": "string",
    "description": "string",
    "slug": "string",
    "name": "string"
  }
]
Response Headers (200 OK)
X-WP-Total

Count of all objects in collection.

integer
X-WP-TotalPages

Count of pages available in collection based on 'per_page' query parameter value.

integer

Returns a specific state object.

GET /states/{id}/
id: integer
in path

Unique identifier for the object.

200 OK

Success

404 Not Found

Not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "self": "string",
  "description": "string",
  "slug": "string",
  "name": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

license

Returns a list of license objects.

GET /licenses/
200 OK

Success

type
Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "self": "string",
    "description": "string",
    "slug": "string",
    "name": "string"
  }
]
Response Headers (200 OK)
X-WP-Total

Count of all objects in collection.

integer
X-WP-TotalPages

Count of pages available in collection based on 'per_page' query parameter value.

integer

Returns a specific license object.

GET /licenses/{id}/
id: integer
in path

Unique identifier for the object.

200 OK

Success

404 Not Found

Not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "self": "string",
  "description": "string",
  "slug": "string",
  "name": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}

Schema Definitions

Patch: object

id: integer

Unique object identifier.

self: string

Unique object identifier.

link: string
created_at: string
updated_at: string
slug: string
title: string
excerpt: string
comment_count: integer
view_count: integer
like_count: integer
download_count: integer
categories: TaxonomyInline
TaxonomyInline
tags: TaxonomyInline
TaxonomyInline
platform: TaxonomyInline
state: TaxonomyInline
Example
{
  "id": "integer",
  "self": "string",
  "link": "string",
  "created_at": "string",
  "updated_at": "string",
  "slug": "string",
  "title": "string",
  "excerpt": "string",
  "comment_count": "integer",
  "view_count": "integer",
  "like_count": "integer",
  "download_count": "integer",
  "categories": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "tags": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "platform": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "state": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  }
}

PatchExtended: object

id: integer

Unique object identifier.

link: string
created_at: string
updated_at: string
slug: string
title: string
excerpt: string
content: string
code: string
files: File
File
artwork: Artwork
preview_url: string
source_code_url: string
revision: string
comment_count: integer
view_count: integer
like_count: integer
download_count: integer
author: Author
categories: TaxonomyInline
TaxonomyInline
tags: TaxonomyInline
TaxonomyInline
platform: TaxonomyInline
state: TaxonomyInline
license: TaxonomyInline
custom_license_text: string
Example
{
  "id": "integer",
  "link": "string",
  "created_at": "string",
  "updated_at": "string",
  "slug": "string",
  "title": "string",
  "excerpt": "string",
  "content": "string",
  "code": "string",
  "files": [
    {
      "id": "integer",
      "url": "string",
      "filesize": "integer",
      "filename": "string"
    }
  ],
  "artwork": {
    "url": "string"
  },
  "preview_url": "string",
  "source_code_url": "string",
  "revision": "string",
  "comment_count": "integer",
  "view_count": "integer",
  "like_count": "integer",
  "download_count": "integer",
  "author": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "categories": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "tags": [
    {
      "id": "integer",
      "slug": "string",
      "name": "string"
    }
  ],
  "platform": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "state": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "license": {
    "id": "integer",
    "slug": "string",
    "name": "string"
  },
  "custom_license_text": "string"
}

Taxonomy: object

Model for Platform, Category, State, License, Tag representation.

id: integer

Unique object identifier.

self: string

Link to a single object.

description: string

Object description.

slug: string

Object slug.

name: string

Object name.

Example
{
  "id": "integer",
  "self": "string",
  "description": "string",
  "slug": "string",
  "name": "string"
}

TaxonomyInline: object

Model for Platform, Category, State, License, Tag representation.

id: integer

Unique object identifier.

slug: string

Object slug.

name: string

Object name.

Example
{
  "id": "integer",
  "slug": "string",
  "name": "string"
}

File: object

Model for File representation.

id: integer

Unique object identifier.

url: string

Object download link.

filesize: integer

Object size in bytes.

filename: string

Object filename.

Example
{
  "id": "integer",
  "url": "string",
  "filesize": "integer",
  "filename": "string"
}

Artwork: object

Model for Artwork representation.

url: string

Object download link.

Example
{
  "url": "string"
}

Author: object

Model for Author representation.

id: integer

Unique object identifier.

slug: string

Object slug.

name: string

Object name.

Example
{
  "id": "integer",
  "slug": "string",
  "name": "string"
}

Error: object

Model for API Error representation.

code: string

Unique error code.

message: string

Error message.

data: object
status: integer

Status code.

Example
{
  "code": "string",
  "message": "string",
  "data": {
    "status": "integer"
  }
}