logo
API docs by Redocly

Vue Play Hub API (1.0.0)

Download OpenAPI specification:Download

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

API documentation for FeathersJS service including hub functionality.

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

Content type
application/json
{
  • "strategy": "jwt",
  • "accessToken": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string"
}

Jobs

Retrieve a list of Jobs

Returns a list of Jobs.

Responses

Request samples 

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

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Dispatch a new job

Creates a new job queued on scheduled_at.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Job object that needs to be added

task
required
string
Enum: "user-delete" "build"
payload
object

Payload for task

attempts
integer
attempts_max
integer
scheduled_at
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "task": "user-delete",
  • "payload": { },
  • "attempts": 0,
  • "attempts_max": 0,
  • "scheduled_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "state": "queued",
  • "task": "user-delete",
  • "payload": { },
  • "logs": "string",
  • "attempts": 0,
  • "attempts_max": 0,
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a job by ID

Retrieves a job based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 1
await app.service('jobs').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "state": "queued",
  • "task": "user-delete",
  • "payload": { },
  • "logs": "string",
  • "attempts": 0,
  • "attempts_max": 0,
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Aborts a job by ID

Aborts a job based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "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 

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

Response samples

Content type
application/json
[
  • "string"
]