jsonapi

Documentation

Index

• type Envelope
• type ErrorData
• type ErrorResponse
• type ErrorSourcePointer
• type RequestBody
• type RequestResource
• type ResourceMetadata
• type Response
• type ResponseMetadata
• type ResponseResource

Types

type Envelope

type Envelope map[string]any

Envelope

type ErrorData

type ErrorData struct {
	Source *ErrorSourcePointer `json:"source,omitempty"`
	Title  string              `json:"title"`
	Detail string              `json:"detail"`
}

ErrorData

type ErrorResponse

type ErrorResponse struct {
	Errors []ErrorData `json:"errors"`
}

ErrorResponse

type ErrorSourcePointer

type ErrorSourcePointer struct {
	Pointer string `json:"pointer,omitempty"`
}

ErrorSourcePointer

type RequestBody

type RequestBody struct {
	Data *RequestResource `json:"data" validate:"required"`
}

RequestBody

type RequestResource

type RequestResource struct {
	Type       string `json:"type" validate:"required"`
	ID         string `json:"id" validate:"omitempty,uuid4"`
	Attributes any    `json:"attributes" validate:"required"`
}

RequestResource

type ResourceMetadata

type ResourceMetadata struct{}

ResourceMetadata

type Response

type Response struct {
	Meta *ResponseMetadata `json:"meta"`
	Data any               `json:"data"`
}

Response

type ResponseMetadata

type ResponseMetadata struct {
	Page pagination.PageMetadata `json:"page,omitempty"`
}

ResponseMetadata

type ResponseResource

type ResponseResource struct {
	Type       string            `json:"type"`
	ID         uuid.UUID         `json:"id"`
	Meta       *ResourceMetadata `json:"meta,omitempty"`
	Attributes any               `json:"attributes"`
}

Resource