Skip to content

JsonApiEndpoints documentation #1298

New issue
New issue
Open
#1423
Open
JsonApiEndpoints documentation#1298
#1423
Labels
enhancementgood first issue
@verdie-g

Description

@verdie-g
verdie-g
opened on Aug 18, 2023
Contributor

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.

Activity

verdie-g
added
enhancement
on Aug 18, 2023
bkoelman

bkoelman commented on Aug 19, 2023

@bkoelman
bkoelman
on Aug 19, 2023
Member

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
added
good first issue
on Aug 20, 2023
bkoelman

bkoelman commented on Aug 20, 2023

@bkoelman
bkoelman
on Aug 20, 2023
Member

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

verdie-g
mentioned this on Aug 20, 2023
verdie-g

verdie-g commented on Aug 20, 2023

@verdie-g
verdie-g
on Aug 20, 2023
SponsorContributorAuthor

Sure #1301

verdie-g
linked a pull request that will close this issue on Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementgood first issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @verdie-g@bkoelman

      Issue actions
        JsonApiEndpoints documentation · Issue #1298 · json-api-dotnet/JsonApiDotNetCore