JsonApiEndpoints documentation

[verdie-g]

Hi, it's a bit unclear what each value of the JsonApiEndpoints does. For example, I might be missing some JSON:API concept but I'm not sure what GetSecondary is. Would it possible to add XML comments on those? 🙏Ideally, an example endpoint for each would be great.

[bkoelman]

Sure, sounds good. The endpoints are defined at https://jsonapi.org/format/#fetching. Comments on controllers and services are in place already. See:

JsonApiDotNetCore/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

Lines 126 to 134 in 952518a

	/// <summary>
	/// Gets a secondary resource or collection of secondary resources. Example: <code><![CDATA[
	/// GET /articles/1/author HTTP/1.1
	/// ]]></code> Example:
	/// <code><![CDATA[
	/// GET /articles/1/revisions HTTP/1.1
	/// ]]></code>
	/// </summary>
	public virtual async Task<IActionResult> GetSecondaryAsync(TId id, string relationshipName, CancellationToken cancellationToken)

JsonApiDotNetCore/src/JsonApiDotNetCore/Services/IGetSecondaryService.cs

Lines 11 to 15 in 952518a

	/// <summary>
	/// 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.
	/// </summary>
	Task<object?> GetSecondaryAsync(TId id, string relationshipName, CancellationToken cancellationToken);

.

[bkoelman]

@verdie-g Would you like to create a PR for this?

[verdie-g]

Sure #1301