JsonApiDotNetCore icon indicating copy to clipboard operation
JsonApiDotNetCore copied to clipboard
verified publisher icon json-api-dotnet

JsonApiEndpoints documentation

Open verdie-g opened this issue 2 years ago • 3 comments

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.

verdie-g avatar Aug 18 '23 16:08 verdie-g

Sure, sounds good. The endpoints are defined at https://jsonapi.org/format/#fetching. Comments on controllers and services are in place already. See: https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/952518a8c43c400445c790ebe285bf453949e71f/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs#L126-L134

https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/952518a8c43c400445c790ebe285bf453949e71f/src/JsonApiDotNetCore/Services/IGetSecondaryService.cs#L11-L15.

bkoelman avatar Aug 19 '23 08:08 bkoelman

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

bkoelman avatar Aug 20 '23 19:08 bkoelman

Sure https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1301

verdie-g avatar Aug 20 '23 19:08 verdie-g