Vue Play Packets Manager API (1.0.0)

Download OpenAPI specification:

Vue Play: support@vueplay.com URL: https://vueplay.com License: Apache 2.0

API documentation for FeathersJS service including packets management.

Authentication

User login

Logs in a user using jwt strategy, and returns a JWT token. Auth jwt token for authentication can be obtained using user authentication service.

Request Body schema: application/json
required

strategy	string Default: "jwt" The authentication strategy to use (only jwt is available).
accessToken	string Required.

Responses

Request samples

Payload
Feathers

Content type

application/json

{"strategy": "jwt",
"accessToken": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"accessToken": "string"
}

Access Scopes

Retrieve a list of Access Scopes

Returns a list of Access Scopes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('access_scopes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [[{"id": 1,
"name": "Full access",
"slug": "full_access",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 2,
"name": "Roles read",
"slug": "roles_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 3,
"name": "Roles write",
"slug": "roles_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 4,
"name": "Errors read",
"slug": "errors_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 5,
"name": "Errors write",
"slug": "errors_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 6,
"name": "Role access scopes read",
"slug": "role_access_scopes_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 7,
"name": "Role access scopes write",
"slug": "role_access_scopes_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 8,
"name": "Icons read",
"slug": "icons_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 9,
"name": "Icons write",
"slug": "icons_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 10,
"name": "Categories read",
"slug": "categories_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 11,
"name": "Categories write",
"slug": "categories_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 12,
"name": "Tags create",
"slug": "tags_create",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 13,
"name": "Tags read",
"slug": "tags_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 14,
"name": "Tags write",
"slug": "tags_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 15,
"name": "Access scopes read",
"slug": "scopes_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 16,
"name": "Access scopes write",
"slug": "scopes_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 17,
"name": "Applications create",
"slug": "applications_create",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 18,
"name": "Applications read",
"slug": "applications_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 19,
"name": "Applications write",
"slug": "applications_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 20,
"name": "Application users read",
"slug": "application_users_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 21,
"name": "Application users write",
"slug": "application_users_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 22,
"name": "Application access groups read",
"slug": "application_access_groups_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 23,
"name": "Application access groups write",
"slug": "application_access_groups_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 24,
"name": "Application downloads read",
"slug": "application_downloads_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 25,
"name": "Application downloads write",
"slug": "application_downloads_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 26,
"name": "Application git tokens read",
"slug": "application_git_tokens_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 27,
"name": "Application git tokens write",
"slug": "application_git_tokens_write",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-19T11:20:30Z"
},
{"id": 28,
"name": "Application mockups read",
"slug": "application_mockups_read",
"description": "",
"created_at": "2024-08-18T11:20:30Z",
"updated_at": "2024-08-18T11:20:30Z"
},
{"id": 29,
"name": "Application mockups write",
"slug": "application_mockups_write",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 30,
"name": "SSL read",
"slug": "ssl_read",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 31,
"name": "SSL write",
"slug": "ssl_write",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 32,
"name": "SSL certificates read",
"slug": "ssl_certificates_read",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 33,
"name": "SSL certificates write",
"slug": "ssl_certificates_write",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 34,
"name": "SSL maintainer groups read",
"slug": "ssl_maintainer_groups_read",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
},
{"id": 35,
"name": "SSL maintainer groups write",
"slug": "ssl_maintainer_groups_write",
"description": "",
"created_at": "2024-10-09T00:00:00Z",
"updated_at": "2024-10-09T00:00:00Z"
}
]
]
}

Create a new access scope

Creates a new access scope based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Access scope object that needs to be added

name	string
slug required	string
description	string

Responses

Request samples

Payload
Feathers

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an access scope by ID

Retrieves an access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('access_scopes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an access scope by ID

Updates an access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Access scope object that needs to be updated

name	string
slug required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an access scope by ID

Patches an access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Access scope object that needs to be updated

name	string
slug required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an access scope by ID

Deletes an access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Applications

Retrieve a list of Applications

Returns a list of Applications.

Authorizations:

bearerAuthNone

Responses

Request samples

Feathers

app.service('applications').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application

Creates a new application based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Application object that needs to be added

uuid required	string Unique reference to repo folder
product_id	integer Reference to market product
type required	string Type of the application (references slug in application_types table)
price	integer Price in USD cents including VAT
title	string Title of the application
description	string Detailed description of the application
slug required	string Unique slug for hosting on *.vue.spa
icon	string URL or path to the icon file
favicon	string URL or path to the favicon file
elicon	string URL or path to the elicon file
showcase_url	string URL to showcase component on Vue Play component page
tailwind	boolean Default: true Indicates if Tailwind CSS is enabled
public	boolean Default: false Whether the application is publicly accessible
published	boolean Default: false Indicates if the application is published
hidden	boolean Default: false Indicates if the application is hidden
restrict_clone	boolean Default: true Disable to allow cloning of 'vue-sfc' repos for purchased and public applications
disable_preview	boolean Default: true Disable component preview on Vue Play component page to protect source code
access_group_id	integer Access group who owns the application
user_id	integer User id who owns the application
includePublicHidden	boolean Default: false Also query for hidden applications
includeArchived	boolean Default: false Also query for archived applications
strict	boolean Default: false Check if requester has access to read built distribution source code
git	boolean Default: false Check if requester has access to read git source code
requireVersion	boolean Default: false Only return if application have versions built
archived_at	string or null <date-time> Timestamp when the application was archived

Responses

Request samples

Payload
Feathers

Content type

application/json

{"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"access_group_id": 0,
"user_id": 0,
"includePublicHidden": false,
"includeArchived": false,
"strict": false,
"git": false,
"requireVersion": false,
"archived_at": "2019-08-24T14:15:22Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application by ID

Retrieves an application based on the provided ID.

Authorizations:

bearerAuthNone

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('applications').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application by ID

Updates an application based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Application object that needs to be updated

uuid required	string Unique reference to repo folder
product_id	integer Reference to market product
type required	string Type of the application (references slug in application_types table)
price	integer Price in USD cents including VAT
title	string Title of the application
description	string Detailed description of the application
slug required	string Unique slug for hosting on *.vue.spa
icon	string URL or path to the icon file
favicon	string URL or path to the favicon file
elicon	string URL or path to the elicon file
showcase_url	string URL to showcase component on Vue Play component page
tailwind	boolean Default: true Indicates if Tailwind CSS is enabled
public	boolean Default: false Whether the application is publicly accessible
published	boolean Default: false Indicates if the application is published
hidden	boolean Default: false Indicates if the application is hidden
restrict_clone	boolean Default: true Disable to allow cloning of 'vue-sfc' repos for purchased and public applications
disable_preview	boolean Default: true Disable component preview on Vue Play component page to protect source code
access_group_id	integer Access group who owns the application
user_id	integer User id who owns the application
includePublicHidden	boolean Default: false Also query for hidden applications
includeArchived	boolean Default: false Also query for archived applications
strict	boolean Default: false Check if requester has access to read built distribution source code
git	boolean Default: false Check if requester has access to read git source code
requireVersion	boolean Default: false Only return if application have versions built
archived_at	string or null <date-time> Timestamp when the application was archived

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"access_group_id": 0,
"user_id": 0,
"includePublicHidden": false,
"includeArchived": false,
"strict": false,
"git": false,
"requireVersion": false,
"archived_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application by ID

Patches an application based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Application object that needs to be updated

uuid required	string Unique reference to repo folder
product_id	integer Reference to market product
type required	string Type of the application (references slug in application_types table)
price	integer Price in USD cents including VAT
title	string Title of the application
description	string Detailed description of the application
slug required	string Unique slug for hosting on *.vue.spa
icon	string URL or path to the icon file
favicon	string URL or path to the favicon file
elicon	string URL or path to the elicon file
showcase_url	string URL to showcase component on Vue Play component page
tailwind	boolean Default: true Indicates if Tailwind CSS is enabled
public	boolean Default: false Whether the application is publicly accessible
published	boolean Default: false Indicates if the application is published
hidden	boolean Default: false Indicates if the application is hidden
restrict_clone	boolean Default: true Disable to allow cloning of 'vue-sfc' repos for purchased and public applications
disable_preview	boolean Default: true Disable component preview on Vue Play component page to protect source code
access_group_id	integer Access group who owns the application
user_id	integer User id who owns the application
includePublicHidden	boolean Default: false Also query for hidden applications
includeArchived	boolean Default: false Also query for archived applications
strict	boolean Default: false Check if requester has access to read built distribution source code
git	boolean Default: false Check if requester has access to read git source code
requireVersion	boolean Default: false Only return if application have versions built
archived_at	string or null <date-time> Timestamp when the application was archived

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"access_group_id": 0,
"user_id": 0,
"includePublicHidden": false,
"includeArchived": false,
"strict": false,
"git": false,
"requireVersion": false,
"archived_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application by ID

Deletes an application based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"uuid": "string",
"product_id": 0,
"type": "string",
"price": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"favicon": "string",
"elicon": "string",
"showcase_url": "string",
"tailwind": true,
"public": false,
"published": false,
"hidden": false,
"restrict_clone": true,
"disable_preview": true,
"archived_at": "2019-08-24T14:15:22Z",
"deployed_staging_at": "2019-08-24T14:15:22Z",
"deployed_at": "2019-08-24T14:15:22Z",
"latest_version_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Application Access Groups

Retrieve a list of Application Access Groups

Returns a list of Application Access Groups.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_access_groups').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application access group

Creates a new application access group based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Application Access Group object that needs to be added

application_id required	integer ID of the application associated with the access group
access_group_id required	integer ID of the access group associated with the application

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"access_group_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application access group by ID

Retrieves an application access group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_access_groups').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application access group by ID

Updates an application access group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Application Access Group object that needs to be updated

application_id required	integer ID of the application associated with the access group
access_group_id required	integer ID of the access group associated with the application

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"access_group_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application access group by ID

Patches an application access group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Application Access Group object that needs to be updated

application_id required	integer ID of the application associated with the access group
access_group_id required	integer ID of the access group associated with the application

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"access_group_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application access group by ID

Deletes an application access group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationCategories

Retrieve a list of ApplicationCategories

Returns a list of ApplicationCategories.

Responses

Request samples

Feathers

app.service('application_categories').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application category

Creates a new application category based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationCategory object that needs to be added

application_id required	integer ID of the application this category is associated with
slug required	string Slug of the category this application belongs to

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application category by ID

Retrieves an application category based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_categories').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application category by ID

Updates an application category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationCategory object that needs to be updated

application_id required	integer ID of the application this category is associated with
slug required	string Slug of the category this application belongs to

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application category by ID

Patches an application category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationCategory object that needs to be updated

application_id required	integer ID of the application this category is associated with
slug required	string Slug of the category this application belongs to

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application category by ID

Deletes an application category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationDownloads

Retrieve a list of ApplicationDownloads

Returns a list of ApplicationDownloads.

Responses

Request samples

Feathers

app.service('application_downloads').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application download

Creates a new application download based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationDownload object that needs to be added

application_id

required

integer

ID of the application associated with the download

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application download by ID

Retrieves an application download based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_downloads').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application download by ID

Updates an application download based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationDownload object that needs to be updated

application_id

required

integer

ID of the application associated with the download

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application download by ID

Patches an application download based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationDownload object that needs to be updated

application_id

required

integer

ID of the application associated with the download

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application download by ID

Deletes an application download based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationGitTokens

Retrieve a list of encrypted application git tokens

Returns a list of encrypted application git tokens.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_git_tokens').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application git token

Creates a new application git token based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationGitToken object that needs to be added

application_id required	integer ID of the application associated with the git token
provider	string The provider of the git service (e.g., GitHub, GitLab)
exchange_token	string The token sent with the request to ensure a valid response
access_token_encrypted	string The encrypted access token for the application
iv	string The initialization vector used during encryption (if applicable)
remote_url	string The remote URL for clone, push, pull, etc.
expires_at	string <date-time> The timestamp when the git token expires

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application git token by ID

Retrieves an application git token based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_git_tokens').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application git token by ID

Updates an application git token based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationGitToken object that needs to be updated

application_id required	integer ID of the application associated with the git token
provider	string The provider of the git service (e.g., GitHub, GitLab)
exchange_token	string The token sent with the request to ensure a valid response
access_token_encrypted	string The encrypted access token for the application
iv	string The initialization vector used during encryption (if applicable)
remote_url	string The remote URL for clone, push, pull, etc.
expires_at	string <date-time> The timestamp when the git token expires

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application git token by ID

Patches an application git token based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationGitToken object that needs to be updated

application_id required	integer ID of the application associated with the git token
provider	string The provider of the git service (e.g., GitHub, GitLab)
exchange_token	string The token sent with the request to ensure a valid response
access_token_encrypted	string The encrypted access token for the application
iv	string The initialization vector used during encryption (if applicable)
remote_url	string The remote URL for clone, push, pull, etc.
expires_at	string <date-time> The timestamp when the git token expires

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application git token by ID

Deletes an application git token based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"provider": "string",
"exchange_token": "string",
"access_token_encrypted": "string",
"iv": "string",
"remote_url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationMockups

Retrieve a list of application mockups

Returns a list of application mockups.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_mockups').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application mockup

Creates a new application mockup based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationMockup object that needs to be added

application_id required	integer ID of the application associated with this mockup
code required	string Code of the mockup (could be HTML, CSS, or any format depending on the use case)

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"code": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application mockup by ID

Retrieves an application mockup based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_mockups').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application mockup by ID

Updates an application mockup based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationMockup object that needs to be updated

application_id required	integer ID of the application associated with this mockup
code required	string Code of the mockup (could be HTML, CSS, or any format depending on the use case)

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"code": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application mockup by ID

Patches an application mockup based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationMockup object that needs to be updated

application_id required	integer ID of the application associated with this mockup
code required	string Code of the mockup (could be HTML, CSS, or any format depending on the use case)

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"code": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application mockup by ID

Deletes an application mockup based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationOrigins

Retrieve a list of application origins

Returns a list of application origins.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_origins').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application origin

Creates a new application origin based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationOrigin object that needs to be added

application_id required	integer ID of the application associated with this origin
ssl_maintainer_id required	integer ID of the SSL maintainer responsible for this origin
origin required	string The origin (domain or URL) of the application
staging	boolean Indicates whether this origin is for staging or production
ssr	boolean Indicates whether ssr or not
ssr_hydration	boolean Indicates whether hydration is enabled or not
seo_index	boolean Indicates whether it is indexed for search engines or not
verification_secret	string Secret used for verifying the ownership of the origin
verified_at	string or null <date-time> Timestamp when the origin was verified
ssl_valid_to	string or null <date-time> Expiration date of the SSL certificate for this origin

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application origin by ID

Retrieves an application origin based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_origins').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application origin by ID

Updates an application origin based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationOrigin object that needs to be updated

application_id required	integer ID of the application associated with this origin
ssl_maintainer_id required	integer ID of the SSL maintainer responsible for this origin
origin required	string The origin (domain or URL) of the application
staging	boolean Indicates whether this origin is for staging or production
ssr	boolean Indicates whether ssr or not
ssr_hydration	boolean Indicates whether hydration is enabled or not
seo_index	boolean Indicates whether it is indexed for search engines or not
verification_secret	string Secret used for verifying the ownership of the origin
verified_at	string or null <date-time> Timestamp when the origin was verified
ssl_valid_to	string or null <date-time> Expiration date of the SSL certificate for this origin

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application origin by ID

Patches an application origin based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationOrigin object that needs to be updated

application_id required	integer ID of the application associated with this origin
ssl_maintainer_id required	integer ID of the SSL maintainer responsible for this origin
origin required	string The origin (domain or URL) of the application
staging	boolean Indicates whether this origin is for staging or production
ssr	boolean Indicates whether ssr or not
ssr_hydration	boolean Indicates whether hydration is enabled or not
seo_index	boolean Indicates whether it is indexed for search engines or not
verification_secret	string Secret used for verifying the ownership of the origin
verified_at	string or null <date-time> Timestamp when the origin was verified
ssl_valid_to	string or null <date-time> Expiration date of the SSL certificate for this origin

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application origin by ID

Deletes an application origin based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"ssl_maintainer_id": 0,
"origin": "string",
"staging": true,
"ssr": true,
"ssr_hydration": true,
"seo_index": true,
"verification_secret": "string",
"verified_at": "2019-08-24T14:15:22Z",
"ssl_valid_to": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationPurchases

Retrieve a list of application purchases

Returns a list of application purchases.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_purchases').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application purchase

Creates a new application purchase based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationPurchase object that needs to be added

user_id required	integer ID of the user who made the purchase
application_id required	integer ID of the application purchased
version_id required	integer ID of the version of the application purchased

Responses

Request samples

Payload
Feathers

Content type

application/json

{"user_id": 0,
"application_id": 0,
"version_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application purchase by ID

Retrieves an application purchase based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_purchases').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application purchase by ID

Updates an application purchase based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationPurchase object that needs to be updated

user_id required	integer ID of the user who made the purchase
application_id required	integer ID of the application purchased
version_id required	integer ID of the version of the application purchased

Responses

Request samples

Payload

Content type

application/json

{"user_id": 0,
"application_id": 0,
"version_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application purchase by ID

Patches an application purchase based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationPurchase object that needs to be updated

user_id required	integer ID of the user who made the purchase
application_id required	integer ID of the application purchased
version_id required	integer ID of the version of the application purchased

Responses

Request samples

Payload

Content type

application/json

{"user_id": 0,
"application_id": 0,
"version_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application purchase by ID

Deletes an application purchase based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"user_id": 0,
"application_id": 0,
"version_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationRatings

Retrieve a list of application ratings

Returns a list of application ratings.

Responses

Request samples

Feathers

app.service('application_ratings').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application rating

Creates a new application rating based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationRating object that needs to be added

application_id required	integer ID of the application this rating belongs to
user_id required	integer ID of the user who created the rating
positive required	boolean Whether the rating is positive (true) or negative (false)
comment	string Optional comment left by the user
version	string The version number of the application being rated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application rating by ID

Retrieves an application rating based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_ratings').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application rating by ID

Updates an application rating based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationRating object that needs to be updated

application_id required	integer ID of the application this rating belongs to
user_id required	integer ID of the user who created the rating
positive required	boolean Whether the rating is positive (true) or negative (false)
comment	string Optional comment left by the user
version	string The version number of the application being rated

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application rating by ID

Patches an application rating based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationRating object that needs to be updated

application_id required	integer ID of the application this rating belongs to
user_id required	integer ID of the user who created the rating
positive required	boolean Whether the rating is positive (true) or negative (false)
comment	string Optional comment left by the user
version	string The version number of the application being rated

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application rating by ID

Deletes an application rating based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"positive": true,
"comment": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationTags

Retrieve a list of ApplicationTags

Returns a list of ApplicationTags.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_tags').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application tag

Creates a new application tag based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationTag object that needs to be added

application_id required	integer ID of the application this tag is associated with
slug required	string Slug of the tag this application is associated with

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application tag by ID

Retrieves an application tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_tags').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application tag by ID

Updates an application tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationTag object that needs to be updated

application_id required	integer ID of the application this tag is associated with
slug required	string Slug of the tag this application is associated with

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application tag by ID

Patches an application tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationTag object that needs to be updated

application_id required	integer ID of the application this tag is associated with
slug required	string Slug of the tag this application is associated with

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"slug": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application tag by ID

Deletes an application tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationTypes

Retrieve a list of ApplicationTypes

Returns a list of ApplicationTypes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_types').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application type

Creates a new application type based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationType object that needs to be added

name required	string Name of the application type
slug required	string Unique slug representing the application type
description	string Description of the application type

Responses

Request samples

Payload
Feathers

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application type by ID

Retrieves an application type based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_types').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application type by ID

Updates an application type based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationType object that needs to be updated

name required	string Name of the application type
slug required	string Unique slug representing the application type
description	string Description of the application type

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application type by ID

Patches an application type based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationType object that needs to be updated

name required	string Name of the application type
slug required	string Unique slug representing the application type
description	string Description of the application type

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application type by ID

Deletes an application type based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationUsers

Retrieve a list of ApplicationUsers

Returns a list of ApplicationUsers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_users').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application user

Creates a new application user based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationUser object that needs to be added

application_id required	integer ID of the application associated with the user
user_id required	integer ID of the user associated with the application

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"user_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application user by ID

Retrieves an application user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_users').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application user by ID

Updates an application user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationUser object that needs to be updated

application_id required	integer ID of the application associated with the user
user_id required	integer ID of the user associated with the application

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application user by ID

Patches an application user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationUser object that needs to be updated

application_id required	integer ID of the application associated with the user
user_id required	integer ID of the user associated with the application

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application user by ID

Deletes an application user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ApplicationVersions

Retrieve a list of ApplicationVersions

Returns a list of ApplicationVersions.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('application_versions').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new application version

Creates a new application version based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ApplicationVersion object that needs to be added

application_id required	integer ID of the application this version belongs to
commit	string The commit hash associated with this version
version required	string The version number (e.g., "1.0.0")

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"commit": "string",
"version": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application version by ID

Retrieves an application version based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('application_versions').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an application version by ID

Updates an application version based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationVersion object that needs to be updated

application_id required	integer ID of the application this version belongs to
commit	string The commit hash associated with this version
version required	string The version number (e.g., "1.0.0")

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"commit": "string",
"version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an application version by ID

Patches an application version based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ApplicationVersion object that needs to be updated

application_id required	integer ID of the application this version belongs to
commit	string The commit hash associated with this version
version required	string The version number (e.g., "1.0.0")

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"commit": "string",
"version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an application version by ID

Deletes an application version based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"commit": "string",
"version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyzes

Retrieve a list of Analyzes

Returns a list of Analyzes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyzes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze

Creates a new analyze based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze object that needs to be added

application_id required	integer ID of the application being analyzed
name required	string Name of the component being analyzed
template	string The template content of the component
setup	string The setup function content of the component
render	string The render function content of the component
inherit_attrs	boolean Whether the component inherits attributes
options_api	boolean Indicates if the source code contains Options API
composition_api	boolean Indicates if the source code contains Composition API (not in analysis)
async	boolean Indicates if the component uses asynchronous logic
pre_default	string Code between imports and export default in the component
post_default	string Code after export default in the component
bytes	integer Size of the component code in bytes
commits	integer The number of commits related to the component
vue_play_version	string The version of Vue Play used during the analysis

Responses

Request samples

Payload
Feathers

Content type

application/json

{"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze by ID

Retrieves an analyze based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyzes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze by ID

Updates an analyze based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze object that needs to be updated

application_id required	integer ID of the application being analyzed
name required	string Name of the component being analyzed
template	string The template content of the component
setup	string The setup function content of the component
render	string The render function content of the component
inherit_attrs	boolean Whether the component inherits attributes
options_api	boolean Indicates if the source code contains Options API
composition_api	boolean Indicates if the source code contains Composition API (not in analysis)
async	boolean Indicates if the component uses asynchronous logic
pre_default	string Code between imports and export default in the component
post_default	string Code after export default in the component
bytes	integer Size of the component code in bytes
commits	integer The number of commits related to the component
vue_play_version	string The version of Vue Play used during the analysis

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze by ID

Patches an analyze based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze object that needs to be updated

application_id required	integer ID of the application being analyzed
name required	string Name of the component being analyzed
template	string The template content of the component
setup	string The setup function content of the component
render	string The render function content of the component
inherit_attrs	boolean Whether the component inherits attributes
options_api	boolean Indicates if the source code contains Options API
composition_api	boolean Indicates if the source code contains Composition API (not in analysis)
async	boolean Indicates if the component uses asynchronous logic
pre_default	string Code between imports and export default in the component
post_default	string Code after export default in the component
bytes	integer Size of the component code in bytes
commits	integer The number of commits related to the component
vue_play_version	string The version of Vue Play used during the analysis

Responses

Request samples

Payload

Content type

application/json

{"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze by ID

Deletes an analyze based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"name": "string",
"template": "string",
"setup": "string",
"render": "string",
"inherit_attrs": true,
"options_api": true,
"composition_api": true,
"async": true,
"pre_default": "string",
"post_default": "string",
"bytes": 0,
"commits": 0,
"vue_play_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Components

Retrieve a list of Analyze Components

Returns a list of Analyze Components.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_components').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze component

Creates a new analyze component based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze component object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the component in the analysis
source required	string Source code of the component being analyzed

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze component by ID

Retrieves an analyze component based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_components').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze component by ID

Updates an analyze component based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze component object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the component in the analysis
source required	string Source code of the component being analyzed

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze component by ID

Patches an analyze component based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze component object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the component in the analysis
source required	string Source code of the component being analyzed

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze component by ID

Deletes an analyze component based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Computed

Retrieve a list of Analyze Computed

Returns a list of Analyze Computed.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_computed').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze computed

Creates a new analyze computed based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze computed object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the computed property
value required	string Value of the computed property

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze computed by ID

Retrieves an analyze computed based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_computed').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze computed by ID

Updates an analyze computed based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze computed object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the computed property
value required	string Value of the computed property

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze computed by ID

Patches an analyze computed based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze computed object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the computed property
value required	string Value of the computed property

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze computed by ID

Deletes an analyze computed based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Data

Retrieve a list of Analyze Data

Returns a list of Analyze Data.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_data').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze data

Creates a new analyze data based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze data object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the data entry
value required	string Value of the data entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze data by ID

Retrieves an analyze data based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_data').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze data by ID

Updates an analyze data based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze data object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the data entry
value required	string Value of the data entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze data by ID

Patches an analyze data based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze data object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the data entry
value required	string Value of the data entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze data by ID

Deletes an analyze data based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Directives

Retrieve a list of Analyze Directives

Returns a list of Analyze Directives.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_directives').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze directive

Creates a new analyze directive based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze directive object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the directive entry
value required	string Value of the directive entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze directive by ID

Retrieves an analyze directive based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_directives').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze directive by ID

Updates an analyze directive based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze directive object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the directive entry
value required	string Value of the directive entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze directive by ID

Patches an analyze directive based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze directive object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the directive entry
value required	string Value of the directive entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze directive by ID

Deletes an analyze directive based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Emitters

Retrieve a list of Analyze emitters

Returns a list of Analyze emitters.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_emits').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze emitter

Creates a new analyze emitter based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze Emit object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the emit entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze emitter by ID

Retrieves an analyze emitter based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_emits').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze emitter by ID

Updates an analyze emitter based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze Emit object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the emit entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze emitter by ID

Patches an analyze emitter based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze Emit object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the emit entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze emitter by ID

Deletes an analyze emitter based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Exposers

Retrieve a list of Analyze exposers

Returns a list of Analyze exposers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_expose').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze expose

Creates a new analyze expose based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze Expose object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the expose entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze expose by ID

Retrieves an analyze expose based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_expose').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze expose by ID

Updates an analyze expose based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze Expose object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the expose entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze expose by ID

Patches an analyze expose based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze Expose object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the expose entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze expose by ID

Deletes an analyze expose based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Extensions

Retrieve a list of Analyze extensions

Returns a list of Analyze extensions.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_extends').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze extension

Creates a new analyze extension based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze extension object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the extend entry
source required	string Source related to the extend entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze extension by ID

Retrieves an analyze extension based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_extends').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze extension by ID

Updates an analyze extension based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze extension object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the extend entry
source required	string Source related to the extend entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze extension by ID

Patches an analyze extension based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze extension object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the extend entry
source required	string Source related to the extend entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze extension by ID

Deletes an analyze extension based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Imports

Retrieve a list of Analyze Imports

Returns a list of Analyze Imports.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_imports').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze import

Creates a new analyze import based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze import object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the import entry
source required	string Source related to the import entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze import by ID

Retrieves an analyze import based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_imports').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze import by ID

Updates an analyze import based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze import object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the import entry
source required	string Source related to the import entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze import by ID

Patches an analyze import based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze import object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the import entry
source required	string Source related to the import entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze import by ID

Deletes an analyze import based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Inject

Retrieve a list of Analyze Inject

Returns a list of Analyze Inject.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_inject').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze injection

Creates a new analyze injection based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze inject object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the inject entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze injection by ID

Retrieves an analyze injection based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_inject').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze injection by ID

Updates an analyze injection based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze inject object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the inject entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze injection by ID

Patches an analyze injection based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze inject object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the inject entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze injection by ID

Deletes an analyze injection based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze LifeCycleHooks

Retrieve a list of Analyze LifeCycleHooks

Returns a list of Analyze LifeCycleHooks.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_lifecycle_hooks').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze lifecycle hook

Creates a new analyze lifecycle hook based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze lifecycle hook object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Key identifying the lifecycle hook (e.g., 'beforeCreate', 'mounted', etc.)
value required	string Code or data associated with the lifecycle hook

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze lifecycle hook by ID

Retrieves an analyze lifecycle hook based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_lifecycle_hooks').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze lifecycle hook by ID

Updates an analyze lifecycle hook based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze lifecycle hook object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the lifecycle hook (e.g., 'beforeCreate', 'mounted', etc.)
value required	string Code or data associated with the lifecycle hook

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze lifecycle hook by ID

Patches an analyze lifecycle hook based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze lifecycle hook object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Key identifying the lifecycle hook (e.g., 'beforeCreate', 'mounted', etc.)
value required	string Code or data associated with the lifecycle hook

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze lifecycle hook by ID

Deletes an analyze lifecycle hook based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Methods

Retrieve a list of Analyze Methods

Returns a list of Analyze Methods.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_methods').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze method

Creates a new analyze method based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze method object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string Method name or identifier
value required	string Code or content associated with the method

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze method by ID

Retrieves an analyze method based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_methods').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze method by ID

Updates an analyze method based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze method object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Method name or identifier
value required	string Code or content associated with the method

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze method by ID

Patches an analyze method based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze method object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string Method name or identifier
value required	string Code or content associated with the method

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze method by ID

Deletes an analyze method based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Mixins

Retrieve a list of Analyze Mixins

Returns a list of Analyze Mixins.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_mixins').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze mixin

Creates a new analyze mixin based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze mixin object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the mixin
source required	string The source of the mixin (e.g., a path or URL)

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze mixin by ID

Retrieves an analyze mixin based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_mixins').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze mixin by ID

Updates an analyze mixin based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze mixin object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the mixin
source required	string The source of the mixin (e.g., a path or URL)

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze mixin by ID

Patches an analyze mixin based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze mixin object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the mixin
source required	string The source of the mixin (e.g., a path or URL)

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze mixin by ID

Deletes an analyze mixin based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Props

Retrieve a list of Analyze Props

Returns a list of Analyze Props.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_props').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze prop

Creates a new analyze prop based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze prop object that needs to be added

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the property
default	string The default value for the property
validator	string The validation rule for the property
required	boolean Default: false Whether the property is required
control	string The control type (e.g., input, checkbox)
additional	object Any additional configuration or metadata related to the property

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { }
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze prop by ID

Retrieves an analyze prop based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_props').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze prop by ID

Updates an analyze prop based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze prop object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the property
default	string The default value for the property
validator	string The validation rule for the property
required	boolean Default: false Whether the property is required
control	string The control type (e.g., input, checkbox)
additional	object Any additional configuration or metadata related to the property

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { }
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze prop by ID

Patches an analyze prop based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze prop object that needs to be updated

analyze_id required	integer ID of the related analysis
key required	string The name or identifier of the property
default	string The default value for the property
validator	string The validation rule for the property
required	boolean Default: false Whether the property is required
control	string The control type (e.g., input, checkbox)
additional	object Any additional configuration or metadata related to the property

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { }
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze prop by ID

Deletes an analyze prop based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"default": "string",
"validator": "string",
"required": false,
"control": "string",
"additional": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze PropsOptions

Retrieve a list of Analyze PropsOptions

Returns a list of Analyze PropsOptions.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_props_options').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze props option

Creates a new analyze props option based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze props option object that needs to be added

analyze_prop_id required	integer ID of the related property
name required	string The name or key of the option
value required	string The value of the option

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_prop_id": 0,
"name": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze props option by ID

Retrieves an analyze props option based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_props_options').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze props option by ID

Updates an analyze props option based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze props option object that needs to be updated

analyze_prop_id required	integer ID of the related property
name required	string The name or key of the option
value required	string The value of the option

Responses

Request samples

Payload

Content type

application/json

{"analyze_prop_id": 0,
"name": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze props option by ID

Patches an analyze props option based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze props option object that needs to be updated

analyze_prop_id required	integer ID of the related property
name required	string The name or key of the option
value required	string The value of the option

Responses

Request samples

Payload

Content type

application/json

{"analyze_prop_id": 0,
"name": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze props option by ID

Deletes an analyze props option based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"name": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze PropsTypes

Retrieve a list of Analyze PropsTypes

Returns a list of Analyze PropsTypes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_props_types').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze props type

Creates a new analyze props type based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze props type object that needs to be added

analyze_prop_id required	integer ID of the related property
type required	string The data type of the property (e.g., String, Number, Boolean, Array, Object, Function, Symbol, Any, or a combination [Type1, Type2])

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_prop_id": 0,
"type": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze props type by ID

Retrieves an analyze props type based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_props_types').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze props type by ID

Updates an analyze props type based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze props type object that needs to be updated

analyze_prop_id required	integer ID of the related property
type required	string The data type of the property (e.g., String, Number, Boolean, Array, Object, Function, Symbol, Any, or a combination [Type1, Type2])

Responses

Request samples

Payload

Content type

application/json

{"analyze_prop_id": 0,
"type": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze props type by ID

Patches an analyze props type based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze props type object that needs to be updated

analyze_prop_id required	integer ID of the related property
type required	string The data type of the property (e.g., String, Number, Boolean, Array, Object, Function, Symbol, Any, or a combination [Type1, Type2])

Responses

Request samples

Payload

Content type

application/json

{"analyze_prop_id": 0,
"type": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze props type by ID

Deletes an analyze props type based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_prop_id": 0,
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Provide

Retrieve a list of Analyze Provide

Returns a list of Analyze Provide.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_provide').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze provition

Creates a new analyze provition based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze provition object that needs to be added

analyze_id required	integer ID of the related analyze
key required	string The key associated with the provide entry

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze provition by ID

Retrieves an analyze provition based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_provide').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze provition by ID

Updates an analyze provition based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze provition object that needs to be updated

analyze_id required	integer ID of the related analyze
key required	string The key associated with the provide entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze provition by ID

Patches an analyze provition based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze provition object that needs to be updated

analyze_id required	integer ID of the related analyze
key required	string The key associated with the provide entry

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze provition by ID

Deletes an analyze provition based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Styles

Retrieve a list of Analyze Styles

Returns a list of Analyze Styles.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_styles').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze style

Creates a new analyze style based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze style object that needs to be added

analyze_id required	integer ID of the related analyze
tag required	string The HTML tag associated with the styles
source	string The source URL or location of the styles

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"tag": "string",
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze style by ID

Retrieves an analyze style based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_styles').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze style by ID

Updates an analyze style based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze style object that needs to be updated

analyze_id required	integer ID of the related analyze
tag required	string The HTML tag associated with the styles
source	string The source URL or location of the styles

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"tag": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze style by ID

Patches an analyze style based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze style object that needs to be updated

analyze_id required	integer ID of the related analyze
tag required	string The HTML tag associated with the styles
source	string The source URL or location of the styles

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"tag": "string",
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze style by ID

Deletes an analyze style based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"tag": "string",
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Watchers

Retrieve a list of Analyze Watchers

Returns a list of Analyze Watchers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_watchers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze watcher

Creates a new analyze watcher based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze watcher object that needs to be added

analyze_id required	integer ID of the related analyze
key required	string The key associated with the watcher
value	string The value associated with the watcher

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze watcher by ID

Retrieves an analyze watcher based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_watchers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze watcher by ID

Updates an analyze watcher based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze watcher object that needs to be updated

analyze_id required	integer ID of the related analyze
key required	string The key associated with the watcher
value	string The value associated with the watcher

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze watcher by ID

Patches an analyze watcher based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze watcher object that needs to be updated

analyze_id required	integer ID of the related analyze
key required	string The key associated with the watcher
value	string The value associated with the watcher

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"key": "string",
"value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze watcher by ID

Deletes an analyze watcher based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

AnalyzeTemplates

Retrieve a list of AnalyzeTemplates

Returns a list of AnalyzeTemplates.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_templates').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze template

Creates a new analyze template based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

AnalyzeTemplate object that needs to be added

analyze_id required	integer ID of the related analyze
source	string The source URL or location of the template

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"source": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze template by ID

Retrieves an analyze template based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_templates').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze_templates by ID

Updates an analyze_templates based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AnalyzeTemplate object that needs to be updated

analyze_id required	integer ID of the related analyze
source	string The source URL or location of the template

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze_templates by ID

Patches an analyze_templates based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AnalyzeTemplate object that needs to be updated

analyze_id required	integer ID of the related analyze
source	string The source URL or location of the template

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"source": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze_templates by ID

Deletes an analyze_templates based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"source": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Analyze Slots

Retrieve a list of Analyze Slots

Returns a list of Analyze Slots.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('analyze_slots').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new analyze slotsion

Creates a new analyze slotsion based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Analyze slots object that needs to be added

analyze_id required	integer ID of the related analysis
name required	string Name of slot

Responses

Request samples

Payload
Feathers

Content type

application/json

{"analyze_id": 0,
"name": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an analyze slotsion by ID

Retrieves an analyze slotsion based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('analyze_slots').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an analyze slotsion by ID

Updates an analyze slotsion based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze slots object that needs to be updated

analyze_id required	integer ID of the related analysis
name required	string Name of slot

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"name": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an analyze slotsion by ID

Patches an analyze slotsion based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Analyze slots object that needs to be updated

analyze_id required	integer ID of the related analysis
name required	string Name of slot

Responses

Request samples

Payload

Content type

application/json

{"analyze_id": 0,
"name": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an analyze slotsion by ID

Deletes an analyze slotsion based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"analyze_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a list of Categories

Returns a list of Categories.

Responses

Request samples

Feathers

app.service('categories').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new category

Creates a new category based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Category object that needs to be added

title	string Title of the category
slug required	string Unique slug for the category
count	integer Default: 0 Count of items associated with the category

Responses

Request samples

Payload
Feathers

Content type

application/json

{"title": "string",
"slug": "string",
"count": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an category by ID

Retrieves an category based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('categories').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an category by ID

Updates an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
slug required	string Unique slug for the category
count	integer Default: 0 Count of items associated with the category

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"slug": "string",
"count": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an category by ID

Patches an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
slug required	string Unique slug for the category
count	integer Default: 0 Count of items associated with the category

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"slug": "string",
"count": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an category by ID

Deletes an category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Errors

Retrieve a list of Errors

Returns a list of Errors.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('errors').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new error

Creates a new error based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Error object that needs to be added

message

required

string

The error message

Responses

Request samples

Payload
Feathers

Content type

application/json

{"message": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an error by ID

Retrieves an error based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('errors').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an error by ID

Updates an error based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Error object that needs to be updated

message

required

string

The error message

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an error by ID

Patches an error based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Error object that needs to be updated

message

required

string

The error message

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an error by ID

Deletes an error based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Github

Callback endpoint for Github CICD authentication

Redirects to given app url on success.

query Parameters

code required	string Code to obtain access token.
a required	string Should have the format: "application_id\|redirect_url\|exchange_token"

Responses

Request samples

Browser

// Example for how to trigger this callback endpoint
const redirectUrl = `${serverUrl}/github?a=${appId}|${location.origin}|${exchangeToken}`
location.href = `https://github.com/login/oauth/authorize?client_id=${clientID}&scope=repo,delete_repo,workflow&redirect_uri=${redirectUrl}`

Response samples

400
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Callback endpoint for Github Webhooks

Currently not in use - Could potentially trigger builds on server in the future.

Request Body schema: application/json
required

Analyze object that needs to be added

ref required	string The git ref that was pushed.
before required	string The SHA of the commit before the push.
after required	string The SHA of the commit after the push.
required	object (Repository)
required	object (Pusher)
required	object (Organization)
required	object (Sender)
created required	boolean Indicates if the reference was created.
deleted required	boolean Indicates if the reference was deleted.
forced required	boolean Indicates if the push was forced.
base_ref	string or null The base ref of the push.
compare required	string <uri> URL to compare changes.
required	Array of objects (Commit)
required	object (Commit)

Responses

Request samples

Payload

Content type

application/json

{"ref": "string",
"before": "string",
"after": "string",
"repository": {"id": 0,
"node_id": "string",
"name": "string",
"full_name": "string",
"private": true,
"owner": {"name": "string",
"email": "user@example.com",
"login": "string",
"id": 0,
"node_id": "string",
"avatar_url": "http://example.com",
"gravatar_id": "string",
"url": "http://example.com",
"html_url": "http://example.com",
"followers_url": "http://example.com",
"following_url": "http://example.com",
"gists_url": "http://example.com",
"starred_url": "http://example.com",
"subscriptions_url": "http://example.com",
"organizations_url": "http://example.com",
"repos_url": "http://example.com",
"events_url": "http://example.com",
"received_events_url": "http://example.com",
"type": "string",
"site_admin": true
},
"html_url": "http://example.com",
"description": "string",
"fork": true,
"url": "http://example.com",
"forks_url": "http://example.com",
"keys_url": "http://example.com",
"collaborators_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"pushed_at": 0,
"git_url": "string",
"ssh_url": "string",
"clone_url": "http://example.com",
"svn_url": "http://example.com",
"homepage": "http://example.com",
"size": 0,
"stargazers_count": 0,
"watchers_count": 0,
"language": "string",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": true,
"has_discussions": true,
"forks_count": 0,
"mirror_url": "http://example.com",
"archived": true,
"disabled": true,
"open_issues_count": 0,
"license": { },
"allow_forking": true,
"is_template": true,
"web_commit_signoff_required": true,
"topics": ["string"
],
"visibility": "public",
"forks": 0,
"open_issues": 0,
"watchers": 0,
"default_branch": "string",
"stargazers": 0,
"master_branch": "string",
"organization": {"login": "string",
"id": 0,
"node_id": "string",
"url": "http://example.com",
"repos_url": "http://example.com",
"events_url": "http://example.com",
"hooks_url": "http://example.com",
"issues_url": "http://example.com",
"members_url": "http://example.com",
"public_members_url": "http://example.com",
"avatar_url": "http://example.com",
"description": "string"
},
"custom_properties": { }
},
"pusher": {"name": "string",
"email": "user@example.com"
},
"organization": {"login": "string",
"id": 0,
"node_id": "string",
"url": "http://example.com",
"repos_url": "http://example.com",
"events_url": "http://example.com",
"hooks_url": "http://example.com",
"issues_url": "http://example.com",
"members_url": "http://example.com",
"public_members_url": "http://example.com",
"avatar_url": "http://example.com",
"description": "string"
},
"sender": {"login": "string",
"id": 0,
"node_id": "string",
"avatar_url": "http://example.com",
"gravatar_id": "string",
"url": "http://example.com",
"html_url": "http://example.com",
"followers_url": "http://example.com",
"following_url": "http://example.com",
"gists_url": "http://example.com",
"starred_url": "http://example.com",
"subscriptions_url": "http://example.com",
"organizations_url": "http://example.com",
"repos_url": "http://example.com",
"events_url": "http://example.com",
"received_events_url": "http://example.com",
"type": "string",
"site_admin": true
},
"created": true,
"deleted": true,
"forced": true,
"base_ref": "string",
"compare": "http://example.com",
"commits": [{"id": "string",
"tree_id": "string",
"distinct": true,
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"author": {"name": "string",
"email": "user@example.com"
},
"committer": {"name": "string",
"email": "user@example.com"
},
"added": ["string"
],
"removed": ["string"
],
"modified": ["string"
]
}
],
"head_commit": {"id": "string",
"tree_id": "string",
"distinct": true,
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"author": {"name": "string",
"email": "user@example.com"
},
"committer": {"name": "string",
"email": "user@example.com"
},
"added": ["string"
],
"removed": ["string"
],
"modified": ["string"
]
}
}

Response samples

200
400
500

Content type

application/json

{"message": "string"
}

Icons

Retrieve a list of Icons

Returns a list of Icons.

Responses

Request samples

Feathers

app.service('icons').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new icon

Creates a new icon based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Icon object that needs to be added

title	string The title of the icon
slug required	string Unique slug for the icon
outline	string SVG or other vector path for the icon in its outline version
solid	string SVG or other vector path for the icon in its solid version
tags	string Tags or keywords associated with the icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an icon by ID

Retrieves an icon based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('icons').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an icon by ID

Updates an icon based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Icon object that needs to be updated

title	string The title of the icon
slug required	string Unique slug for the icon
outline	string SVG or other vector path for the icon in its outline version
solid	string SVG or other vector path for the icon in its solid version
tags	string Tags or keywords associated with the icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an icon by ID

Patches an icon based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Icon object that needs to be updated

title	string The title of the icon
slug required	string Unique slug for the icon
outline	string SVG or other vector path for the icon in its outline version
solid	string SVG or other vector path for the icon in its solid version
tags	string Tags or keywords associated with the icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an icon by ID

Deletes an icon based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"slug": "string",
"outline": "string",
"solid": "string",
"tags": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

RoleAccessScopes

Retrieve a list of RoleAccessScopes

Returns a list of RoleAccessScopes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('role_access_scopes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new role access scope

Creates a new role access scope based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

RoleAccessScope object that needs to be added

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload
Feathers

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an role access scope by ID

Retrieves an role access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('role_access_scopes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an role access scope by ID

Updates an role access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an role access scope by ID

Patches an role access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an role access scope by ID

Deletes an role access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Roles

Retrieve a list of Roles

Returns a list of Roles.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('roles').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new role

Creates a new role based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Role object that needs to be added

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload
Feathers

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an role by ID

Retrieves an role based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('roles').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an role by ID

Updates an role based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Role object that needs to be updated

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an role by ID

Patches an role based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Role object that needs to be updated

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an role by ID

Deletes an role based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

FeathersServices

Retrieve a list of all FeathersJS Services

Returns a list of all FeathersJS Services.

Responses

Request samples

Feathers

app.service('feathers_services').find({ query: {} })

Response samples

200
400
500

Content type

application/json

["string"
]

SSL Maintainers

Retrieve a list of SSL Maintainers

Returns a list of SSL Maintainers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('ssl_maintainers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new ssl maintainer

Creates a new ssl maintainer based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

SSLMaintainer object that needs to be added

account_holder required	string Name of the account holder
account_key	string Account key related to the maintainer
maintainer_email required	string Email of the maintainer
subscriber_email required	string Email of the subscriber
terms_accepted_user_id	integer ID of the user who accepted the terms
terms_accepted_at	string or null <date-time> Timestamp when the terms were accepted

Responses

Request samples

Payload
Feathers

Content type

application/json

{"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an ssl maintainer by ID

Retrieves an ssl maintainer based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('ssl_maintainers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an ssl maintainer by ID

Updates an ssl maintainer based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainer object that needs to be updated

account_holder required	string Name of the account holder
account_key	string Account key related to the maintainer
maintainer_email required	string Email of the maintainer
subscriber_email required	string Email of the subscriber
terms_accepted_user_id	integer ID of the user who accepted the terms
terms_accepted_at	string or null <date-time> Timestamp when the terms were accepted

Responses

Request samples

Payload

Content type

application/json

{"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an ssl maintainer by ID

Patches an ssl maintainer based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainer object that needs to be updated

account_holder required	string Name of the account holder
account_key	string Account key related to the maintainer
maintainer_email required	string Email of the maintainer
subscriber_email required	string Email of the subscriber
terms_accepted_user_id	integer ID of the user who accepted the terms
terms_accepted_at	string or null <date-time> Timestamp when the terms were accepted

Responses

Request samples

Payload

Content type

application/json

{"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an ssl maintainer by ID

Deletes an ssl maintainer based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"account_holder": "string",
"account_key": "string",
"maintainer_email": "string",
"subscriber_email": "string",
"terms_accepted_user_id": 0,
"terms_accepted_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

SSL Maintainer Users

Retrieve a list of SSL Maintainer Users

Returns a list of SSL Maintainer Users.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('ssl_maintainer_users').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new ssl maintainer user

Creates a new ssl maintainer user based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

SSLMaintainerUser object that needs to be added

ssl_maintainer_id required	integer ID of the SSL maintainer
user_id required	integer ID of the user associated with the SSL maintainer

Responses

Request samples

Payload
Feathers

Content type

application/json

{"ssl_maintainer_id": 0,
"user_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an ssl maintainer user by ID

Retrieves an ssl maintainer user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('ssl_maintainer_users').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an ssl maintainer user by ID

Updates an ssl maintainer user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainerUser object that needs to be updated

ssl_maintainer_id required	integer ID of the SSL maintainer
user_id required	integer ID of the user associated with the SSL maintainer

Responses

Request samples

Payload

Content type

application/json

{"ssl_maintainer_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an ssl maintainer user by ID

Patches an ssl maintainer user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainerUser object that needs to be updated

ssl_maintainer_id required	integer ID of the SSL maintainer
user_id required	integer ID of the user associated with the SSL maintainer

Responses

Request samples

Payload

Content type

application/json

{"ssl_maintainer_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an ssl maintainer user by ID

Deletes an ssl maintainer user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

SSL Maintainer Groups

Retrieve a list of SSL Maintainer Groups

Returns a list of SSL Maintainer Groups.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('ssl_maintainer_groups').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new ssl maintainer group

Creates a new ssl maintainer group based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

SSLMaintainerGroup object that needs to be added

ssl_maintainer_id required	integer ID of the SSL maintainer
access_group_id required	integer ID of the access group associated with the SSL maintainer

Responses

Request samples

Payload
Feathers

Content type

application/json

{"ssl_maintainer_id": 0,
"access_group_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an ssl maintainer group by ID

Retrieves an ssl maintainer group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('ssl_maintainer_groups').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an ssl maintainer group by ID

Updates an ssl maintainer group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainerGroup object that needs to be updated

ssl_maintainer_id required	integer ID of the SSL maintainer
access_group_id required	integer ID of the access group associated with the SSL maintainer

Responses

Request samples

Payload

Content type

application/json

{"ssl_maintainer_id": 0,
"access_group_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an ssl maintainer group by ID

Patches an ssl maintainer group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

SSLMaintainerGroup object that needs to be updated

ssl_maintainer_id required	integer ID of the SSL maintainer
access_group_id required	integer ID of the access group associated with the SSL maintainer

Responses

Request samples

Payload

Content type

application/json

{"ssl_maintainer_id": 0,
"access_group_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an ssl maintainer group by ID

Deletes an ssl maintainer group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"ssl_maintainer_id": 0,
"access_group_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a list of Tags

Returns a list of Tags.

Responses

Request samples

Feathers

app.service('tags').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new tag

Creates a new tag based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Tag object that needs to be added

slug required	string Unique slug for the tag
approved	boolean Default: false Indicates if the tag has been approved
rejected	boolean Default: false Indicates if the tag has been rejected
count	integer Default: 0 Count of items associated with the tag

Responses

Request samples

Payload
Feathers

Content type

application/json

{"slug": "string",
"approved": false,
"rejected": false,
"count": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an tag by ID

Retrieves an tag based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('tags').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an tag by ID

Updates an tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tag object that needs to be updated

slug required	string Unique slug for the tag
approved	boolean Default: false Indicates if the tag has been approved
rejected	boolean Default: false Indicates if the tag has been rejected
count	integer Default: 0 Count of items associated with the tag

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"approved": false,
"rejected": false,
"count": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an tag by ID

Patches an tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tag object that needs to be updated

slug required	string Unique slug for the tag
approved	boolean Default: false Indicates if the tag has been approved
rejected	boolean Default: false Indicates if the tag has been rejected
count	integer Default: 0 Count of items associated with the tag

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"approved": false,
"rejected": false,
"count": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an tag by ID

Deletes an tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"slug": "string",
"approved": false,
"rejected": false,
"count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Elements

Retrieve a list of Elements

Returns a list of Elements.

Responses

Request samples

Feathers

app.service('elements').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new element

Creates a new element based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Element object that needs to be added

category_id	integer
title	string Title of the element
description	string Description for the element
tag required	string Unique tag for the element
keywords	string Comma separated keywords
void	boolean True if element can not have child elements
interactive	boolean True if element have interactive events
global_attributes	boolean True if element support global attributes
experimental	boolean True if element is experimental
deprecated	boolean True if element is deprecated
premium	boolean True if element is only available for premium users
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an element by ID

Retrieves an element based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('elements').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an element by ID

Updates an element based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element object that needs to be updated

category_id	integer
title	string Title of the element
description	string Description for the element
tag required	string Unique tag for the element
keywords	string Comma separated keywords
void	boolean True if element can not have child elements
interactive	boolean True if element have interactive events
global_attributes	boolean True if element support global attributes
experimental	boolean True if element is experimental
deprecated	boolean True if element is deprecated
premium	boolean True if element is only available for premium users
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an element by ID

Patches an element based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element object that needs to be updated

category_id	integer
title	string Title of the element
description	string Description for the element
tag required	string Unique tag for the element
keywords	string Comma separated keywords
void	boolean True if element can not have child elements
interactive	boolean True if element have interactive events
global_attributes	boolean True if element support global attributes
experimental	boolean True if element is experimental
deprecated	boolean True if element is deprecated
premium	boolean True if element is only available for premium users
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an element by ID

Deletes an element based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"tag": "string",
"keywords": "string",
"void": true,
"interactive": true,
"global_attributes": true,
"experimental": true,
"deprecated": true,
"premium": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Element Categories

Retrieve a list of Categories

Returns a list of Categories.

Responses

Request samples

Feathers

app.service('element_categories').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new category

Creates a new category based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Category object that needs to be added

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an category by ID

Retrieves an category based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('element_categories').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an category by ID

Updates an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an category by ID

Patches an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an category by ID

Deletes an category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Controls

Retrieve a list of Controls

Returns a list of Controls.

Responses

Request samples

Feathers

app.service('controls').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new control

Creates a new control based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Control object that needs to be added

slug	string Unique identifier for the control
title	string Title for the control
description	string Description for the control
accepts	Array of strings List of types the control accepts
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an control by ID

Retrieves an control based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('controls').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an control by ID

Updates an control based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Control object that needs to be updated

slug	string Unique identifier for the control
title	string Title for the control
description	string Description for the control
accepts	Array of strings List of types the control accepts
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an control by ID

Patches an control based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Control object that needs to be updated

slug	string Unique identifier for the control
title	string Title for the control
description	string Description for the control
accepts	Array of strings List of types the control accepts
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an control by ID

Deletes an control based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"application_id": 0,
"slug": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Attributes

Retrieve a list of Attributes

Returns a list of Attributes.

Responses

Request samples

Feathers

app.service('attributes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new attribute

Creates a new attribute based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Attribute object that needs to be added

type	string Enum: "property" "event" "slot" "directive"
attribute	string Tag of the attribute
title	string Title of the attribute
description	string Description for the attribute
accepts	Array of strings List of types the attribute accepts
global	boolean True if attribute is global, eg. style & class
void	boolean True if attribute can be void, eg. disabled
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an attribute by ID

Retrieves an attribute based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('attributes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an attribute by ID

Updates an attribute based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Attribute object that needs to be updated

type	string Enum: "property" "event" "slot" "directive"
attribute	string Tag of the attribute
title	string Title of the attribute
description	string Description for the attribute
accepts	Array of strings List of types the attribute accepts
global	boolean True if attribute is global, eg. style & class
void	boolean True if attribute can be void, eg. disabled
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an attribute by ID

Patches an attribute based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Attribute object that needs to be updated

type	string Enum: "property" "event" "slot" "directive"
attribute	string Tag of the attribute
title	string Title of the attribute
description	string Description for the attribute
accepts	Array of strings List of types the attribute accepts
global	boolean True if attribute is global, eg. style & class
void	boolean True if attribute can be void, eg. disabled
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an attribute by ID

Deletes an attribute based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"control_id": 0,
"type": "property",
"attribute": "string",
"title": "string",
"description": "string",
"accepts": ["boolean",
"number",
"object"
],
"global": true,
"void": true,
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Element Attributes

Retrieve a list of Element attributes

Returns a list of Element attributes.

Responses

Request samples

Feathers

app.service('element_attributes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new element attribute

Creates a new element attribute based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Element Attribute object that needs to be added

required

boolean

If attribute is required for the element

Responses

Request samples

Payload
Feathers

Content type

application/json

{"required": true
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an element attribute by ID

Retrieves an element attribute based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('element_attributes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an element attribute by ID

Updates an element attribute based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element Attribute object that needs to be updated

required

boolean

If attribute is required for the element

Responses

Request samples

Payload

Content type

application/json

{"required": true
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an element attribute by ID

Patches an element attribute based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element Attribute object that needs to be updated

required

boolean

If attribute is required for the element

Responses

Request samples

Payload

Content type

application/json

{"required": true
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an element attribute by ID

Deletes an element attribute based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"attribute_id": 0,
"required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Element Rules

Retrieve a list of Element rules

Returns a list of Element rules.

Responses

Request samples

Feathers

app.service('element_rules').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new element rule

Creates a new element rule based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Element Rule object that needs to be added

rule	string Enum: "include" "exclude"
child_id	string Child element to include or exclude

Responses

Request samples

Payload
Feathers

Content type

application/json

{"rule": "include",
"child_id": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an element rule by ID

Retrieves an element rule based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('element_rules').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an element rule by ID

Updates an element rule based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element Rule object that needs to be updated

rule	string Enum: "include" "exclude"
child_id	string Child element to include or exclude

Responses

Request samples

Payload

Content type

application/json

{"rule": "include",
"child_id": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an element rule by ID

Patches an element rule based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Element Rule object that needs to be updated

rule	string Enum: "include" "exclude"
child_id	string Child element to include or exclude

Responses

Request samples

Payload

Content type

application/json

{"rule": "include",
"child_id": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an element rule by ID

Deletes an element rule based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"element_id": 0,
"rule": "include",
"child_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Section Categories

Retrieve a list of Categories

Returns a list of Categories.

Responses

Request samples

Feathers

app.service('section_categories').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new category

Creates a new category based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Category object that needs to be added

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an category by ID

Retrieves an category based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('section_categories').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an category by ID

Updates an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an category by ID

Patches an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

title	string Title of the category
description	string Description for the category
slug required	string Unique slug for the category
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"slug": "string",
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an category by ID

Deletes an category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"title": "string",
"description": "string",
"slug": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Sections

Retrieve a list of Sections

Returns a list of Sections.

Responses

Request samples

Feathers

app.service('sections').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new section

Creates a new section based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Section object that needs to be added

category_id	integer
title	string Title of the section
description	string Description for the section
keywords	string Comma separated keywords
premium	boolean True if section is only available for premium users
source	object Source code ast as object
icon	string SVG or url to icon

Responses

Request samples

Payload
Feathers

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an section by ID

Retrieves an section based on the provided ID.

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('sections').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an section by ID

Updates an section based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Section object that needs to be updated

category_id	integer
title	string Title of the section
description	string Description for the section
keywords	string Comma separated keywords
premium	boolean True if section is only available for premium users
source	object Source code ast as object
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an section by ID

Patches an section based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Section object that needs to be updated

category_id	integer
title	string Title of the section
description	string Description for the section
keywords	string Comma separated keywords
premium	boolean True if section is only available for premium users
source	object Source code ast as object
icon	string SVG or url to icon

Responses

Request samples

Payload

Content type

application/json

{"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an section by ID

Deletes an section based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"category_id": 0,
"title": "string",
"description": "string",
"keywords": "string",
"premium": true,
"source": { },
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Packet Management

npm install

Downloads the tarball for a specific packet version. To download private packets, add the following to your .npmrc: //manager.vueplay.com/:_authToken=your-vueplay-auth-token-here

Authorizations:

npmAuthTokenbearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

npm install

npm install https://manager.vueplay.com/{packet}@{version}

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get package.json File

Retrieves the package.json file for a specific packet version.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/pkg`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching package.json')
}
const data = await response.json()

Response samples

200
404
500

Content type

packetlication/json

{ }

Get Packet.vue File

Retrieves the Packet.vue file for a specific packet version.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/vue`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching Packet.vue')
}
const text = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get PacketCDN.vue File

Retrieves the PacketCDN.vue file with dependencies resolved by CDN.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/vue-cdn`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching PacketCDN.vue')
}
const text = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get PacketCDNScoped.vue File

Retrieves the PacketCDNScoped.vue file with dependencies resolved by CDN and unique scoping.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/vue-cdn-scoped`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching PacketCDNScoped.vue')
}
const text = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get ESM Module

Retrieves the index.mjs file compiled by Vite with unresolved dependencies.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/esm`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching ESM module')
}
const script = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Resolved ESM Module

Retrieves the index-resolved.mjs file compiled by Vite with resolved dependencies.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/esm-resolved`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching resolved ESM module')
}
const script = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Lightweight ESM Module

Retrieves the index-light.mjs file compiled by Vue Play with unresolved dependencies and styles packetended to the options API.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/esm-light`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching lightweight ESM module')
}
const script = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Resolved Lightweight ESM Module

Retrieves the index-light-resolved.mjs file compiled by Vue Play with resolved dependencies and styles packetended to the options API.

Authorizations:

bearerAuthNone

path Parameters

packet required	string The name of the packet.
version required	string The version of the packet.

Responses

Request samples

fetch

const response = await fetch(`/${packet}@${version}/esm-light-resolved`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching resolved lightweight ESM module')
}
const script = await response.text()

Response samples

404
500

Content type

packetlication/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Packet History

Retrieves the Git history for a specified packet.

Authorizations:

bearerAuthNone

path Parameters

packet

required

string

The name of the packet.

Responses

Request samples

fetch

const response = await fetch(`/history/${packet}`, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
if (!response.ok) {
  const errorData = await response.json()
  throw new Error(errorData.message || 'Error fetching history')
}
const data = await response.json()

Response samples

200
400
404
500

Content type

packetlication/json

{"history": [{"oid": "string",
"commit": {"message": "string",
"parent": ["string"
],
"tree": "string",
"author": {"name": "string",
"email": "string",
"timestamp": 0,
"timezoneOffset": 0
},
"committer": {"name": "string",
"email": "string",
"timestamp": 0,
"timezoneOffset": 0
}
},
"payload": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}

Vue Play Packets Manager API (1.0.0)

Authentication

User login

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Access Scopes

Retrieve a list of Access Scopes

Authorizations:

Responses

Request samples

Response samples

Create a new access scope

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an access scope by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update an access scope by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch an access scope by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an access scope by ID

Authorizations:

path Parameters

Responses

Response samples

Applications

Retrieve a list of Applications

Authorizations:

Responses

Request samples

Response samples

Create a new application

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an application by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update an application by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch an application by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an application by ID

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required