@itentialopensource/adapter-nexus_repository
Version:
This adapter integrates with system described as: nexusRepositoryManagerRestApi.
1,753 lines (1,752 loc) • 325 kB
JSON
{
"openapi": "3.0.0",
"info": {
"title": "Nexus Repository Manager REST API",
"contact": {},
"version": "3.21.2-03"
},
"servers": [
{
"url": "https://{defaultHost}",
"variables": {
"defaultHost": {
"default": "www.example.com/service/rest/"
}
}
}
],
"paths": {
"/beta/security/user-sources": {
"get": {
"tags": [
"Security Management"
],
"summary": "getUserSources",
"description": "Retrieve a list of the available user sources.",
"operationId": "getUserSources",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiUserSource"
},
"description": ""
}
}
}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/users/{userId}": {
"put": {
"tags": [
"Security Management: Users"
],
"summary": "updateUser",
"description": "Update an existing user.",
"operationId": "updateUser",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The userid the request should apply to.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A representation of the user to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiUser"
},
{
"description": "A representation of the user to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Password was not supplied in the body of the request",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "User or user source not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Security Management: Users"
],
"summary": "deleteUser",
"description": "Delete a user.",
"operationId": "deleteUser",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The userid the request should apply to.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Password was not supplied in the body of the request",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "User or user source not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/users": {
"get": {
"tags": [
"Security Management: Users"
],
"summary": "getUsers",
"description": "Retrieve a list of users. Note if the source is not 'default' the response is limited to 100 users.",
"operationId": "getUsers",
"parameters": [
{
"name": "userId",
"in": "query",
"description": "An optional term to search userids for.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "An optional user source to restrict the search to.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiUser"
},
"description": ""
}
}
}
},
"400": {
"description": "Password was not supplied in the body of the request",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"post": {
"tags": [
"Security Management: Users"
],
"summary": "createUser",
"description": "Create a new user in the default source.",
"operationId": "createUser",
"parameters": [],
"requestBody": {
"description": "A representation of the user to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiCreateUser"
},
{
"description": "A representation of the user to create."
}
]
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUser"
}
}
}
},
"400": {
"description": "Password was not supplied in the body of the request",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/users/{userId}/change-password": {
"put": {
"tags": [
"Security Management: Users"
],
"summary": "changePassword",
"description": "Change a user's password.",
"operationId": "changePassword",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The userid the request should apply to.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The new password to use.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "The new password to use."
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Password was not supplied in the body of the request",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "User not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges": {
"get": {
"tags": [
"Security Management: Privileges"
],
"summary": "getPrivileges",
"description": "Retrieve a list of privileges.",
"operationId": "getPrivileges",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiPrivilege"
},
"description": ""
}
}
}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/{privilegeId}": {
"get": {
"tags": [
"Security Management: Privileges"
],
"summary": "getPrivilege",
"description": "Retrieve a privilege by id.",
"operationId": "getPrivilege",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to retrieve.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiPrivilege"
}
}
}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Security Management: Privileges"
],
"summary": "deletePrivilege",
"description": "Delete a privilege by id.",
"operationId": "deletePrivilege",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"400": {
"description": "The privilege is internal and may not be altered.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/wildcard": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege",
"description": "Create a wildcard type privilege.",
"operationId": "createPrivilege",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeWildcardRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/application": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege_1",
"description": "Create an application type privilege.",
"operationId": "createPrivilege_1",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeApplicationRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/wildcard/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege",
"description": "Update a wildcard type privilege.",
"operationId": "updatePrivilege",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeWildcardRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/application/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege_1",
"description": "Update an application type privilege.",
"operationId": "updatePrivilege_1",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeApplicationRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-content-selector": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege_2",
"description": "Create a repository content selector type privilege.",
"operationId": "createPrivilege_2",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryContentSelectorRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-admin": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege_3",
"description": "Create a repository admin type privilege.",
"operationId": "createPrivilege_3",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryAdminRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-view": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege_4",
"description": "Create a repository view type privilege.",
"operationId": "createPrivilege_4",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryViewRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-view/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege_2",
"description": "Update a repository view type privilege.",
"operationId": "updatePrivilege_2",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryViewRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-content-selector/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege_3",
"description": "Update a repository content selector type privilege.",
"operationId": "updatePrivilege_3",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryContentSelectorRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/repository-admin/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege_4",
"description": "Update a repository admin type privilege.",
"operationId": "updatePrivilege_4",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeRepositoryAdminRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/script": {
"post": {
"tags": [
"Security Management: Privileges"
],
"summary": "createPrivilege_5",
"description": "Create a script type privilege.",
"operationId": "createPrivilege_5",
"parameters": [],
"requestBody": {
"description": "The privilege to create.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeScriptRequest"
},
{
"description": "The privilege to create."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/privileges/script/{privilegeId}": {
"put": {
"tags": [
"Security Management: Privileges"
],
"summary": "updatePrivilege_5",
"description": "Update a script type privilege.",
"operationId": "updatePrivilege_5",
"parameters": [
{
"name": "privilegeId",
"in": "path",
"description": "The id of the privilege to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The privilege to update.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApiPrivilegeScriptRequest"
},
{
"description": "The privilege to update."
}
]
}
}
},
"required": false
},
"responses": {
"400": {
"description": "Privilege object not configured properly.",
"headers": {},
"content": {}
},
"403": {
"description": "The user does not have permission to perform the operation.",
"headers": {},
"content": {}
},
"404": {
"description": "Privilege not found in the system.",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/realms/available": {
"get": {
"tags": [
"Security Management: Realms"
],
"summary": "getRealms",
"description": "List the available realms",
"operationId": "getRealms",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RealmApiXO"
},
"description": ""
}
}
}
}
},
"deprecated": false
}
},
"/beta/security/realms/active": {
"get": {
"tags": [
"Security Management: Realms"
],
"summary": "getActiveRealms",
"description": "List the active realm IDs in order",
"operationId": "getActiveRealms",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Security Management: Realms"
],
"summary": "setActiveRealms",
"description": "Set the active security realms in the order they should be used",
"operationId": "setActiveRealms",
"parameters": [],
"requestBody": {
"description": "The realm IDs",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "The realm IDs"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/roles": {
"get": {
"tags": [
"Security Management: Roles"
],
"summary": "getRoles",
"description": "List roles",
"operationId": "getRoles",
"parameters": [
{
"name": "source",
"in": "query",
"description": "The id of the user source to filter the roles by, if supplied. Otherwise roles from all user sources will be returned.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleXOResponse"
},
"description": ""
}
}
}
},
"400": {
"description": "The specified source does not exist",
"headers": {},
"content": {}
},
"403": {
"description": "Insufficient permissions to read roles",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"post": {
"tags": [
"Security Management: Roles"
],
"summary": "create",
"description": "Create role",
"operationId": "create",
"parameters": [],
"requestBody": {
"description": "A role configuration",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RoleXORequest"
},
{
"description": "A role configuration"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleXOResponse"
}
}
}
},
"403": {
"description": "Insufficient permissions to create role",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/security/roles/{id}": {
"get": {
"tags": [
"Security Management: Roles"
],
"summary": "getRole",
"description": "Get role",
"operationId": "getRole",
"parameters": [
{
"name": "source",
"in": "query",
"description": "The id of the user source to filter the roles by. Available sources can be fetched using the 'User Sources' endpoint.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "default"
}
},
{
"name": "id",
"in": "path",
"description": "The id of the role to get",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleXOResponse"
}
}
}
},
"400": {
"description": "The specified source does not exist",
"headers": {},
"content": {}
},
"403": {
"description": "Insufficient permissions to read roles",
"headers": {},
"content": {}
},
"404": {
"description": "Role not found",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"put": {
"tags": [
"Security Management: Roles"
],
"summary": "update",
"description": "Update role",
"operationId": "update",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the role to update",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A role configuration",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RoleXORequest"
},
{
"description": "A role configuration"
}
]
}
}
},
"required": true
},
"responses": {
"403": {
"description": "Insufficient permissions to update role",
"headers": {},
"content": {}
},
"404": {
"description": "Role not found",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Security Management: Roles"
],
"summary": "delete",
"description": "Delete role",
"operationId": "delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the role to delete",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"403": {
"description": "Insufficient permissions to delete role",
"headers": {},
"content": {}
},
"404": {
"description": "Role not found",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/v1/tasks/{id}": {
"get": {
"tags": [
"tasks"
],
"summary": "getTaskById",
"description": "Get a single task by id",
"operationId": "getTaskById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the task to get",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskXO"
}
}
}
},
"404": {
"description": "Task not found",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/v1/tasks": {
"get": {
"tags": [
"tasks"
],
"summary": "getTasks",
"description": "List tasks",
"operationId": "getTasks",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Type of the tasks to get",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageTaskXO"
}
}
}
}
},
"deprecated": false
}
},
"/v1/tasks/{id}/run": {
"post": {
"tags": [
"tasks"
],
"summary": "run",
"description": "Run task",
"operationId": "run",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the task to run",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Task was run",
"headers": {},
"content": {}
},
"404": {
"description": "Task not found",
"headers": {},
"content": {}
},
"405": {
"description": "Task is disabled",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/v1/tasks/{id}/stop": {
"post": {
"tags": [
"tasks"
],
"summary": "stop",
"description": "Stop task",
"operationId": "stop",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the task to stop",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Task was stopped",
"headers": {},
"content": {}
},
"404": {
"description": "Task not found",
"headers": {},
"content": {}
},
"409": {
"description": "Unable to stop task",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/blobstores/{name}": {
"delete": {
"tags": [
"Blob Store"
],
"summary": "deleteBlobStore",
"description": "Delete a blob store by name",
"operationId": "deleteBlobStore",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the blob store to delete",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/beta/blobstores": {
"get": {
"tags": [
"Blob Store"
],
"summary": "listBlobStores",