model

Documentation

Index

• type BadRequestResponse
• type CreatedResponse
• type GenericResponse
• type InternalServerErrorResponse
• type LoginResponse
• type Note
• type NoteIndexResponse
• type NoteShowResponse
• type OKResponse
• type UnauthorizedResponse

Types

type BadRequestResponse

type BadRequestResponse struct {
	GenericResponse
}

BadRequestResponse returns 400. swagger:response BadRequestResponse

type CreatedResponse

type CreatedResponse struct {
	// in: body
	Body struct {
		// Status contains the string of the HTTP status.
		//
		// Required: true
		Status string `json:"status"`
		// RecordID can be used for returning the ID from a row.
		RecordID string `json:"record_id,omitempty"`
	}
}

CreatedResponse returns 201. swagger:response CreatedResponse

type GenericResponse

type GenericResponse struct {
	// in: body
	Body struct {
		// Status contains the string of the HTTP status.
		//
		// Required: true
		Status string `json:"status"`
		// Message can contain a user friendly message.
		Message string `json:"message,omitempty"`
	}
}

GenericResponse returns any status code.

type InternalServerErrorResponse

type InternalServerErrorResponse struct {
	GenericResponse
}

InternalServerErrorResponse returns 500. swagger:response InternalServerErrorResponse

type LoginResponse

type LoginResponse struct {
	// in: body
	Body struct {
		// Required: true
		Status string `json:"status"`
		// Required: true
		Token string `json:"token"`
	}
}

LoginResponse returns 200. swagger:response LoginResponse

type Note

type Note struct {
	// Required: true
	UserID string `json:"id"`
	// Required: true
	Message string `json:"message"`
}

Note is a note of a user.

type NoteIndexResponse

type NoteIndexResponse struct {
	// in: body
	Body struct {
		// Required: true
		Notes []Note `json:"notes"`
	}
}

NoteIndexResponse returns 200. swagger:response NoteIndexResponse

type NoteShowResponse

type NoteShowResponse struct {
	// in: body
	Body struct {
		// Required: true
		Note
	}
}

NoteShowResponse returns 200. swagger:response NoteShowResponse

type OKResponse

type OKResponse struct {
	GenericResponse
}

OKResponse returns 200. swagger:response OKResponse

type UnauthorizedResponse

type UnauthorizedResponse struct {
	GenericResponse
}

UnauthorizedResponse returns 401. swagger:response UnauthorizedResponse