Skip to content

Instantly share code, notes, and snippets.

@garpunkal

garpunkal/swagger.json

Last active April 8, 2025 20:16
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save garpunkal/b75a824d132d9fe2e8f386dcf3d58f6c to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save garpunkal/b75a824d132d9fe2e8f386dcf3d58f6c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
swagger.json
{
"openapi": "3.0.1",
"info": {
"title": "Umbraco Delivery API",
"description": "You can find out more about the Umbraco Delivery API in [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api).",
"version": "Latest"
},
"paths": {
"/umbraco/delivery/api/v1/content": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContent",
"parameters": [
{
"name": "fetch",
"in": "query",
"description": "Specifies the content items to fetch. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Select all": {
"value": ""
},
"Select all ancestors of a node by id": {
"value": "ancestors:id"
},
"Select all ancestors of a node by path": {
"value": "ancestors:path"
},
"Select all children of a node by id": {
"value": "children:id"
},
"Select all children of a node by path": {
"value": "children:path"
},
"Select all descendants of a node by id": {
"value": "descendants:id"
},
"Select all descendants of a node by path": {
"value": "descendants:path"
}
}
},
{
"name": "filter",
"in": "query",
"description": "Defines how to filter the fetched content items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default filter": {
"value": ""
},
"Filter by content type (equals)": {
"value": [
"contentType:alias1"
]
},
"Filter by name (contains)": {
"value": [
"name:nodeName"
]
},
"Filter by creation date (less than)": {
"value": [
"createDate<2024-01-01"
]
},
"Filter by update date (greater than or equal)": {
"value": [
"updateDate>:2023-01-01"
]
}
}
},
{
"name": "sort",
"in": "query",
"description": "Defines how to sort the found content items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default sort": {
"value": ""
},
"Sort by create date": {
"value": [
"createDate:asc",
"createDate:desc"
]
},
"Sort by level": {
"value": [
"level:asc",
"level:desc"
]
},
"Sort by name": {
"value": [
"name:asc",
"name:desc"
]
},
"Sort by sort order": {
"value": [
"sortOrder:asc",
"sortOrder:desc"
]
},
"Sort by update date": {
"value": [
"updateDate:asc",
"updateDate:desc"
]
}
}
},
{
"name": "skip",
"in": "query",
"description": "Specifies the number of found content items to skip. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Specifies the number of found content items to take. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIApiContentResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/content": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContent2.0",
"parameters": [
{
"name": "fetch",
"in": "query",
"description": "Specifies the content items to fetch. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Select all": {
"value": ""
},
"Select all ancestors of a node by id": {
"value": "ancestors:id"
},
"Select all ancestors of a node by path": {
"value": "ancestors:path"
},
"Select all children of a node by id": {
"value": "children:id"
},
"Select all children of a node by path": {
"value": "children:path"
},
"Select all descendants of a node by id": {
"value": "descendants:id"
},
"Select all descendants of a node by path": {
"value": "descendants:path"
}
}
},
{
"name": "filter",
"in": "query",
"description": "Defines how to filter the fetched content items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default filter": {
"value": ""
},
"Filter by content type (equals)": {
"value": [
"contentType:alias1"
]
},
"Filter by name (contains)": {
"value": [
"name:nodeName"
]
},
"Filter by creation date (less than)": {
"value": [
"createDate<2024-01-01"
]
},
"Filter by update date (greater than or equal)": {
"value": [
"updateDate>:2023-01-01"
]
}
}
},
{
"name": "sort",
"in": "query",
"description": "Defines how to sort the found content items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default sort": {
"value": ""
},
"Sort by create date": {
"value": [
"createDate:asc",
"createDate:desc"
]
},
"Sort by level": {
"value": [
"level:asc",
"level:desc"
]
},
"Sort by name": {
"value": [
"name:asc",
"name:desc"
]
},
"Sort by sort order": {
"value": [
"sortOrder:asc",
"sortOrder:desc"
]
},
"Sort by update date": {
"value": [
"updateDate:asc",
"updateDate:desc"
]
}
}
},
{
"name": "skip",
"in": "query",
"description": "Specifies the number of found content items to skip. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Specifies the number of found content items to take. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIApiContentResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v1/content/item": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v1/content/item/{path}": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItemByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/content/item/{path}": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItemByPath2.0",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v1/content/item/{id}": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItemById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/content/item/{id}": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItemById2.0",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v2/content/items": {
"get": {
"tags": [
"Content"
],
"operationId": "GetContentItems2.0",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "Defines the language to return. Use this when querying language variant content items.",
"schema": {
"type": "string"
},
"examples": {
"Default": {
"value": ""
},
"English culture": {
"value": "en-us"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
},
{
"name": "Preview",
"in": "header",
"description": "Whether to request draft content.",
"schema": {
"type": "boolean"
}
},
{
"name": "Start-Item",
"in": "header",
"description": "URL segment or GUID of a root content item.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v1/media": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMedia",
"parameters": [
{
"name": "fetch",
"in": "query",
"description": "Specifies the media items to fetch. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Select all children at root level": {
"value": "children:/"
},
"Select all children of a media item by id": {
"value": "children:id"
},
"Select all children of a media item by path": {
"value": "children:path"
}
}
},
{
"name": "filter",
"in": "query",
"description": "Defines how to filter the fetched media items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default filter": {
"value": ""
},
"Filter by media type": {
"value": [
"mediaType:alias1"
]
},
"Filter by name": {
"value": [
"name:nodeName"
]
}
}
},
{
"name": "sort",
"in": "query",
"description": "Defines how to sort the found media items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default sort": {
"value": ""
},
"Sort by create date": {
"value": [
"createDate:asc",
"createDate:desc"
]
},
"Sort by name": {
"value": [
"name:asc",
"name:desc"
]
},
"Sort by sort order": {
"value": [
"sortOrder:asc",
"sortOrder:desc"
]
},
"Sort by update date": {
"value": [
"updateDate:asc",
"updateDate:desc"
]
}
}
},
{
"name": "skip",
"in": "query",
"description": "Specifies the number of found media items to skip. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Specifies the number of found media items to take. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIApiMediaWithCropsResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/media": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMedia2.0",
"parameters": [
{
"name": "fetch",
"in": "query",
"description": "Specifies the media items to fetch. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Select all children at root level": {
"value": "children:/"
},
"Select all children of a media item by id": {
"value": "children:id"
},
"Select all children of a media item by path": {
"value": "children:path"
}
}
},
{
"name": "filter",
"in": "query",
"description": "Defines how to filter the fetched media items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default filter": {
"value": ""
},
"Filter by media type": {
"value": [
"mediaType:alias1"
]
},
"Filter by name": {
"value": [
"name:nodeName"
]
}
}
},
{
"name": "sort",
"in": "query",
"description": "Defines how to sort the found media items. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"Default sort": {
"value": ""
},
"Sort by create date": {
"value": [
"createDate:asc",
"createDate:desc"
]
},
"Sort by name": {
"value": [
"name:asc",
"name:desc"
]
},
"Sort by sort order": {
"value": [
"sortOrder:asc",
"sortOrder:desc"
]
},
"Sort by update date": {
"value": [
"updateDate:asc",
"updateDate:desc"
]
}
}
},
{
"name": "skip",
"in": "query",
"description": "Specifies the number of found media items to skip. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Specifies the number of found media items to take. Use this to control pagination of the response.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIApiMediaWithCropsResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v1/media/item": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v1/media/item/{path}": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItemByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/media/item/{path}": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItemByPath2.0",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v1/media/item/{id}": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItemById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all": {
"value": "all"
},
"Expand specific property": {
"value": "property:alias1"
},
"Expand specific properties": {
"value": "property:alias1,alias2"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/umbraco/delivery/api/v2/media/item/{id}": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItemById2.0",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
]
}
}
}
}
}
}
},
"/umbraco/delivery/api/v2/media/items": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItems2.0",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "expand",
"in": "query",
"description": "Defines the properties that should be expanded in the response. Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Expand none": {
"value": ""
},
"Expand all properties": {
"value": "properties[$all]"
},
"Expand specific property": {
"value": "properties[alias1]"
},
"Expand specific properties": {
"value": "properties[alias1,alias2]"
},
"Expand nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Explicitly defines which properties should be included in the response (by default all properties are included). Refer to [the documentation](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api/media-delivery-api#query-parameters) for more details on this.",
"schema": {
"type": "string"
},
"examples": {
"Include all properties": {
"value": "properties[$all]"
},
"Include only specific property": {
"value": "properties[alias1]"
},
"Include only specific properties": {
"value": "properties[alias1,alias2]"
},
"Include only specific nested properties": {
"value": "properties[alias1[properties[nestedAlias1,nestedAlias2]]]"
}
}
},
{
"name": "Api-Key",
"in": "header",
"description": "API key specified through configuration to authorize access to the API.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"HomeContentModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/IApiContentModelBase"
}
],
"properties": {
"properties": {
"$ref": "#/components/schemas/HomePropertiesModel"
}
},
"additionalProperties": false
},
"HomeContentResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/IApiContentResponseModelBase"
},
{
"$ref": "#/components/schemas/HomeContentModel"
}
],
"additionalProperties": false
},
"HomePropertiesModel": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HttpValidationProblemDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"additionalProperties": {}
}
]
},
"IApiContentModel": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HomeContentModel"
}
],
"additionalProperties": false
},
"IApiContentModelBase": {
"required": [
"contentType"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/IApiElementModelBase"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"contentType": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"route": {
"$ref": "#/components/schemas/IApiContentRouteModel"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "contentType",
"mapping": {
"home": "#/components/schemas/HomeContentModel"
}
}
},
"IApiContentResponseModel": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HomeContentResponseModel"
}
],
"additionalProperties": false
},
"IApiContentResponseModelBase": {
"required": [
"contentType"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/IApiContentModelBase"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"contentType": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"route": {
"$ref": "#/components/schemas/IApiContentRouteModel"
},
"cultures": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/IApiContentRouteModel"
},
"readOnly": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "contentType",
"mapping": {
"home": "#/components/schemas/HomeContentResponseModel"
}
}
},
"IApiContentRouteModel": {
"type": "object",
"properties": {
"path": {
"type": "string",
"readOnly": true
},
"startItem": {
"$ref": "#/components/schemas/IApiContentStartItemModel"
}
},
"additionalProperties": false
},
"IApiContentStartItemModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"IApiElementModel": {
"type": "object",
"additionalProperties": false
},
"IApiElementModelBase": {
"required": [
"contentType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"contentType": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "contentType"
}
},
"IApiMediaWithCropsResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"mediaType": {
"type": "string",
"readOnly": true
},
"url": {
"type": "string",
"readOnly": true
},
"extension": {
"type": "string",
"nullable": true,
"readOnly": true
},
"width": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"height": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"bytes": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"readOnly": true
},
"focalPoint": {
"$ref": "#/components/schemas/ImageFocalPointModel"
},
"crops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageCropModel"
},
"nullable": true,
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true
},
"createDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"ImageCropCoordinatesModel": {
"type": "object",
"properties": {
"x1": {
"type": "number",
"format": "double"
},
"y1": {
"type": "number",
"format": "double"
},
"x2": {
"type": "number",
"format": "double"
},
"y2": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"ImageCropModel": {
"type": "object",
"properties": {
"alias": {
"type": "string",
"nullable": true
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
},
"coordinates": {
"$ref": "#/components/schemas/ImageCropCoordinatesModel"
}
},
"additionalProperties": false
},
"ImageFocalPointModel": {
"type": "object",
"properties": {
"left": {
"type": "number",
"format": "double"
},
"top": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"PagedIApiContentResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiContentResponseModel"
}
}
},
"additionalProperties": false
},
"PagedIApiMediaWithCropsResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApiMediaWithCropsResponseModel"
}
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"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
}
},
"additionalProperties": {}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment