schema

Documentation

Overview

Package schema defines the interfaces accepted and returned by the yFuzz API.

Index

• type CreateJobRequest
• type CreateJobResponse
• type GetJobLogsResponse
• type GetJobStatusResponse
• type GetVersionResponse
• type ListJobsResponse
• type MessageHolder

Types

type CreateJobRequest

type CreateJobRequest struct {
	Image string `json:"image"`
}

CreateJobRequest is the schema for the request to the POST /jobs endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#CreateJob

type CreateJobResponse

type CreateJobResponse struct {
	Job string `json:"job"`
}

CreateJobResponse is the schema for the response from the POST /jobs endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#CreateJob

type GetJobLogsResponse

type GetJobLogsResponse struct {
	Logs []string `json:"logs"`
}

GetJobLogsResponse is the schema for the response from the GET /jobs/:job/logs endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetJobLogs

type GetJobStatusResponse

type GetJobStatusResponse struct {
	StatusCrashFound int `json:"crash_found"`
	StatusNoCrash    int `json:"no_crash"`
	StatusPending    int `json:"pending"`
	StatusRunning    int `json:"running"`
	StatusFailed     int `json:"failed"`
	StatusUnknown    int `json:"unknown"`
}

GetJobStatusResponse is the schema for the respone from the GET /jobs/:job endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetJobStatus

type GetVersionResponse

type GetVersionResponse struct {
	Version string `json:"version"`
}

GetVersionResponse is the schema for the response from the GET /version endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetVersion

type ListJobsResponse

type ListJobsResponse struct {
	Jobs []string `json:"jobs"`
}

ListJobsResponse is the schema for the response from the GET /jobs endpoint. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#ListJobs

type MessageHolder

type MessageHolder struct {
	Message string `json:"message"`
}

MessageHolder is a way to return a string that will serialize nicely.