Class ResourceTypeAllowedTypes

Namespace

FoundationaLLM.Common.Models.ResourceProviders

Assembly

FoundationaLLM.Common.dll

Provides details about the types that are allowed for the body and return of a specific HTTP method.

public record ResourceTypeAllowedTypes : IEquatable<ResourceTypeAllowedTypes>

Inheritance

object

ResourceTypeAllowedTypes

Implements

IEquatable<ResourceTypeAllowedTypes>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

ResourceTypeAllowedTypes(string, string, Dictionary<string, Type>, List<Type>, List<Type>)

Provides details about the types that are allowed for the body and return of a specific HTTP method.

public ResourceTypeAllowedTypes(string HttpMethod, string AuthorizationRequirements, Dictionary<string, Type> AllowedParameterTypes, List<Type> AllowedBodyTypes, List<Type> AllowedReturnTypes)

Parameters

HttpMethod string

The name of the HTTP method. Can be one of GET, POST, PUT, PATCH, or DELETE.

AuthorizationRequirements string

The requirements for authorizing the HTTP request. For all HTTP requests except POST, contains the name of the authorizable operation that is required to authorize the request. For POST requests will contain the name of the authorizable operation optionally followed by a RBAC role name (in this case, the two values must be separated by '|'.

AllowedParameterTypes Dictionary<string, Type>

The dictionary of query parameter names and types that are allowed for the method.

AllowedBodyTypes List<Type>

The list of types that are allowed as payloads for the HTTP request.

AllowedReturnTypes List<Type>

The list of types the are allowed as return types for the HTTP request.

Properties

AllowedBodyTypes

The list of types that are allowed as payloads for the HTTP request.

public List<Type> AllowedBodyTypes { get; init; }

Property Value

List<Type>

AllowedParameterTypes

The dictionary of query parameter names and types that are allowed for the method.

public Dictionary<string, Type> AllowedParameterTypes { get; init; }

Property Value

Dictionary<string, Type>

AllowedReturnTypes

The list of types the are allowed as return types for the HTTP request.

public List<Type> AllowedReturnTypes { get; init; }

Property Value

List<Type>

AuthorizationRequirements

The requirements for authorizing the HTTP request. For all HTTP requests except POST, contains the name of the authorizable operation that is required to authorize the request. For POST requests will contain the name of the authorizable operation optionally followed by a RBAC role name (in this case, the two values must be separated by '|'.

public string AuthorizationRequirements { get; init; }

Property Value

string

HttpMethod

The name of the HTTP method. Can be one of GET, POST, PUT, PATCH, or DELETE.

public string HttpMethod { get; init; }

Property Value

string