Expand description
Defines custom types and structs primarily that composite the JSON:API document
Structs§
- Document
Data - A struct that defines properties for a JSON:API document that contains no errors
- Document
Error - A struct that defines an error state for a JSON:API document
- Error
Source - Error location
- Json
ApiError - Retpresentation of a JSON:API error (all fields are optional)
- Json
ApiInfo - Optional
JsonApiDocumentpayload identifying the JSON-API version the server implements - Pagination
- Pagination links
- Patch
- Patch
Set - 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
id,type,attributes,relationships,links, andmeta - Resource
Identifier - Resource Identifier
Enums§
- Diff
Patch Error - Document
Validation Error - Enum to describe top-level JSON:API specification violations
- Identifier
Data - Valid Resource Identifier (can be None)
- Json
ApiData Error - Json
ApiDocument - An enum that defines the possible composition of a JSON:API document - one which contains
errorordata- but not both. Rely on Rust’s type system to handle this basic validation instead of running validators on parsed documents - Patch
Type - Primary
Data - Valid data Resource (can be None)
- Relationship
Assumption Error
Type Aliases§
- Included
- Side-loaded Resources
- Json
ApiErrors - Data-related errors
- Json
ApiId - Json
ApiIds - Json
ApiValue - Permitted JSON-API values (all JSON Values)
- Links
- Meta
- Meta-data object, can contain any data
- Relationships
- Map of relationships with other objects
- Resource
Attributes - Resource Attributes, can be any JSON value
- Resource
Identifiers - Vector of
ResourceIdentifiers - Resources
- Vector of
Resource