// ========================================================================== // Squidex Headless CMS // ========================================================================== // Copyright (c) Squidex UG (haftungsbeschränkt) // All rights reserved. Licensed under the MIT license. // ========================================================================== using System; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Net.Http.Headers; using Squidex.Areas.Api.Controllers.Schemas.Models; using Squidex.Domain.Apps.Entities; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Domain.Apps.Entities.Schemas.Commands; using Squidex.Infrastructure; using Squidex.Infrastructure.Commands; using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas { /// /// Manages and retrieves information about schemas. /// [ApiExplorerSettings(GroupName = nameof(Schemas))] public sealed class SchemasController : ApiController { private readonly IAppProvider appProvider; public SchemasController(ICommandBus commandBus, IAppProvider appProvider) : base(commandBus) { this.appProvider = appProvider; } /// /// Get schemas. /// /// The name of the app. /// /// 200 => Schemas returned. /// 404 => App not found. /// [HttpGet] [Route("apps/{app}/schemas/")] [ProducesResponseType(typeof(SchemaDto[]), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task GetSchemas(string app) { var schemas = await appProvider.GetSchemasAsync(AppId); var response = schemas.ToArray(x => SchemaDto.FromSchema(x, this, app)); Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); return Ok(response); } /// /// Get a schema by name. /// /// The name of the app. /// The name of the schema to retrieve. /// /// 200 => Schema found. /// 404 => Schema or app not found. /// [HttpGet] [Route("apps/{app}/schemas/{name}/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task GetSchema(string app, string name) { ISchemaEntity entity; if (Guid.TryParse(name, out var id)) { entity = await appProvider.GetSchemaAsync(AppId, id); } else { entity = await appProvider.GetSchemaAsync(AppId, name); } if (entity == null || entity.IsDeleted) { return NotFound(); } var response = SchemaDetailsDto.FromSchemaWithDetails(entity, this, app); Response.Headers[HeaderNames.ETag] = entity.Version.ToString(); return Ok(response); } /// /// Create a new schema. /// /// The name of the app. /// The schema object that needs to be added to the app. /// /// 201 => Schema created. /// 400 => Schema name or properties are not valid. /// 409 => Schema name already in use. /// [HttpPost] [Route("apps/{app}/schemas/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ProducesResponseType(typeof(ErrorDto), 409)] [ApiPermission(Permissions.AppSchemasCreate)] [ApiCosts(1)] public async Task PostSchema(string app, [FromBody] CreateSchemaDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return CreatedAtAction(nameof(GetSchema), new { name = request.Name }, response); } /// /// Update a schema. /// /// The name of the app. /// The name of the schema. /// The schema object that needs to updated. /// /// 204 => Schema updated. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutSchema(string app, string name, [FromBody] UpdateSchemaDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Synchronize a schema. /// /// The name of the app. /// The name of the schema. /// The schema object that needs to updated. /// /// 200 => Schema updated. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/sync")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutSchemaSync(string app, string name, [FromBody] SynchronizeSchemaDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Update a schema category. /// /// The name of the app. /// The name of the schema. /// The schema object that needs to updated. /// /// 200 => Schema updated. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/category")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutCategory(string app, string name, [FromBody] ChangeCategoryDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Update the preview urls. /// /// The name of the app. /// The name of the schema. /// The preview urls for the schema. /// /// 200 => Schema updated. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/preview-urls")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutPreviewUrls(string app, string name, [FromBody] ConfigurePreviewUrlsDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Update the scripts of a schema. /// /// The name of the app. /// The name of the schema. /// The schema scripts object that needs to updated. /// /// 200 => Schema updated. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/scripts/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasScripts)] [ApiCosts(1)] public async Task PutSchemaScripts(string app, string name, [FromBody] SchemaScriptsDto request) { var command = request.ToCommand(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Publish a schema. /// /// The name of the app. /// The name of the schema to publish. /// /// 200 => Schema has been published. /// 400 => Schema is already published. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/publish/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasPublish)] [ApiCosts(1)] public async Task PublishSchema(string app, string name) { var command = new PublishSchema(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Unpublish a schema. /// /// The name of the app. /// The name of the schema to unpublish. /// /// 200 => Schema has been unpublished. /// 400 => Schema is not published. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/unpublish/")] [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasPublish)] [ApiCosts(1)] public async Task UnpublishSchema(string app, string name) { var command = new UnpublishSchema(); var response = await InvokeCommandAsync(app, command); return Ok(response); } /// /// Delete a schema. /// /// The name of the app. /// The name of the schema to delete. /// /// 204 => Schema has been deleted. /// 404 => Schema or app not found. /// [HttpDelete] [Route("apps/{app}/schemas/{name}/")] [ApiPermission(Permissions.AppSchemasDelete)] [ApiCosts(1)] public async Task DeleteSchema(string app, string name) { await CommandBus.PublishAsync(new DeleteSchema()); return NoContent(); } private async Task InvokeCommandAsync(string app, ICommand command) { var context = await CommandBus.PublishAsync(command); var result = context.Result(); var response = SchemaDetailsDto.FromSchemaWithDetails(result, this, app); return response; } } }