Signed-off-by: provokateurin <kate@provokateurin.de>pull/50425/head
parent
09a50d4da4
commit
4ff46549ce
@ -1,511 +0,0 @@ |
||||
{ |
||||
"openapi": "3.0.3", |
||||
"info": { |
||||
"title": "federation", |
||||
"version": "0.0.1", |
||||
"description": "Federation allows you to connect with other trusted servers to exchange the account directory.", |
||||
"license": { |
||||
"name": "agpl" |
||||
} |
||||
}, |
||||
"components": { |
||||
"securitySchemes": { |
||||
"basic_auth": { |
||||
"type": "http", |
||||
"scheme": "basic" |
||||
}, |
||||
"bearer_auth": { |
||||
"type": "http", |
||||
"scheme": "bearer" |
||||
} |
||||
}, |
||||
"schemas": { |
||||
"OCSMeta": { |
||||
"type": "object", |
||||
"required": [ |
||||
"status", |
||||
"statuscode" |
||||
], |
||||
"properties": { |
||||
"status": { |
||||
"type": "string" |
||||
}, |
||||
"statuscode": { |
||||
"type": "integer" |
||||
}, |
||||
"message": { |
||||
"type": "string" |
||||
}, |
||||
"totalitems": { |
||||
"type": "string" |
||||
}, |
||||
"itemsperpage": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"paths": { |
||||
"/ocs/v2.php/apps/federation/api/v1/shared-secret": { |
||||
"get": { |
||||
"operationId": "ocs_authapi-get-shared-secret-legacy", |
||||
"summary": "Create shared secret and return it, for legacy end-points", |
||||
"tags": [ |
||||
"ocs_authapi" |
||||
], |
||||
"security": [ |
||||
{}, |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"parameters": [ |
||||
{ |
||||
"name": "url", |
||||
"in": "query", |
||||
"description": "URL of the server", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
{ |
||||
"name": "token", |
||||
"in": "query", |
||||
"description": "Token of the server", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "Shared secret returned", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"type": "object", |
||||
"required": [ |
||||
"sharedSecret" |
||||
], |
||||
"properties": { |
||||
"sharedSecret": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"403": { |
||||
"description": "Getting shared secret is not allowed", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"/ocs/v2.php/apps/federation/api/v1/request-shared-secret": { |
||||
"post": { |
||||
"operationId": "ocs_authapi-request-shared-secret-legacy", |
||||
"summary": "Request received to ask remote server for a shared secret, for legacy end-points", |
||||
"tags": [ |
||||
"ocs_authapi" |
||||
], |
||||
"security": [ |
||||
{}, |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"requestBody": { |
||||
"required": true, |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"url", |
||||
"token" |
||||
], |
||||
"properties": { |
||||
"url": { |
||||
"type": "string", |
||||
"description": "URL of the server" |
||||
}, |
||||
"token": { |
||||
"type": "string", |
||||
"description": "Token of the server" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"parameters": [ |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "Shared secret requested successfully", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"403": { |
||||
"description": "Requesting shared secret is not allowed", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"/ocs/v2.php/cloud/shared-secret": { |
||||
"get": { |
||||
"operationId": "ocs_authapi-get-shared-secret", |
||||
"summary": "Create shared secret and return it", |
||||
"tags": [ |
||||
"ocs_authapi" |
||||
], |
||||
"security": [ |
||||
{}, |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"parameters": [ |
||||
{ |
||||
"name": "url", |
||||
"in": "query", |
||||
"description": "URL of the server", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
{ |
||||
"name": "token", |
||||
"in": "query", |
||||
"description": "Token of the server", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "Shared secret returned", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"type": "object", |
||||
"required": [ |
||||
"sharedSecret" |
||||
], |
||||
"properties": { |
||||
"sharedSecret": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"403": { |
||||
"description": "Getting shared secret is not allowed", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"post": { |
||||
"operationId": "ocs_authapi-request-shared-secret", |
||||
"summary": "Request received to ask remote server for a shared secret", |
||||
"tags": [ |
||||
"ocs_authapi" |
||||
], |
||||
"security": [ |
||||
{}, |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"requestBody": { |
||||
"required": true, |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"url", |
||||
"token" |
||||
], |
||||
"properties": { |
||||
"url": { |
||||
"type": "string", |
||||
"description": "URL of the server" |
||||
}, |
||||
"token": { |
||||
"type": "string", |
||||
"description": "Token of the server" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"parameters": [ |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "Shared secret requested successfully", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"403": { |
||||
"description": "Requesting shared secret is not allowed", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": {} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"tags": [ |
||||
{ |
||||
"name": "ocs_authapi", |
||||
"description": "Class OCSAuthAPI\nOCS API end-points to exchange shared secret between two connected Nextclouds" |
||||
} |
||||
] |
||||
} |
@ -1,2 +0,0 @@ |
||||
SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors |
||||
SPDX-License-Identifier: AGPL-3.0-or-later |
Loading…
Reference in new issue