Interface IGetSecondaryService<TResource, TId>

Namespace

JsonApiDotNetCore.Services

Assembly

JsonApiDotNetCore.dll

public interface IGetSecondaryService<TResource, in TId> where TResource : class, IIdentifiable<in TId>

Type Parameters

TResource

TId

Methods

GetSecondaryAsync(TId, string, CancellationToken)

Handles a JSON:API request to retrieve a single resource or a collection of resources for a secondary endpoint, such as /articles/1/author or /articles/1/revisions.

Task<object?> GetSecondaryAsync(TId id, string relationshipName, CancellationToken cancellationToken)

Parameters

id TId

relationshipName string

cancellationToken CancellationToken

Returns

Task<object>