Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EndpointCount ¶ added in v1.260519.0
EndpointCount returns the number of endpoints in the embedded schema index.
Types ¶
type Endpoint ¶
type Endpoint struct {
Method string `json:"method"`
Path string `json:"path"`
Parameters []Parameter `json:"parameters,omitempty"`
RequestSchema string `json:"requestSchema,omitempty"`
RequestAttributes map[string]any `json:"requestAttributes,omitempty"`
RequestRelationships map[string]RequestRelationship `json:"requestRelationships,omitempty"`
ResponseSchema string `json:"responseSchema,omitempty"`
}
Endpoint is a compact representation of an API endpoint.
type Parameter ¶
type Parameter struct {
Name string `json:"name"`
In string `json:"in"`
Enum []string `json:"enum,omitempty"`
Required bool `json:"required,omitempty"`
}
Parameter describes a query/path parameter.
type RequestRelationship ¶ added in v1.260722.0
type RequestRelationship struct {
ResourceType string `json:"resourceType"`
Cardinality string `json:"cardinality"`
Required bool `json:"required"`
}
RequestRelationship describes a JSON:API relationship accepted by a request.
Click to show internal directories.
Click to hide internal directories.