Class FormulaSectionController

Namespace: Restaurant.API.Controllers
Assembly: Restaurant.API.dll

Controller made for Restaurant.Domain.Aggregates.FormulaAggregate.Formula management.

[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/formula-sections")]
public class FormulaSectionController : ControllerBase

Inheritance

object ← ControllerBase ← FormulaSectionController

Inherited Members

Constructors

FormulaSectionController\(IMediator\)

Formula controller constructor, injecting IMediator to send requests.

public FormulaSectionController(IMediator mediator)

Parameters

mediator IMediator

Methods

AddProduct\(Guid, Guid\)

Add a product to a formula section.

[HttpPut("{formulaSectionId}/products/{productGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(FormulaSection), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(409)]
[ProducesResponseType(500)]
public Task<ActionResult<FormulaSection>> AddProduct(Guid productGuid, Guid formulaSectionId)

Parameters

productGuid Guid

Guid of the product.

formulaSectionId Guid

Guid of the formula section.

Returns

Task < ActionResult <FormulaSection\>\>

The updated formula section.

DeleteFormulaSection\(Guid\)

Delete a formula section by Guid.

[HttpDelete("{formulaSectionGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
public Task<ActionResult> DeleteFormulaSection(Guid formulaSectionGuid)

Parameters

formulaSectionGuid Guid

Guid of the formula section to delete.

Returns

Task < ActionResult \>

A unit value that signify the success of the operation.

GetFormulaSectionById\(Guid\)

Get a formula by Guid.

[HttpGet("{formulaSectionGuid}")]
[ProducesResponseType(typeof(Formula), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Formula>> GetFormulaSectionById(Guid formulaSectionGuid)

Parameters

formulaSectionGuid Guid

Guid of the formula section to get.

Returns

Task < ActionResult <Formula\>\>

The requested formula section.

RemoveProduct\(Guid, Guid\)

Remove a product from a formula section.

[HttpDelete("{formulaSectionId}/products/{productGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult> RemoveProduct(Guid productGuid, Guid formulaSectionId)

Parameters

productGuid Guid

Guid of the product.

formulaSectionId Guid

Guid of the formula section.

Returns

Task < ActionResult \>

A unit value that signify a no content success response.

UpdateFormulaSection\(Guid, UpdateFormulaSectionCommand\)

Update a formula section by Guid.

[HttpPut("{formulaSectionGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(Formula), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(409)]
[ProducesResponseType(500)]
public Task<ActionResult<Formula>> UpdateFormulaSection(Guid formulaSectionGuid, UpdateFormulaSectionCommand command)

Parameters

formulaSectionGuid Guid

Guid of the formula section to update.

command UpdateFormulaSectionCommand

The command to update a formula section.

Returns

Task < ActionResult <Formula\>\>

The updated formula section.

Last modified: 21 May 2024