Skip to main content

Module jsonapi

Module jsonapi 

Source
Expand description

Shared JSON:API envelope types used across every App Metadata resource. Resource-specific attribute structs live in their own modules (app, app_store_version, …) and plug into these generics.

Structs§

ApiError
CreateBody
CreateData
Document
A single-resource JSON:API document — the body of e.g. GET /v1/apps/{id} or the response to a POST/PATCH.
ErrorDocument
The errors envelope App Store Connect returns on non-2xx responses.
ListDocument
A resource-collection JSON:API document — the body of e.g. GET /v1/apps.
Resource
A single JSON:API resource object: its id, type, and typed attributes. Relationships are intentionally left untyped (serde_json::Value) — this crate builds relationship payloads explicitly on requests rather than typing every relationship shape App Store Connect can return.
ResourceId
A bare { type, id } resource identifier, used to point a create request’s relationships at an existing resource.
ToMany
A to-many relationship payload, e.g. relationships.certificates on a POST /v1/profiles body.
ToOne
A to-one relationship payload, e.g. relationships.app on a POST /v1/appStoreVersions body.
UpdateBody
UpdateData
UpdateRelationshipsBody
A PATCH body that updates only relationships (no attributes) — e.g. attaching a Build to an AppStoreVersion.
UpdateRelationshipsData