[−][src]Module jsonapi::api
Defines custom types and structs primarily that composite the JSON:API document
Structs
ErrorSource | Error location |
JsonApiDocument | The specification refers to this as a top-level |
JsonApiError | JSON-API Error All fields are optional |
JsonApiInfo | Optional |
Pagination | Pagination links |
Patch | |
PatchSet | |
Relationship | Relationship with another object |
Resource | Representation of a JSON:API resource. This is a struct that contains
attributes that map to the JSON:API specification of |
ResourceIdentifier | Resource Identifier |
Enums
DiffPatchError | |
DocumentValidationError | Top-level (Document) JSON-API specification violations |
IdentifierData | Valid Resource Identifier (can be None) |
JsonApiDataError | |
PatchType | |
PrimaryData | Valid data Resource (can be None) |
RelationshipAssumptionError |
Type Definitions
Included | Side-loaded Resources |
JsonApiErrors | Data-related errors |
JsonApiId | |
JsonApiIds | |
JsonApiValue | Permitted JSON-API values (all JSON Values) |
Links | |
Meta | Meta-data object, can contain any data |
Relationships | Map of relationships with other objects |
ResourceAttributes | Resource Attributes, can be any JSON value |
ResourceIdentifiers | Vector of |
Resources | Vector of |