xStringService/Interfaces/IXBaseResourceProviderController.cs

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using xModels.Dtos;
using xStringService.Models.Dtos;

namespace xStringService.Interfaces
{
    public interface IXBaseResourceProviderController
    {
        /// <summary>
        /// Retrieve a List of Exists Languages ...
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("Languages")]
        Task<ActionResult<IEnumerable<string>>> GetLanguages(
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Retrieve all Exists Items ...
        /// </summary>
        /// <param name="resource">Specified Resource Title</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("LocalesResource")]
        Task<ActionResult<IEnumerable<XStringDto>>> GetResourceLocales(
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Extract Translation of in Specified Language ...
        /// </summary>
        /// <param name="language">Specified Language ...</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("{language}/Translation")]
        Task<ActionResult<string>> GetResourceTranslation(
            [FromRoute] string language,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Check Has Specified Translation or not ...
        /// </summary>
        /// <param name="language">Specified Language ...</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("{language}/Has")]
        Task<ActionResult<bool>> HasLocale(
            [FromRoute] string language,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Retrieve as Locale Model ...
        /// </summary>
        /// <param name="language">Specified Language ...</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("{language}/Locale")]
        Task<ActionResult<XLocaleResourceDto>> GetLocale(
            [FromRoute] string language,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Retrieve all Exists Locale Models ...
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("Locales")]
        Task<ActionResult<IEnumerable<XLocaleResourceDto>>> GetLocales(
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Retrieve as XResourceDto ...
        /// </summary>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpGet("Resource")]
        Task<ActionResult<XResourceDto>> GetResource(
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Add or Update a Resource Model ...
        /// </summary>
        /// <param name="resource">a XResourceDto Model ...</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpPost("")]
        Task<ActionResult<XResourceDto>> AddOrUpdateResource(
            [FromBody] XResourceDto resource,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Add Or Update Locale ...
        /// </summary>
        /// <param name="locale"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpPost("Locales")]
        Task<ActionResult<XResourceDto>> AddOrUpdateLocale(
            [FromBody] XLocaleResourceDto locale,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Remove Locale ...
        /// </summary>
        /// <param name="locale"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpPost("Locale/Remove")]
        Task<ActionResult<XResourceDto>> RemoveLocale(
            [FromBody] XLocaleResourceDto locale,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Remove Specified Resource Model ...
        /// </summary>
        /// <param name="resource">a XResourceDto Model ...</param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        [HttpPost("Resource/Remove")]
        Task<ActionResult> RemoveResource(
            [FromBody] XResourceDto resource,
            CancellationToken cancellationToken = default
        );
    }
}