Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document JsonApiEndpoints enum #1301

Closed
wants to merge 9 commits into from
Closed

Document JsonApiEndpoints enum #1301

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b7d77ea
Document JsonApiEndpoints enum (#1298)
verdie-g Aug 20, 2023
ab98e67
fix coding style
verdie-g Aug 20, 2023
1e5ede0
Address PR comments
verdie-g Sep 3, 2023
a56e1f4
Fix copy name
verdie-g Sep 3, 2023
e2ec1c4
Run cleanupcode
verdie-g Sep 3, 2023
748d2df
Address PR comments
verdie-g Sep 3, 2023
237a1d7
Merge branch 'master' into document-json-api-endpoints-enum
bkoelman Sep 4, 2023
57638f4
Merge branch 'master' into document-json-api-endpoints-enum
verdie-g Sep 21, 2023
d7962b7
Merge branch 'master' into document-json-api-endpoints-enum
verdie-g Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,104 @@ namespace JsonApiDotNetCore.Controllers;
[Flags]
public enum JsonApiEndpoints
{
/// <summary>
/// Represents none of the JSON:API endpoints.
/// </summary>
None = 0,
verdie-g marked this conversation as resolved.
Show resolved Hide resolved

/// <summary>
/// Represents the endpoint to get a collection of primary resources. Example: <code><![CDATA[
/// GET /articles HTTP/1.1
/// ]]></code>
/// </summary>
GetCollection = 1,

/// <summary>
/// Represents the endpoint to get a single primary resource by ID. Example: <code><![CDATA[
/// GET /articles/1 HTTP/1.1
/// ]]></code>
/// </summary>
GetSingle = 1 << 1,

/// <summary>
/// Represents the endpoint to get a secondary resource or collection of secondary resources. Example:
/// <code><![CDATA[
/// GET /articles/1/author HTTP/1.1
/// ]]></code>
verdie-g marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
GetSecondary = 1 << 2,

/// <summary>
/// Represents the endpoint to get a relationship value. Example: <code><![CDATA[
/// GET /articles/1/relationships/author HTTP/1.1
/// ]]></code> Example:
/// <code><![CDATA[
/// GET /articles/1/relationships/revisions HTTP/1.1
/// ]]></code>
/// </summary>
GetRelationship = 1 << 3,

/// <summary>
/// Represents the endpoint to creates a new resource with attributes, relationships or both. Example:
verdie-g marked this conversation as resolved.
Show resolved Hide resolved
/// <code><![CDATA[
/// POST /articles HTTP/1.1
/// ]]></code>
/// </summary>
Post = 1 << 4,

/// <summary>
/// Represents the endpoint to add resources to a to-many relationship. Example: <code><![CDATA[
/// POST /articles/1/revisions HTTP/1.1
/// ]]></code>
/// </summary>
PostRelationship = 1 << 5,

/// <summary>
/// Represents the endpoint to update the attributes and/or relationships of an existing resource. Example:
/// <code><![CDATA[
/// PATCH /articles/1
/// ]]></code>
/// </summary>
Patch = 1 << 6,

/// <summary>
/// Represents the endpoint to perform a complete replacement of a relationship on an existing resource. Example:
/// <code><![CDATA[
/// PATCH /articles/1/relationships/author HTTP/1.1
/// ]]></code> Example:
/// <code><![CDATA[
/// PATCH /articles/1/relationships/revisions HTTP/1.1
/// ]]></code>
/// </summary>
PatchRelationship = 1 << 7,

/// <summary>
/// Represents the endpoint to delete an existing resource. Example: <code><![CDATA[
/// DELETE /articles/1
/// ]]></code>
/// </summary>
Delete = 1 << 8,

/// <summary>
/// Represents the endpoint to remove resources from a to-many relationship. Example:
/// <code><![CDATA[
/// DELETE /articles/1/relationships/revisions
/// ]]></code>
/// </summary>
DeleteRelationship = 1 << 9,

/// <summary>
/// Represents the set of JSON:API endpoints to query resources and relationships.
/// </summary>
Query = GetCollection | GetSingle | GetSecondary | GetRelationship,

/// <summary>
/// Represents the set of JSON:API endpoints to change resources and relationships.
/// </summary>
Command = Post | PostRelationship | Patch | PatchRelationship | Delete | DeleteRelationship,

/// <summary>
/// Represents all of the JSON:API endpoints.
/// </summary>
All = Query | Command
}
84 changes: 84 additions & 0 deletions src/JsonApiDotNetCore.SourceGenerators/JsonApiEndpointsCopy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,104 @@ namespace JsonApiDotNetCore.SourceGenerators;
[Flags]
public enum JsonApiEndpointsCopy
{
/// <summary>
/// Represents none of the JSON:API endpoints.
/// </summary>
None = 0,

/// <summary>
/// Represents the endpoint to get a collection of primary resources. Example: <code><![CDATA[
/// GET /articles HTTP/1.1
/// ]]></code>
/// </summary>
GetCollection = 1,

/// <summary>
/// Represents the endpoint to get a single primary resource by ID. Example: <code><![CDATA[
/// GET /articles/1 HTTP/1.1
/// ]]></code>
/// </summary>
GetSingle = 1 << 1,

/// <summary>
/// Represents the endpoint to get a secondary resource or collection of secondary resources. Example:
/// <code><![CDATA[
/// GET /articles/1/author HTTP/1.1
/// ]]></code>
/// </summary>
GetSecondary = 1 << 2,

/// <summary>
/// Represents the endpoint to get a relationship value. Example: <code><![CDATA[
/// GET /articles/1/relationships/author HTTP/1.1
/// ]]></code> Example:
/// <code><![CDATA[
/// GET /articles/1/relationships/revisions HTTP/1.1
/// ]]></code>
/// </summary>
GetRelationship = 1 << 3,

/// <summary>
/// Represents the endpoint to creates a new resource with attributes, relationships or both. Example:
/// <code><![CDATA[
/// POST /articles HTTP/1.1
/// ]]></code>
/// </summary>
Post = 1 << 4,

/// <summary>
/// Represents the endpoint to add resources to a to-many relationship. Example: <code><![CDATA[
/// POST /articles/1/revisions HTTP/1.1
/// ]]></code>
/// </summary>
PostRelationship = 1 << 5,

/// <summary>
/// Represents the endpoint to update the attributes and/or relationships of an existing resource. Example:
/// <code><![CDATA[
/// PATCH /articles/1
/// ]]></code>
/// </summary>
Patch = 1 << 6,

/// <summary>
/// Represents the endpoint to perform a complete replacement of a relationship on an existing resource. Example:
/// <code><![CDATA[
/// PATCH /articles/1/relationships/author HTTP/1.1
/// ]]></code> Example:
/// <code><![CDATA[
/// PATCH /articles/1/relationships/revisions HTTP/1.1
/// ]]></code>
/// </summary>
PatchRelationship = 1 << 7,

/// <summary>
/// Represents the endpoint to delete an existing resource. Example: <code><![CDATA[
/// DELETE /articles/1
/// ]]></code>
/// </summary>
Delete = 1 << 8,

/// <summary>
/// Represents the endpoint to remove resources from a to-many relationship. Example:
/// <code><![CDATA[
/// DELETE /articles/1/relationships/revisions
/// ]]></code>
/// </summary>
DeleteRelationship = 1 << 9,

/// <summary>
/// Represents the set of JSON:API endpoints to query resources and relationships.
/// </summary>
Query = GetCollection | GetSingle | GetSecondary | GetRelationship,

/// <summary>
/// Represents the set of JSON:API endpoints to change resources and relationships.
/// </summary>
Command = Post | PostRelationship | Patch | PatchRelationship | Delete | DeleteRelationship,

/// <summary>
/// Represents all of the JSON:API endpoints.
/// </summary>
All = Query | Command
}