diff --git a/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs b/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs index a6d11e6093..fe8f360c3e 100644 --- a/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs +++ b/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs @@ -7,20 +7,106 @@ namespace JsonApiDotNetCore.Controllers; [Flags] public enum JsonApiEndpoints { + /// + /// Represents none of the JSON:API endpoints. + /// None = 0, + + /// + /// Represents the endpoint to get a collection of primary resources. Example: + /// GetCollection = 1, + + /// + /// Represents the endpoint to get a single primary resource by ID. Example: + /// GetSingle = 1 << 1, + + /// + /// Represents the endpoint to get a secondary resource or collection of secondary resources. Example: + /// Example: + /// GetSecondary = 1 << 2, + + /// + /// Represents the endpoint to get a relationship value. Example: Example: + /// + /// GetRelationship = 1 << 3, + + /// + /// Represents the endpoint to create a new resource with attributes, relationships or both. Example: + /// + /// Post = 1 << 4, + + /// + /// Represents the endpoint to add resources to a to-many relationship. Example: + /// PostRelationship = 1 << 5, + + /// + /// Represents the endpoint to update the attributes and/or relationships of an existing resource. Example: + /// + /// Patch = 1 << 6, + + /// + /// Represents the endpoint to perform a complete replacement of a relationship on an existing resource. Example: + /// Example: + /// + /// PatchRelationship = 1 << 7, + + /// + /// Represents the endpoint to delete an existing resource. Example: + /// Delete = 1 << 8, + + /// + /// Represents the endpoint to remove resources from a to-many relationship. Example: + /// + /// DeleteRelationship = 1 << 9, + /// + /// Represents the set of JSON:API endpoints to query resources and relationships. + /// Query = GetCollection | GetSingle | GetSecondary | GetRelationship, + + /// + /// Represents the set of JSON:API endpoints to change resources and relationships. + /// Command = Post | PostRelationship | Patch | PatchRelationship | Delete | DeleteRelationship, + /// + /// Represents all of the JSON:API endpoints. + /// All = Query | Command } diff --git a/src/JsonApiDotNetCore.SourceGenerators/JsonApiEndpointsCopy.cs b/src/JsonApiDotNetCore.SourceGenerators/JsonApiEndpointsCopy.cs index 911be3f359..862892a77f 100644 --- a/src/JsonApiDotNetCore.SourceGenerators/JsonApiEndpointsCopy.cs +++ b/src/JsonApiDotNetCore.SourceGenerators/JsonApiEndpointsCopy.cs @@ -4,20 +4,106 @@ namespace JsonApiDotNetCore.SourceGenerators; [Flags] public enum JsonApiEndpointsCopy { + /// + /// Represents none of the JSON:API endpoints. + /// None = 0, + + /// + /// Represents the endpoint to get a collection of primary resources. Example: + /// GetCollection = 1, + + /// + /// Represents the endpoint to get a single primary resource by ID. Example: + /// GetSingle = 1 << 1, + + /// + /// Represents the endpoint to get a secondary resource or collection of secondary resources. Example: + /// Example: + /// GetSecondary = 1 << 2, + + /// + /// Represents the endpoint to get a relationship value. Example: Example: + /// + /// GetRelationship = 1 << 3, + + /// + /// Represents the endpoint to create a new resource with attributes, relationships or both. Example: + /// + /// Post = 1 << 4, + + /// + /// Represents the endpoint to add resources to a to-many relationship. Example: + /// PostRelationship = 1 << 5, + + /// + /// Represents the endpoint to update the attributes and/or relationships of an existing resource. Example: + /// + /// Patch = 1 << 6, + + /// + /// Represents the endpoint to perform a complete replacement of a relationship on an existing resource. Example: + /// Example: + /// + /// PatchRelationship = 1 << 7, + + /// + /// Represents the endpoint to delete an existing resource. Example: + /// Delete = 1 << 8, + + /// + /// Represents the endpoint to remove resources from a to-many relationship. Example: + /// + /// DeleteRelationship = 1 << 9, + /// + /// Represents the set of JSON:API endpoints to query resources and relationships. + /// Query = GetCollection | GetSingle | GetSecondary | GetRelationship, + + /// + /// Represents the set of JSON:API endpoints to change resources and relationships. + /// Command = Post | PostRelationship | Patch | PatchRelationship | Delete | DeleteRelationship, + /// + /// Represents all of the JSON:API endpoints. + /// All = Query | Command }