yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dc9d4155a35459f9a33a9c9da852f194a23ea019
Umbraco-CMS/src/Umbraco.Cms.ManagementApi/OpenApi.json
Kenn Jacobsen dc9d4155a3 OpenId Connect authentication for new management API (#13318) 
* First attempt at OpenIddict

* Making headway and more TODOs

* Redo current policies for multiple schemas + clean up auth controller

* Fix bad merge

* Clean up some more test code

* Fix spacing

* Include AddAuthentication() in OpenIddict addition

* A little more clean-up

* Move application creation to its own implementation + prepare for middleware to handle valid callback URL

* Enable refresh token flow

* Fix bad merge from v11/dev

* Support auth for Swagger and Postman in non-production environments + use default login screen for back-office logins

* Add workaround to client side login handling so the OAuth return URL is not corrupted before redirection

* Add temporary configuration handling for new backoffice

* Restructure the code somewhat, move singular responsibility from management API project

* Add recurring task for cleaning up old tokens in the DB

* Fix bad merge + make auth controller align with the new management API structure

* Explicitly handle the new management API path as a backoffice path (NOTE: this is potentially behaviorally breaking!)

* Redo handle the new management API requests as backoffice requests, this time in a non-breaking way

* Add/update TODOs

* Revert duplication of current auth policies for OpenIddict (as it breaks everything for V11 without the new management APIs) and introduce a dedicated PoC policy setup for OpenIddict.

* Fix failing unit tests

* Update src/Umbraco.Cms.ManagementApi/Security/BackOfficeApplicationManager.cs

Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com>

* Update src/Umbraco.Cms.ManagementApi/Security/BackOfficeApplicationManager.cs

Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com>

* Update src/Umbraco.Cms.ManagementApi/Security/BackOfficeApplicationManager.cs

Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com>

* Update src/Umbraco.Core/Routing/UmbracoRequestPaths.cs

Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com>
2022-11-01 11:15:31 +01:00

5399 lines
132 KiB
JSON
Raw Blame History

{
"x-generator": "NSwag v13.17.0.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "Umbraco Backoffice API",
"description": "This shows all APIs available in this version of Umbraco - Including all the legacy apis that is available for backward compatibility",
"version": "All"
},
"servers": [
{
"url": "https://localhost:44331"
}
],
"paths": {
"/umbraco/management/api/v1/upgrade/authorize": {
"post": {
"tags": [
"Upgrade"
],
"operationId": "AuthorizeUpgrade_Authorize",
"responses": {
"200": {
"description": ""
},
"428": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/upgrade/settings": {
"get": {
"tags": [
"Upgrade"
],
"operationId": "SettingsUpgrade_Settings",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeSettingsViewModel"
}
}
}
},
"428": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/{id}": {
"get": {
"tags": [
"Tracked Reference"
],
"summary": "Gets a page list of tracked references for the current item, so you can see where an item is being used.",
"description": "Used by info tabs on content, media etc. and for the delete and unpublish of single items.\nThis is basically finding parents of relations.",
"operationId": "ByIdTrackedReference_Get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 3
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRelationItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/descendants/{parentId}": {
"get": {
"tags": [
"Tracked Reference"
],
"summary": "Gets a page list of the child nodes of the current item used in any kind of relation.",
"description": "Used when deleting and unpublishing a single item to check if this item has any descending items that are in any\nkind of relation.\nThis is basically finding the descending items which are children in relations.",
"operationId": "DescendantsTrackedReference_Descendants",
"parameters": [
{
"name": "parentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 3
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRelationItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/item": {
"get": {
"tags": [
"Tracked Reference"
],
"summary": "Gets a page list of the items used in any kind of relation from selected integer ids.",
"description": "Used when bulk deleting content/media and bulk unpublishing content (delete and unpublish on List view).\nThis is basically finding children of relations.",
"operationId": "ItemsTrackedReference_GetPagedReferencedItems",
"parameters": [
{
"name": "ids",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"x-position": 3
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRelationItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/template/children": {
"get": {
"tags": [
"Template"
],
"operationId": "ChildrenTemplateTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/template/item": {
"get": {
"tags": [
"Template"
],
"operationId": "ItemsTemplateTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/template/root": {
"get": {
"tags": [
"Template"
],
"operationId": "RootTemplateTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/telemetry": {
"get": {
"tags": [
"Telemetry"
],
"operationId": "AllTelemetry_GetAll",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfTelemetryLevelViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/telemetry/level": {
"get": {
"tags": [
"Telemetry"
],
"operationId": "GetTelemetry_Get",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryLevelViewModel"
}
}
}
}
}
},
"post": {
"tags": [
"Telemetry"
],
"operationId": "SetTelemetry_SetConsentLevel",
"requestBody": {
"x-name": "telemetryLevelViewModel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryLevelViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/tree/stylesheet/children": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "ChildrenStylesheetTree_Children",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/stylesheet/item": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "ItemsStylesheetTree_Items",
"parameters": [
{
"name": "path",
"x-originalName": "paths",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/stylesheet/root": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "RootStylesheetTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/static-file/children": {
"get": {
"tags": [
"Static File"
],
"operationId": "ChildrenStaticFileTree_Children",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/static-file/item": {
"get": {
"tags": [
"Static File"
],
"operationId": "ItemsStaticFileTree_Items",
"parameters": [
{
"name": "path",
"x-originalName": "paths",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/static-file/root": {
"get": {
"tags": [
"Static File"
],
"operationId": "RootStaticFileTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/server/status": {
"get": {
"tags": [
"Server"
],
"operationId": "StatusServer_Get",
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerStatusViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/server/version": {
"get": {
"tags": [
"Server"
],
"operationId": "VersionServer_Get",
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/security/back-office/authorize": {
"get": {
"tags": [
"Security"
],
"operationId": "BackOffice_AuthorizeGET",
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"post": {
"tags": [
"Security"
],
"operationId": "BackOffice_AuthorizePOST",
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/search/index/{indexName}": {
"get": {
"tags": [
"Search"
],
"summary": "Check if the index has been rebuilt",
"description": "This is kind of rudimentary since there's no way we can know that the index has rebuilt, we\nhave a listener for the index op complete so we'll just check if that key is no longer there in the runtime cache",
"operationId": "IndexDetailsSearch_Index",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
}
],
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/search/index": {
"get": {
"tags": [
"Search"
],
"summary": "Get the details for indexers",
"operationId": "IndexListSearch_Indexes",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfIndexViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/search/index/{indexName}/rebuild": {
"post": {
"tags": [
"Search"
],
"summary": "Rebuilds the index",
"operationId": "IndexRebuildSearch_Rebuild",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
}
],
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/search/searcher": {
"get": {
"tags": [
"Search"
],
"summary": "Get the details for searchers",
"operationId": "SearcherListSearch_Searchers",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfSearcherViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/search/searcher/{searcherName}/search": {
"get": {
"tags": [
"Search"
],
"operationId": "SearcherSearchSearch_GetSearchResults",
"parameters": [
{
"name": "searcherName",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 3
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfPagedViewModelOfSearchResultViewModel"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/script/children": {
"get": {
"tags": [
"Script"
],
"operationId": "ChildrenScriptTree_Children",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/script/item": {
"get": {
"tags": [
"Script"
],
"operationId": "ItemsScriptTree_Items",
"parameters": [
{
"name": "path",
"x-originalName": "paths",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/script/root": {
"get": {
"tags": [
"Script"
],
"operationId": "RootScriptTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/relation/child-relation/{childId}": {
"get": {
"tags": [
"Relation"
],
"operationId": "ByChildRelation_ByChild",
"parameters": [
{
"name": "childId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 3
},
{
"name": "relationTypeAlias",
"in": "query",
"schema": {
"type": "string",
"default": "",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRelationViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/relation/{id}": {
"get": {
"tags": [
"Relation"
],
"operationId": "ByIdRelation_ById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationViewModel"
}
}
}
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/relation-type/item": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "ItemsRelationTypeTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/relation-type/root": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "RootRelationTypeTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/published-cache/collect": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "CollectPublishedCache_Collect",
"responses": {
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/published-cache/rebuild": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "RebuildPublishedCache_Collect",
"responses": {
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/published-cache/reload": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "ReloadPublishedCache_Reload",
"responses": {
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/published-cache/status": {
"get": {
"tags": [
"Published Cache"
],
"operationId": "StatusPublishedCache_Status",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/profiling/status": {
"get": {
"tags": [
"Profiling"
],
"operationId": "StatusProfiling_Status",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilingStatusViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/partial-view/children": {
"get": {
"tags": [
"Partial View"
],
"operationId": "ChildrenPartialViewTree_Children",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/partial-view/item": {
"get": {
"tags": [
"Partial View"
],
"operationId": "ItemsPartialViewTree_Items",
"parameters": [
{
"name": "path",
"x-originalName": "paths",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/partial-view/root": {
"get": {
"tags": [
"Partial View"
],
"operationId": "RootPartialViewTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFileSystemTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/build": {
"post": {
"tags": [
"Models Builder"
],
"operationId": "BuildModelsBuilder_BuildModels",
"responses": {
"201": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"428": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/dashboard": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "GetModelsBuilder_GetDashboard",
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/status": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "StatusModelsBuilder_GetModelsOutOfDateStatus",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutOfDateStatusViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-type/item": {
"get": {
"tags": [
"Member Type"
],
"operationId": "ItemsMemberTypeTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-type/root": {
"get": {
"tags": [
"Member Type"
],
"operationId": "RootMemberTypeTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-group/item": {
"get": {
"tags": [
"Member Group"
],
"operationId": "ItemsMemberGroupTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-group/root": {
"get": {
"tags": [
"Member Group"
],
"operationId": "RootMemberGroupTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media/children": {
"get": {
"tags": [
"Media"
],
"operationId": "ChildrenMediaTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfContentTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media/item": {
"get": {
"tags": [
"Media"
],
"operationId": "ItemsMediaTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContentTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media/root": {
"get": {
"tags": [
"Media"
],
"operationId": "RootMediaTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfContentTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/media/children": {
"get": {
"tags": [
"Media"
],
"operationId": "ChildrenMediaRecycleBin_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRecycleBinItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/media/root": {
"get": {
"tags": [
"Media"
],
"operationId": "RootMediaRecycleBin_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRecycleBinItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media-type/children": {
"get": {
"tags": [
"Media Type"
],
"operationId": "ChildrenMediaTypeTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFolderTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media-type/item": {
"get": {
"tags": [
"Media Type"
],
"operationId": "ItemsMediaTypeTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media-type/root": {
"get": {
"tags": [
"Media Type"
],
"operationId": "RootMediaTypeTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFolderTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/language": {
"get": {
"tags": [
"Language"
],
"summary": "1\n Returns all currently configured languages.",
"operationId": "AllLanguage_GetAll",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfLanguageViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/language/{id}": {
"get": {
"tags": [
"Language"
],
"operationId": "ByIdLanguage_ById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
}
],
"responses": {
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageViewModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Language"
],
"summary": "Deletes a language with a given ID",
"operationId": "DeleteLanguage_Delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
}
],
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/language/create": {
"post": {
"tags": [
"Language"
],
"summary": "Creates or saves a language",
"operationId": "CreateLanguage_Create",
"requestBody": {
"x-name": "language",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"201": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/language/update": {
"put": {
"tags": [
"Language"
],
"summary": "Updates a language",
"operationId": "UpdateLanguage_Update",
"requestBody": {
"x-name": "language",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/install/settings": {
"get": {
"tags": [
"Install"
],
"operationId": "SettingsInstall_Settings",
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"428": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallSettingsViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/install/setup": {
"post": {
"tags": [
"Install"
],
"operationId": "SetupInstall_Setup",
"requestBody": {
"x-name": "installData",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"428": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/install/validate-database": {
"post": {
"tags": [
"Install"
],
"operationId": "ValidateDatabaseInstall_ValidateDatabase",
"requestBody": {
"x-name": "viewModel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseInstallViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": ""
}
}
}
},
"/umbraco/management/api/v1/help": {
"get": {
"tags": [
"Help"
],
"operationId": "GetHelp_Get",
"parameters": [
{
"name": "section",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "tree",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 3
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 4
},
{
"name": "baseUrl",
"in": "query",
"schema": {
"type": "string",
"default": "https://our.umbraco.com",
"nullable": true
},
"x-position": 5
}
],
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfHelpPageViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document/children": {
"get": {
"tags": [
"Document"
],
"operationId": "ChildrenDocumentTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 4
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 5
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDocumentTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document/item": {
"get": {
"tags": [
"Document"
],
"operationId": "ItemsDocumentTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 2
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document/root": {
"get": {
"tags": [
"Document"
],
"operationId": "RootDocumentTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
},
"x-position": 3
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDocumentTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/document/children": {
"get": {
"tags": [
"Document"
],
"operationId": "ChildrenDocumentRecycleBin_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRecycleBinItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/document/root": {
"get": {
"tags": [
"Document"
],
"operationId": "RootDocumentRecycleBin_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfRecycleBinItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-type/children": {
"get": {
"tags": [
"Document Type"
],
"operationId": "ChildrenDocumentTypeTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDocumentTypeTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-type/item": {
"get": {
"tags": [
"Document Type"
],
"operationId": "ItemsDocumentTypeTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-type/root": {
"get": {
"tags": [
"Document Type"
],
"operationId": "RootDocumentTypeTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDocumentTypeTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-blueprint/item": {
"get": {
"tags": [
"Document Blueprint"
],
"operationId": "ItemsDocumentBlueprintTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-blueprint/root": {
"get": {
"tags": [
"Document Blueprint"
],
"operationId": "RootDocumentBlueprintTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDocumentBlueprintTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Retrieves a list with all dictionary items",
"operationId": "AllDictionary_All",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "The IEnumerable`1.\n ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfDictionaryOverviewViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/{key}": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a dictionary item by guid",
"operationId": "ByIdDictionary_ByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"description": "The id.\n ",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "The DictionaryDisplay. Returns a not found response when dictionary item does not exist\n ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryViewModel"
}
}
}
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"delete": {
"tags": [
"Dictionary"
],
"summary": "Deletes a data type with a given ID",
"operationId": "DeleteDictionary_Delete",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"description": "The key of the dictionary item to delete",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "HttpResponseMessage\n "
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/create": {
"post": {
"tags": [
"Dictionary"
],
"summary": "Creates a new dictionary item",
"operationId": "CreateDictionary_Create",
"requestBody": {
"x-name": "dictionaryViewModel",
"description": "The viewmodel to pass to the action",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryItemViewModel"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "The HttpResponseMessage.\n ",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/export/{key}": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "ExportDictionary_ExportDictionary",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "includeChildren",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/import": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "ImportDictionary_ImportDictionary",
"parameters": [
{
"name": "file",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "parentId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/{id}": {
"patch": {
"tags": [
"Dictionary"
],
"operationId": "UpdateDictionary_Update",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "updateViewModel",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonPatchViewModel"
}
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/upload": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "UploadDictionary_Upload",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"nullable": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryImportViewModel"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/dictionary/children": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "ChildrenDictionaryTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/dictionary/item": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "ItemsDictionaryTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/dictionary/root": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "RootDictionaryTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfEntityTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/data-type/children": {
"get": {
"tags": [
"Data Type"
],
"operationId": "ChildrenDataTypeTree_Children",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 2
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 3
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 4
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFolderTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/data-type/item": {
"get": {
"tags": [
"Data Type"
],
"operationId": "ItemsDataTypeTree_Items",
"parameters": [
{
"name": "key",
"x-originalName": "keys",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "guid"
}
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemViewModel"
}
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/data-type/root": {
"get": {
"tags": [
"Data Type"
],
"operationId": "RootDataTypeTree_Root",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"x-position": 2
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfFolderTreeItemViewModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/culture": {
"get": {
"tags": [
"Culture"
],
"summary": "Returns all cultures available for creating languages.",
"operationId": "AllCulture_GetAll",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 1
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedViewModelOfCultureViewModel"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ProblemDetails": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
"UpgradeSettingsViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"currentState": {
"type": "string"
},
"newState": {
"type": "string"
},
"newVersion": {
"type": "string"
},
"oldVersion": {
"type": "string"
},
"reportUrl": {
"type": "string"
}
}
},
"PagedViewModelOfRelationItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationItemViewModel"
}
}
}
},
"RelationItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"nodeKey": {
"type": "string",
"format": "guid"
},
"nodeName": {
"type": "string",
"nullable": true
},
"nodeType": {
"type": "string",
"nullable": true
},
"contentTypeIcon": {
"type": "string",
"nullable": true
},
"contentTypeAlias": {
"type": "string",
"nullable": true
},
"contentTypeName": {
"type": "string",
"nullable": true
},
"relationTypeName": {
"type": "string",
"nullable": true
},
"relationTypeIsBidirectional": {
"type": "boolean"
},
"relationTypeIsDependency": {
"type": "boolean"
}
}
},
"PagedViewModelOfEntityTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemViewModel"
}
}
}
},
"EntityTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/TreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"format": "guid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "guid",
"nullable": true
}
}
}
]
},
"TreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
}
}
},
"PagedViewModelOfTelemetryLevelViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TelemetryLevelViewModel"
}
}
}
},
"TelemetryLevelViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevel"
}
}
},
"TelemetryLevel": {
"type": "string",
"description": "",
"x-enumNames": [
"Minimal",
"Basic",
"Detailed"
],
"enum": [
"Minimal",
"Basic",
"Detailed"
]
},
"PagedViewModelOfFileSystemTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemViewModel"
}
}
}
},
"FileSystemTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/TreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"isFolder": {
"type": "boolean"
}
}
}
]
},
"ServerStatusViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverStatus": {
"$ref": "#/components/schemas/RuntimeLevel"
}
}
},
"RuntimeLevel": {
"type": "string",
"description": "Describes the levels in which the runtime can run.\n ",
"x-enumNames": [
"Unknown",
"Boot",
"Install",
"Upgrade",
"Run",
"BootFailed"
],
"enum": [
"Unknown",
"Boot",
"Install",
"Upgrade",
"Run",
"BootFailed"
]
},
"VersionViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"type": "string"
}
}
},
"IndexViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"healthStatus": {
"type": "string",
"nullable": true
},
"isHealthy": {
"type": "boolean"
},
"canRebuild": {
"type": "boolean"
},
"searcherName": {
"type": "string"
},
"documentCount": {
"type": "integer",
"format": "int64"
},
"fieldCount": {
"type": "integer",
"format": "int32"
}
}
},
"PagedViewModelOfIndexViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexViewModel"
}
}
}
},
"PagedViewModelOfSearcherViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearcherViewModel"
}
}
}
},
"SearcherViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
}
},
"PagedViewModelOfPagedViewModelOfSearchResultViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagedViewModelOfSearchResultViewModel"
}
}
}
},
"PagedViewModelOfSearchResultViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultViewModel"
}
}
}
},
"SearchResultViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"score": {
"type": "number",
"format": "float"
},
"fieldCount": {
"type": "integer",
"format": "int32"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldViewModel"
}
}
}
},
"FieldViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PagedViewModelOfRelationViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationViewModel"
}
}
}
},
"RelationViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"parentId": {
"type": "integer",
"readOnly": true,
"description": "Gets or sets the Parent Id of the Relation (Source).\n ",
"format": "int32"
},
"parentName": {
"type": "string",
"readOnly": true,
"description": "Gets or sets the Parent Name of the relation (Source).\n ",
"nullable": true
},
"childId": {
"type": "integer",
"readOnly": true,
"description": "Gets or sets the Child Id of the Relation (Destination).\n ",
"format": "int32"
},
"childName": {
"type": "string",
"readOnly": true,
"description": "Gets or sets the Child Name of the relation (Destination).\n ",
"nullable": true
},
"createDate": {
"type": "string",
"readOnly": true,
"description": "Gets or sets the date when the Relation was created.\n ",
"format": "date-time"
},
"comment": {
"type": "string",
"readOnly": true,
"description": "Gets or sets a comment for the Relation.\n ",
"nullable": true
}
}
},
"FolderTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"isFolder": {
"type": "boolean"
}
}
}
]
},
"ProfilingStatusViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"OutOfDateStatusViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"$ref": "#/components/schemas/OutOfDateType"
}
}
},
"OutOfDateType": {
"type": "integer",
"description": "",
"x-enumNames": [
"OutOfDate",
"Current",
"Unknown"
],
"enum": [
0,
1,
100
]
},
"PagedViewModelOfContentTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContentTreeItemViewModel"
}
}
}
},
"ContentTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"noAccess": {
"type": "boolean"
}
}
}
]
},
"PagedViewModelOfRecycleBinItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecycleBinItemViewModel"
}
}
}
},
"RecycleBinItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "guid",
"nullable": true
}
}
},
"PagedViewModelOfFolderTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemViewModel"
}
}
}
},
"PagedViewModelOfLanguageViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageViewModel"
}
}
}
},
"LanguageViewModel": {
"type": "object",
"additionalProperties": false,
"required": [
"isoCode"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"isoCode": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackLanguageId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"InstallSettingsViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"user": {
"$ref": "#/components/schemas/UserSettingsViewModel"
},
"databases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSettingsViewModel"
}
}
}
},
"UserSettingsViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"minCharLength": {
"type": "integer",
"format": "int32"
},
"minNonAlphaNumericLength": {
"type": "integer",
"format": "int32"
},
"consentLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentLevelViewModel"
}
}
}
},
"ConsentLevelViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"$ref": "#/components/schemas/TelemetryLevel"
},
"description": {
"type": "string"
}
}
},
"DatabaseSettingsViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string"
},
"defaultDatabaseName": {
"type": "string"
},
"providerName": {
"type": "string"
},
"isConfigured": {
"type": "boolean"
},
"requiresServer": {
"type": "boolean"
},
"serverPlaceholder": {
"type": "string"
},
"requiresCredentials": {
"type": "boolean"
},
"supportsIntegratedAuthentication": {
"type": "boolean"
},
"requiresConnectionTest": {
"type": "boolean"
}
}
},
"InstallViewModel": {
"type": "object",
"additionalProperties": false,
"required": [
"user",
"database"
],
"properties": {
"user": {
"$ref": "#/components/schemas/UserInstallViewModel"
},
"database": {
"$ref": "#/components/schemas/DatabaseInstallViewModel"
},
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevel"
}
}
},
"UserInstallViewModel": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 0
},
"email": {
"type": "string",
"format": "email",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"subscribeToNewsletter": {
"type": "boolean"
}
}
},
"DatabaseInstallViewModel": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"providerName"
],
"properties": {
"id": {
"type": "string",
"format": "guid",
"minLength": 1
},
"providerName": {
"type": "string",
"minLength": 1
},
"server": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"useIntegratedAuthentication": {
"type": "boolean"
},
"connectionString": {
"type": "string",
"nullable": true
}
}
},
"PagedViewModelOfHelpPageViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HelpPageViewModel"
}
}
}
},
"HelpPageViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
}
},
"PagedViewModelOfDocumentTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemViewModel"
}
}
}
},
"DocumentTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/ContentTreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"isProtected": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"isEdited": {
"type": "boolean"
}
}
}
]
},
"PagedViewModelOfDocumentTypeTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemViewModel"
}
}
}
},
"DocumentTypeTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/FolderTreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"isElement": {
"type": "boolean"
}
}
}
]
},
"DocumentBlueprintTreeItemViewModel": {
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemViewModel"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"documentTypeKey": {
"type": "string",
"format": "guid"
},
"documentTypeAlias": {
"type": "string"
},
"documentTypeName": {
"type": "string",
"nullable": true
}
}
}
]
},
"PagedViewModelOfDocumentBlueprintTreeItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemViewModel"
}
}
}
},
"PagedViewModelOfDictionaryOverviewViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryOverviewViewModel"
}
}
}
},
"DictionaryOverviewViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Gets or sets the key.\n ",
"nullable": true
},
"key": {
"type": "string",
"description": "Gets or sets the key.\n ",
"format": "guid"
},
"level": {
"type": "integer",
"description": "Gets or sets the level.\n ",
"format": "int32"
},
"translations": {
"type": "array",
"description": "Sets the translations.\n ",
"items": {
"$ref": "#/components/schemas/DictionaryTranslationOverviewViewModel"
}
}
}
},
"DictionaryTranslationOverviewViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string",
"description": "Gets or sets the display name.\n ",
"nullable": true
},
"hasTranslation": {
"type": "boolean",
"description": "Gets or sets a value indicating whether has translation.\n "
}
}
},
"DictionaryViewModel": {
"type": "object",
"description": "The dictionary display model\n ",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"parentId": {
"type": "string",
"description": "Gets or sets the parent id.\n ",
"format": "guid",
"nullable": true
},
"translations": {
"type": "array",
"description": "Gets or sets the translations.\n ",
"items": {
"$ref": "#/components/schemas/DictionaryTranslationViewModel"
}
},
"contentApps": {
"type": "array",
"description": "Apps for the dictionary item\n ",
"items": {
"$ref": "#/components/schemas/ContentApp"
}
},
"notifications": {
"type": "array",
"description": "This is used to add custom localized messages/strings to the response for the app to use for localized UI purposes.\n ",
"items": {
"$ref": "#/components/schemas/BackOfficeNotification"
}
},
"name": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"description": "Gets or sets the Key for the object\n ",
"format": "guid"
},
"path": {
"type": "string",
"description": "The path of the entity\n "
}
}
},
"DictionaryTranslationViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"key": {
"type": "string",
"format": "guid"
},
"displayName": {
"type": "string",
"description": "Gets or sets the display name.\n ",
"nullable": true
},
"isoCode": {
"type": "string",
"description": "Gets or sets the ISO code.\n ",
"nullable": true
},
"translation": {
"type": "string",
"description": "Gets or sets the translation.\n "
},
"languageId": {
"type": "integer",
"description": "Gets or sets the language id.\n ",
"format": "int32"
}
}
},
"ContentApp": {
"type": "object",
"description": "Represents a content app.\n ",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Gets the name of the content app.\n ",
"nullable": true
},
"alias": {
"type": "string",
"description": "Gets the unique alias of the content app.\n ",
"nullable": true
},
"weight": {
"type": "integer",
"description": "Gets or sets the weight of the content app.\n ",
"format": "int32"
},
"icon": {
"type": "string",
"description": "Gets the icon of the content app.\n ",
"nullable": true
},
"view": {
"type": "string",
"description": "Gets the view for rendering the content app.\n ",
"nullable": true
},
"viewModel": {
"description": "The view model specific to this app\n ",
"nullable": true
},
"active": {
"type": "boolean",
"description": "Gets a value indicating whether the app is active.\n "
},
"badge": {
"description": "Gets or sets the content app badge.\n ",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ContentAppBadge"
}
]
}
}
},
"ContentAppBadge": {
"type": "object",
"description": "Represents a content app badge\n ",
"additionalProperties": false,
"properties": {
"count": {
"type": "integer",
"description": "Gets or sets the number displayed in the badge\n ",
"format": "int32"
},
"type": {
"description": "Gets or sets the type of badge to display\n ",
"oneOf": [
{
"$ref": "#/components/schemas/ContentAppBadgeType"
}
]
}
}
},
"ContentAppBadgeType": {
"type": "integer",
"description": "Represent the content app badge types\n ",
"x-enumNames": [
"Default",
"Warning",
"Alert"
],
"enum": [
0,
1,
2
]
},
"BackOfficeNotification": {
"type": "object",
"additionalProperties": false,
"properties": {
"header": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"notificationType": {
"$ref": "#/components/schemas/NotificationStyle"
}
}
},
"NotificationStyle": {
"type": "integer",
"description": "",
"x-enumNames": [
"Save",
"Info",
"Error",
"Success",
"Warning"
],
"enum": [
0,
1,
2,
3,
4
]
},
"DictionaryItemViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"parentId": {
"type": "string",
"format": "guid",
"nullable": true
},
"key": {
"type": "string",
"format": "guid"
}
}
},
"JsonPatchViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {}
}
},
"DictionaryImportViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"dictionaryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemsImportViewModel"
}
},
"tempFileName": {
"type": "string",
"nullable": true
}
}
},
"DictionaryItemsImportViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"level": {
"type": "integer",
"format": "int32"
}
}
},
"PagedViewModelOfCultureViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CultureViewModel"
}
}
}
},
"CultureViewModel": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"englishName": {
"type": "string"
}
}
}
},
"securitySchemes": {
"Bearer": {
"type": "oauth2",
"description": "Umbraco Authentication",
"name": "Umbraco",
"flows": {
"authorizationCode": {
"authorizationUrl": "/umbraco/management/api/v1.0/security/back-office/authorize",
"tokenUrl": "/umbraco/management/api/v1.0/security/back-office/token"
}
}
}
}
},
"security": [
{
"Bearer": []
}
],
"tags": [
{
"name": "Culture"
},
{
"name": "Data Type"
},
{
"name": "Dictionary"
},
{
"name": "Document"
},
{
"name": "Document Blueprint"
},
{
"name": "Document Type"
},
{
"name": "Help"
},
{
"name": "Install"
},
{
"name": "Language"
},
{
"name": "Media"
},
{
"name": "Media Type"
},
{
"name": "Member Group"
},
{
"name": "Member Type"
},
{
"name": "Models Builder"
},
{
"name": "Partial View"
},
{
"name": "Profiling"
},
{
"name": "Published Cache"
},
{
"name": "Relation"
},
{
"name": "Relation Type"
},
{
"name": "Script"
},
{
"name": "Search"
},
{
"name": "Security"
},
{
"name": "Server"
},
{
"name": "Static File"
},
{
"name": "Stylesheet"
},
{
"name": "Telemetry"
},
{
"name": "Template"
},
{
"name": "Tracked Reference"
},
{
"name": "Upgrade"
}
]
}
Reference in New Issue View Git Blame Copy Permalink