tsai
/
squidex
mirror of https://github.com/Squidex/squidex.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Error message generalized.

pull/593/head
Sebastian 5 years ago
parent
b69cbed71b
commit
ba03fafb3b
15 changed files with 85 additions and 68 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs
  2. 10
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs
  3. 2
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs
  4. 4
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs
  5. 8
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs
  6. 8
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppWorkflowsController.cs
  7. 2
      backend/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs
  8. 10
      backend/src/Squidex/Areas/Api/Controllers/Assets/AssetFoldersController.cs
  9. 11
      backend/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs
  10. 3
      backend/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs
  11. 6
      backend/src/Squidex/Areas/Api/Controllers/Comments/CommentsController.cs
  12. 40
      backend/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs
  13. 4
      backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs
  14. 28
      backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs
  15. 11
      backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs

6
backend/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs
View File

@ -33,7 +33,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => Client keys returned. /// 200 => Clients returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -62,7 +62,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="request">Client object that needs to be added to the app.</param> /// <param name="request">Client object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => Client generated. /// 201 => Client created.
/// 400 => Client request not valid. /// 400 => Client request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
@ -118,7 +118,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="id">The id of the client that must be deleted.</param> /// <param name="id">The id of the client that must be deleted.</param>
/// <returns> /// <returns>
/// 200 => Client revoked. /// 200 => Client deleted.
/// 404 => Client or app not found. /// 404 => Client or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>

10
backend/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs
View File

@ -45,7 +45,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => App contributors returned. /// 200 => Contributors returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpGet] [HttpGet]
@ -71,8 +71,8 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="request">Contributor object that needs to be added to the app.</param> /// <param name="request">Contributor object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => User assigned to app. /// 201 => Contributor assigned to app.
/// 400 => User is not found. /// 400 => Contributor request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -94,7 +94,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => User removed from app. /// 200 => Contributor removed.
/// 404 => Contributor or app not found. /// 404 => Contributor or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]
@ -117,7 +117,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="id">The id of the contributor.</param> /// <param name="id">The id of the contributor.</param>
/// <returns> /// <returns>
/// 200 => User removed from app. /// 200 => Contributor removed.
/// 404 => Contributor or app not found. /// 404 => Contributor or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]

2
backend/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs
View File

@ -35,7 +35,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => Language configuration returned. /// 200 => Languages returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpGet] [HttpGet]

4
backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs
View File

@ -63,7 +63,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="request">Pattern to be added to the app.</param> /// <param name="request">Pattern to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => Pattern generated. /// 201 => Pattern created.
/// 400 => Pattern request not valid. /// 400 => Pattern request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
@ -112,7 +112,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="id">The id of the pattern to be deleted.</param> /// <param name="id">The id of the pattern to be deleted.</param>
/// <returns> /// <returns>
/// 200 => Pattern removed. /// 200 => Pattern deleted.
/// 404 => Pattern or app not found. /// 404 => Pattern or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>

8
backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs
View File

@ -37,7 +37,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => App roles returned. /// 200 => Roles returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpGet] [HttpGet]
@ -88,8 +88,8 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="request">Role object that needs to be added to the app.</param> /// <param name="request">Role object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => User assigned to app. /// 201 => Role created.
/// 400 => Role name already in use. /// 400 => Role request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -138,7 +138,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="roleName">The name of the role.</param> /// <param name="roleName">The name of the role.</param>
/// <returns> /// <returns>
/// 200 => Role deleted. /// 200 => Role deleted.
/// 400 => Role is in use by contributor or client or default role. /// 400 => Role is in use by contributor or client or a default role.
/// 404 => Role or app not found. /// 404 => Role or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]

8
backend/src/Squidex/Areas/Api/Controllers/Apps/AppWorkflowsController.cs
View File

@ -38,7 +38,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// </summary> /// </summary>
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 200 => App workflows returned. /// 200 => Workflows returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpGet] [HttpGet]
@ -64,8 +64,8 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="request">The new workflow.</param> /// <param name="request">The new workflow.</param>
/// <returns> /// <returns>
/// 200 => Workflow updated. /// 200 => Workflow created.
/// 400 => Workflow request is not valid. /// 400 => Workflow request not valid.
/// 404 => Workflow or app not found. /// 404 => Workflow or app not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -90,7 +90,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="id">The id of the workflow to update.</param> /// <param name="id">The id of the workflow to update.</param>
/// <returns> /// <returns>
/// 200 => Workflow updated. /// 200 => Workflow updated.
/// 400 => Workflow request is not valid. /// 400 => Workflow request not valid.
/// 404 => Workflow or app not found. /// 404 => Workflow or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]

2
backend/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs
View File

@ -151,6 +151,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="request">The values to update.</param> /// <param name="request">The values to update.</param>
/// <returns> /// <returns>
/// 200 => App updated. /// 200 => App updated.
/// 400 => App request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -172,6 +173,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
/// <param name="file">The file to upload.</param> /// <param name="file">The file to upload.</param>
/// <returns> /// <returns>
/// 200 => App image uploaded. /// 200 => App image uploaded.
/// 400 => App request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]

10
backend/src/Squidex/Areas/Api/Controllers/Assets/AssetFoldersController.cs
View File

@ -75,6 +75,7 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="request">The asset folder object that needs to be added to the App.</param> /// <param name="request">The asset folder object that needs to be added to the App.</param>
/// <returns> /// <returns>
/// 201 => Asset folder created. /// 201 => Asset folder created.
/// 400 => Asset folder request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -100,8 +101,8 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="request">The asset folder object that needs to updated.</param> /// <param name="request">The asset folder object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Asset folder updated. /// 200 => Asset folder updated.
/// 400 => Asset folder name not valid. /// 400 => Asset folder request not valid.
/// 404 => Asset or app not found. /// 404 => Asset folder or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
[Route("apps/{app}/assets/folders/{id}/", Order = -1)] [Route("apps/{app}/assets/folders/{id}/", Order = -1)]
@ -126,7 +127,8 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="request">The asset folder object that needs to updated.</param> /// <param name="request">The asset folder object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Asset folder moved. /// 200 => Asset folder moved.
/// 404 => Asset or app not found. /// 400 => Asset folder request not valid.
/// 404 => Asset folder or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
[Route("apps/{app}/assets/folders/{id}/parent", Order = -1)] [Route("apps/{app}/assets/folders/{id}/parent", Order = -1)]
@ -150,7 +152,7 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="id">The id of the asset folder to delete.</param> /// <param name="id">The id of the asset folder to delete.</param>
/// <returns> /// <returns>
/// 204 => Asset folder deleted. /// 204 => Asset folder deleted.
/// 404 => Asset or app not found. /// 404 => Asset folder or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]
[Route("apps/{app}/assets/folders/{id}/", Order = -1)] [Route("apps/{app}/assets/folders/{id}/", Order = -1)]

11
backend/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs
View File

@ -177,9 +177,9 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="duplicate">True to duplicate the asset, event if the file has been uploaded.</param> /// <param name="duplicate">True to duplicate the asset, event if the file has been uploaded.</param>
/// <returns> /// <returns>
/// 201 => Asset created. /// 201 => Asset created.
/// 404 => App not found.
/// 413 => Asset exceeds the maximum upload size.
/// 400 => Asset request not valid. /// 400 => Asset request not valid.
/// 413 => Asset exceeds the maximum upload size.
/// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can only upload one file at a time. The mime type of the file is not calculated by Squidex and is required correctly. /// You can only upload one file at a time. The mime type of the file is not calculated by Squidex and is required correctly.
@ -214,9 +214,9 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="file">The file to upload.</param> /// <param name="file">The file to upload.</param>
/// <returns> /// <returns>
/// 200 => Asset updated. /// 200 => Asset updated.
/// 404 => Asset or app not found.
/// 413 => Asset exceeds the maximum upload size.
/// 400 => Asset request not valid. /// 400 => Asset request not valid.
/// 413 => Asset exceeds the maximum upload size.
/// 404 => Asset or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// Use multipart request to upload an asset. /// Use multipart request to upload an asset.
@ -245,7 +245,7 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="request">The asset object that needs to updated.</param> /// <param name="request">The asset object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Asset updated. /// 200 => Asset updated.
/// 400 => Asset name not valid. /// 400 => Asset request not valid.
/// 404 => Asset or app not found. /// 404 => Asset or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -271,6 +271,7 @@ namespace Squidex.Areas.Api.Controllers.Assets
/// <param name="request">The asset object that needs to updated.</param> /// <param name="request">The asset object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Asset moved. /// 200 => Asset moved.
/// 400 => Asset request not valid.
/// 404 => Asset or app not found. /// 404 => Asset or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]

3
backend/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs
View File

@ -61,6 +61,7 @@ namespace Squidex.Areas.Api.Controllers.Backups
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <returns> /// <returns>
/// 204 => Backup started. /// 204 => Backup started.
/// 400 => Backup contingent reached.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -81,7 +82,7 @@ namespace Squidex.Areas.Api.Controllers.Backups
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="id">The id of the backup to delete.</param> /// <param name="id">The id of the backup to delete.</param>
/// <returns> /// <returns>
/// 204 => Backup started. /// 204 => Backup deleted.
/// 404 => Backup or app not found. /// 404 => Backup or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]

6
backend/src/Squidex/Areas/Api/Controllers/Comments/CommentsController.cs
View File

@ -42,7 +42,7 @@ namespace Squidex.Areas.Api.Controllers.Comments
/// When passing in a version you can retrieve all updates since then. /// When passing in a version you can retrieve all updates since then.
/// </remarks> /// </remarks>
/// <returns> /// <returns>
/// 200 => All comments returned. /// 200 => Comments returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpGet] [HttpGet]
@ -72,7 +72,7 @@ namespace Squidex.Areas.Api.Controllers.Comments
/// <param name="request">The comment object that needs to created.</param> /// <param name="request">The comment object that needs to created.</param>
/// <returns> /// <returns>
/// 201 => Comment created. /// 201 => Comment created.
/// 400 => Comment is not valid. /// 400 => Comment request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -100,7 +100,7 @@ namespace Squidex.Areas.Api.Controllers.Comments
/// <param name="request">The comment object that needs to updated.</param> /// <param name="request">The comment object that needs to updated.</param>
/// <returns> /// <returns>
/// 204 => Comment updated. /// 204 => Comment updated.
/// 400 => Comment text not valid. /// 400 => Comment request not valid.
/// 404 => Comment or app not found. /// 404 => Comment or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]

40
backend/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs
View File

@ -45,8 +45,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="queries">The graphql query.</param> /// <param name="queries">The graphql query.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved or mutated. /// 200 => Contents returned or mutated.
/// 404 => Schema or app not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -77,8 +77,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="query">The graphql query.</param> /// <param name="query">The graphql query.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved or mutated. /// 200 => Contents returned or mutated.
/// 404 => Schema or app not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -109,8 +109,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="batch">The graphql queries.</param> /// <param name="batch">The graphql queries.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved or mutated. /// 200 => Contents returned or mutated.
/// 404 => Schema or app not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -141,7 +141,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="ids">The optional ids of the content to fetch.</param> /// <param name="ids">The optional ids of the content to fetch.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved. /// 200 => Contents returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -170,7 +170,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="app">The name of the app.</param> /// <param name="app">The name of the app.</param>
/// <param name="query">The required query object.</param> /// <param name="query">The required query object.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved. /// 200 => Contents returned.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -201,7 +201,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="ids">The optional ids of the content to fetch.</param> /// <param name="ids">The optional ids of the content to fetch.</param>
/// <param name="q">The optional json query.</param> /// <param name="q">The optional json query.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved. /// 200 => Contents retunred.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -233,7 +233,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="name">The name of the schema.</param> /// <param name="name">The name of the schema.</param>
/// <param name="query">The required query object.</param> /// <param name="query">The required query object.</param>
/// <returns> /// <returns>
/// 200 => Contents retrieved. /// 200 => Contents returned.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -265,7 +265,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="name">The name of the schema.</param> /// <param name="name">The name of the schema.</param>
/// <param name="id">The id of the content to fetch.</param> /// <param name="id">The id of the content to fetch.</param>
/// <returns> /// <returns>
/// 200 => Content found. /// 200 => Content returned.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -293,9 +293,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="id">The id of the content to fetch.</param> /// <param name="id">The id of the content to fetch.</param>
/// <param name="version">The version fo the content to fetch.</param> /// <param name="version">The version fo the content to fetch.</param>
/// <returns> /// <returns>
/// 200 => Content found. /// 200 => Content version returned.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -323,8 +322,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="id">The optional custom content id.</param> /// <param name="id">The optional custom content id.</param>
/// <returns> /// <returns>
/// 201 => Content created. /// 201 => Content created.
/// 400 => Content request not valid.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -356,8 +355,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The import request.</param> /// <param name="request">The import request.</param>
/// <returns> /// <returns>
/// 201 => Contents created. /// 201 => Contents created.
/// 400 => Content request not valid.
/// 404 => Content references, schema or app not found. /// 404 => Content references, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -387,8 +386,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The bulk update request.</param> /// <param name="request">The bulk update request.</param>
/// <returns> /// <returns>
/// 201 => Contents created. /// 201 => Contents created.
/// 400 => Content request not valid.
/// 404 => Content references, schema or app not found. /// 404 => Content references, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -420,8 +419,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The full data for the content item.</param> /// <param name="request">The full data for the content item.</param>
/// <returns> /// <returns>
/// 200 => Content updated. /// 200 => Content updated.
/// 400 => Content request not valid.
/// 404 => Content references, schema or app not found. /// 404 => Content references, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -449,8 +448,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The full data for the content item.</param> /// <param name="request">The full data for the content item.</param>
/// <returns> /// <returns>
/// 200 => Content updated. /// 200 => Content updated.
/// 400 => Content request not valid.
/// 404 => Content references, schema or app not found. /// 404 => Content references, schema or app not found.
/// 400 => Content data is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -478,8 +477,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The patch for the content item.</param> /// <param name="request">The patch for the content item.</param>
/// <returns> /// <returns>
/// 200 => Content patched. /// 200 => Content patched.
/// 400 => Content request not valid.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// 400 => Content patch is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -507,8 +506,8 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="request">The status request.</param> /// <param name="request">The status request.</param>
/// <returns> /// <returns>
/// 200 => Content status changed. /// 200 => Content status changed.
/// 400 => Content request not valid.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// 400 => Content request is not valid.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
/// You can read the generated documentation for your app at /api/content/{appName}/docs. /// You can read the generated documentation for your app at /api/content/{appName}/docs.
@ -590,6 +589,7 @@ namespace Squidex.Areas.Api.Controllers.Contents
/// <param name="checkReferrers">True to check referrers of this content.</param> /// <param name="checkReferrers">True to check referrers of this content.</param>
/// <returns> /// <returns>
/// 204 => Content deleted. /// 204 => Content deleted.
/// 400 => Content cannot be deleted.
/// 404 => Content, schema or app not found. /// 404 => Content, schema or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>

4
backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs
View File

@ -107,7 +107,7 @@ namespace Squidex.Areas.Api.Controllers.Rules
/// <param name="request">The rule object that needs to be added to the app.</param> /// <param name="request">The rule object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => Rule created. /// 201 => Rule created.
/// 400 => Rule is not valid. /// 400 => Rule request not valid.
/// 404 => App not found. /// 404 => App not found.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -151,7 +151,7 @@ namespace Squidex.Areas.Api.Controllers.Rules
/// <param name="request">The rule object that needs to be added to the app.</param> /// <param name="request">The rule object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 200 => Rule updated. /// 200 => Rule updated.
/// 400 => Rule is not valid. /// 400 => Rule request not valid.
/// 404 => Rule or app not found. /// 404 => Rule or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]

28
backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs
View File

@ -35,7 +35,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The field object that needs to be added to the schema.</param> /// <param name="request">The field object that needs to be added to the schema.</param>
/// <returns> /// <returns>
/// 201 => Schema field created. /// 201 => Schema field created.
/// 400 => Schema field properties not valid. /// 400 => Schema field request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// 409 => Schema field name already in use. /// 409 => Schema field name already in use.
/// </returns> /// </returns>
@ -62,7 +62,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The field object that needs to be added to the schema.</param> /// <param name="request">The field object that needs to be added to the schema.</param>
/// <returns> /// <returns>
/// 201 => Schema field created. /// 201 => Schema field created.
/// 400 => Schema field properties not valid. /// 400 => Schema field request not valid.
/// 409 => Schema field name already in use. /// 409 => Schema field name already in use.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
@ -88,7 +88,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The request that contains the field names.</param> /// <param name="request">The request that contains the field names.</param>
/// <returns> /// <returns>
/// 200 => Schema UI fields defined. /// 200 => Schema UI fields defined.
/// 400 => Schema field contains invalid field names. /// 400 => Schema field request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -113,7 +113,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The request that contains the field ids.</param> /// <param name="request">The request that contains the field ids.</param>
/// <returns> /// <returns>
/// 200 => Schema fields reordered. /// 200 => Schema fields reordered.
/// 400 => Schema field ids do not cover the fields of the schema. /// 400 => Schema field request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -139,7 +139,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The request that contains the field ids.</param> /// <param name="request">The request that contains the field ids.</param>
/// <returns> /// <returns>
/// 200 => Schema fields reordered. /// 200 => Schema fields reordered.
/// 400 => Schema field ids do not cover the fields of the schema. /// 400 => Schema field request not valid.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -165,7 +165,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The field object that needs to be added to the schema.</param> /// <param name="request">The field object that needs to be added to the schema.</param>
/// <returns> /// <returns>
/// 200 => Schema field updated. /// 200 => Schema field updated.
/// 400 => Schema field properties not valid or field is locked. /// 400 => Schema field request not valid.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -192,7 +192,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The field object that needs to be added to the schema.</param> /// <param name="request">The field object that needs to be added to the schema.</param>
/// <returns> /// <returns>
/// 200 => Schema field updated. /// 200 => Schema field updated.
/// 400 => Schema field properties not valid or field is locked. /// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -217,6 +217,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to lock.</param> /// <param name="id">The id of the field to lock.</param>
/// <returns> /// <returns>
/// 200 => Schema field shown. /// 200 => Schema field shown.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -245,6 +246,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to lock.</param> /// <param name="id">The id of the field to lock.</param>
/// <returns> /// <returns>
/// 200 => Schema field hidden. /// 200 => Schema field hidden.
/// 400 => Schema field request not valid or field locked.
/// 404 => Field, schema, or app not found. /// 404 => Field, schema, or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -272,6 +274,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to hide.</param> /// <param name="id">The id of the field to hide.</param>
/// <returns> /// <returns>
/// 200 => Schema field hidden. /// 200 => Schema field hidden.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -300,6 +303,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to hide.</param> /// <param name="id">The id of the field to hide.</param>
/// <returns> /// <returns>
/// 200 => Schema field hidden. /// 200 => Schema field hidden.
/// 400 => Schema field request not valid or field locked.
/// 404 => Field, schema, or app not found. /// 404 => Field, schema, or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -327,6 +331,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to show.</param> /// <param name="id">The id of the field to show.</param>
/// <returns> /// <returns>
/// 200 => Schema field shown. /// 200 => Schema field shown.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -355,6 +360,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to show.</param> /// <param name="id">The id of the field to show.</param>
/// <returns> /// <returns>
/// 200 => Schema field shown. /// 200 => Schema field shown.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -382,6 +388,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to enable.</param> /// <param name="id">The id of the field to enable.</param>
/// <returns> /// <returns>
/// 200 => Schema field enabled. /// 200 => Schema field enabled.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -410,6 +417,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to enable.</param> /// <param name="id">The id of the field to enable.</param>
/// <returns> /// <returns>
/// 200 => Schema field enabled. /// 200 => Schema field enabled.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -437,6 +445,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to disable.</param> /// <param name="id">The id of the field to disable.</param>
/// <returns> /// <returns>
/// 200 => Schema field disabled. /// 200 => Schema field disabled.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -465,6 +474,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to disable.</param> /// <param name="id">The id of the field to disable.</param>
/// <returns> /// <returns>
/// 200 => Schema field disabled. /// 200 => Schema field disabled.
/// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
/// <remarks> /// <remarks>
@ -492,7 +502,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to disable.</param> /// <param name="id">The id of the field to disable.</param>
/// <returns> /// <returns>
/// 200 => Schema field deleted. /// 200 => Schema field deleted.
/// 400 => Field is locked. /// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]
@ -518,7 +528,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="id">The id of the field to disable.</param> /// <param name="id">The id of the field to disable.</param>
/// <returns> /// <returns>
/// 200 => Schema field deleted. /// 200 => Schema field deleted.
/// 400 => Field is locked. /// 400 => Schema field request not valid or field locked.
/// 404 => Schema, field or app not found. /// 404 => Schema, field or app not found.
/// </returns> /// </returns>
[HttpDelete] [HttpDelete]

11
backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs
View File

@ -112,7 +112,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The schema object that needs to be added to the app.</param> /// <param name="request">The schema object that needs to be added to the app.</param>
/// <returns> /// <returns>
/// 201 => Schema created. /// 201 => Schema created.
/// 400 => Schema name or properties are not valid. /// 400 => Schema request not valid.
/// 409 => Schema name already in use. /// 409 => Schema name already in use.
/// </returns> /// </returns>
[HttpPost] [HttpPost]
@ -137,7 +137,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The schema object that needs to updated.</param> /// <param name="request">The schema object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Schema updated. /// 200 => Schema updated.
/// 400 => Schema properties are not valid. /// 400 => Schema request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -162,7 +162,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The schema object that needs to updated.</param> /// <param name="request">The schema object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Schema updated. /// 200 => Schema updated.
/// 400 => Schema properties are not valid. /// 400 => Schema request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -187,6 +187,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The schema object that needs to updated.</param> /// <param name="request">The schema object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Schema updated. /// 200 => Schema updated.
/// 400 => Schema request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -211,7 +212,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The preview urls for the schema.</param> /// <param name="request">The preview urls for the schema.</param>
/// <returns> /// <returns>
/// 200 => Schema updated. /// 200 => Schema updated.
/// 400 => Schema urls are not valid. /// 400 => Schema request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]
@ -236,7 +237,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
/// <param name="request">The schema scripts object that needs to updated.</param> /// <param name="request">The schema scripts object that needs to updated.</param>
/// <returns> /// <returns>
/// 200 => Schema updated. /// 200 => Schema updated.
/// 400 => Schema scripts are not valid. /// 400 => Schema request not valid.
/// 404 => Schema or app not found. /// 404 => Schema or app not found.
/// </returns> /// </returns>
[HttpPut] [HttpPut]

Write Preview
Loading…
Cancel
Save