api

type API struct {
	ServerURL string `json:"server_url"`
	Name      string
	Contact   *Contact
	Schemas   map[string]*openapi.Schema
	// A list of the resources that are exposed by the API.
	//
	// The key "operation" carries a special meaning, and must
	// map to an aep.dev/151 Operation resource.
	Resources map[string]*Resource
}

type ApplyMethod struct {
	IsLongRunning bool `json:"is_long_running"`
}

type Contact struct {
	Name  string
	Email string
	URL   string
}

type CreateMethod struct {
	SupportsUserSettableCreate bool `json:"supports_user_settable_create"`
	IsLongRunning              bool `json:"is_long_running"`
}

type CustomMethod struct {
	Name          string
	Method        string
	Request       *openapi.Schema
	Response      *openapi.Schema
	IsLongRunning bool `json:"is_long_running"`
}

type DeleteMethod struct {
	IsLongRunning bool `json:"is_long_running"`
}

type GetMethod struct {
}

type ListMethod struct {
	HasUnreachableResources bool `json:"has_unreachable_resources"`
	SupportsFilter          bool `json:"supports_filter"`
	SupportsSkip            bool `json:"supports_skip"`
}

type Methods struct {
	Get    *GetMethod    `json:"get,omitempty"`
	List   *ListMethod   `json:"list,omitempty"`
	Apply  *ApplyMethod  `json:"apply,omitempty"`
	Create *CreateMethod `json:"create,omitempty"`
	Update *UpdateMethod `json:"update,omitempty"`
	Delete *DeleteMethod `json:"delete,omitempty"`
}

type PathWithParams struct {
	Pattern string
	Params  []openapi.Parameter
}

type PatternInfo struct {
	// if true, the pattern represents an individual resource,
	// otherwise it represents a path to a collection of resources
	IsResourcePattern bool
	CustomMethodName  string
}

type Resource struct {
	// the resource singular name is the name of the resource
	// in the API. It is used to generate the pattern for the resource.
	// e.g: book-edition -> book-editions
	//
	// The singular name is also used to generate the schema name.
	// e.g: book-edition -> BookEdition
	//
	// the resource singular **must** be in kebab-case.
	Singular string   `json:"singular"`
	Plural   string   `json:"plural"`
	Parents  []string `json:"parents,omitempty"`

	// Children is populated on load
	Children []*Resource `json:"-"`

	// the API reference is used to retrieve things like the parent resources.
	API           *API            `json:"-"`
	Schema        *openapi.Schema `json:"schema,omitempty"`
	Methods       Methods         `json:"methods,omitempty"`
	CustomMethods []*CustomMethod `json:"custom_methods,omitempty"`
	// contains filtered or unexported fields
}

type UpdateMethod struct {
	IsLongRunning bool `json:"is_long_running"`
}