Module jsonapi::api
[−]
[src]
Structs
ErrorSource |
Error location |
JsonApiDocument |
The specification refers to this as a top-level |
JsonApiError |
JSON-API Error All fields are optional |
JsonApiInfo |
Optional JsonApiDocument payload identifying the JSON-API version the server implements |
Pagination |
Pagination links |
Relationship |
Relationship with another object |
Resource |
JSON-API Resource |
ResourceIdentifier |
Resource Identifier |
Enums
DocumentValidationError |
Top-level (Document) JSON-API specification violations |
IdentifierData |
Valid Resource Identifier (can be None) |
PrimaryData |
Valid data Resource (can be None) |
Type Definitions
Included |
Side-loaded Resources |
JsonApiErrors |
Data-related errors |
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 ResourceIdentifiers |
Resources |
Vector of Resource |