{ "openapi": "3.0.0", "info": { "title": "Macrometa API Reference", "version": "0.17.17", "description": "API reference for the Macrometa Global Data Network.", "license": { "name": "Macrometa License, Version 2.0" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "paths": { "/_api/key/validate": { "post": { "description": "Requires a JSON object with these properties:\n\n - **apikey**: The API key as a string.\n - **jwt**: The JWT token as a string.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ValidateApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apikey_validate" } } }, "required": true }, "responses": { "200": { "description": "Successfully validated API key.", "content": { "application/json": { "schema": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of API keys with details as keyid, user name and tenant name.", "items": { "properties": { "keyid": { "description": "Keyid of the API key.", "type": "string", "example": "test" }, "parent": { "description": "Name of the parent.", "type": "string", "example": "root" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "_mm" }, "limitRequestsPerSec": { "description": "Maximum request limit.", "type": "integer", "example": "0" } } }, "type": "array" } }, "required": [ "error" ], "type": "object" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Validate API Key", "tags": [ "API Keys" ] } }, "/_api/key": { "post": { "description": "Create API keys for yourself.", "operationId": "CreateApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apikey_create" } } }, "required": true }, "responses": { "201": { "description": "Successfully added API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because API key already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create API Key", "tags": [ "API Keys" ] }, "get": { "description": "Retrieve information about all of your API keys. Privileged users (service or _mm.root user) can use the 'user' query parameter to retrieve information of API keys belonging to another user.", "operationId": "ListAvailableApiKeys", "parameters": [ { "description": "Return a list of API keys associated with the specified user. This parameter can be used by service or _mm.root user only.", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched API keys.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List available API keys", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}": { "get": { "description": "Fetch an existing API key, identified by *keyid*. You can only get your API keys.", "operationId": "GetAvailableApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_get_response_http_examples_rc_200_0" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get available API key.", "tags": [ "API Keys" ] }, "delete": { "description": "Remove an existing API key, identified by *keyid*. You can only remove your API keys.", "operationId": "RemoveApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove API Key.", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database": { "get": { "description": "Fetch the list of databases available to the specified *keyid*.\n\nReturns a JSON object with the per-database access privileges for the specified *keyid*. The result object contains databases names as object keys, and associated privileges for the database as values.\n\nIf you specified *full*, the result contains permissions for the databases as well as permissions for the collections and streams.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListTheAccessibleDatabasesForApiKey", "parameters": [ { "description": "The id of the API key for which you want to query the databases.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Return the full set of access levels for all databases and all collections.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched database list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List the accessible databases for a keyid", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{dbname}": { "get": { "description": "Fetch the database access level for a specific database.", "operationId": "GetTheDatabaseAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database to query.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the database access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the database access level for the database *dbname* of API key with *keyid*. Reverts to default database access level. If there is no defined default database access level, it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearTheDatabaseAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "202": { "description": "Successfully cleared access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the database access level", "tags": [ "API Keys" ] }, "put": { "description": "Sets the database access levels for the database *dbname* of API key with *keyid*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheDatabaseAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully changed access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_put_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the database access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{dbname}/collection": { "get": { "description": "Fetch the list of collections access level for a specific *user*\n\n If access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set database access level is used.", "operationId": "GetTheApiKeyCollectionsAccessLevel", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database to query.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all collections.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_database_collection_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific collection access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{dbname}/collection/{collection}": { "get": { "description": "Fetch the access level for a specific collection.\n\n If access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set database access level is used.", "operationId": "GetTheSpecificCollectionAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database to query.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific collection access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the access level for the collection *collection* in the database *dbname* of API key with *keyid*. Reverts to default collection access level. If there is no defined default collection access level, it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearTheCollectionAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the collection access level.", "tags": [ "API Keys" ] }, "put": { "description": "Sets the collection access level for the *collection* in the database *dbname* for API key with *keyid*.\n\nRequires a JSON object with these properties:\n\n - **grant**: Use \"rw\" to set the collection level access to *Read/Write*. Use \"ro\" to set the collection level access to *Read Only*. Use \"none\" to set the collection level access to *No access*.\n\n - **collection**: Use \"*\" to set default access level for all collections.\n\nIf access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set database access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheCollectionAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_collection" }, "responses": { "200": { "description": "Successfully changed access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_collection_put_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the collection access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{dbname}/stream": { "get": { "description": "Fetch the list of streams available to the specified *keyid*.\n\nThe call returns per-stream access privileges for the specified keyid. The *result* object contains the stream names as object keys and the associated privileges for the stream as values.\n\n If access level for stream is not set the default(\"*\") access level is used. If default(\"*\") access level is also not set the database access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListTheAccessibleStreamsForApiKey", "parameters": [ { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The id of the API key for which you want to query the streams.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Return the full set of access levels for all streams.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched streams.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_database_stream_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List the accessible streams", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{dbname}/stream/{stream}": { "get": { "description": "Fetch the stream access level for a specific stream.", "operationId": "GetTheStreamAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key for which you want to query the streams.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream to query.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the stream access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the stream access level for the *stream* of API key with *keyid*. Reverts to default stream access level. If there is no defined default stream access level, it defaults to *No access*.", "operationId": "ClearTheStreamAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the stream access level", "tags": [ "API Keys" ] }, "put": { "description": "Sets the stream access levels for the *stream* of API key with *keyid*.\n\nRequires a JSON object with these properties:\n\n - **grant**: Use \"ro\" to set the stream access level to Subscribe.\n Use \"wo\" to set the stream access level to Publish.\n Use \"rw\" to set the stream access level to Publish and Subscribe.\n Use \"none\" to set the stream access level to *No access*.\n\n - **stream**: Use \"*\" to set default access level for all streams.\n\nIf access level for stream is not set default(\"*\") access level is used. If default(\"*\") access level is also not set database access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheStreamAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "dbname", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully changed access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the stream access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{geofabric}/restql": { "get": { "description": "Fetch the list of query workers access level for a specific *keyid*.\n\n If access level for a query worker is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetApiKeyQueryWorkerAccessLevel", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all query workers.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched query workers access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_database_queryworker_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key or GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the query workers access level for a specific keyid", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{geofabric}/restql/{query-worker}": { "get": { "description": "Fetch the access level for a specific query worker.\n\n If access level for the query worker is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetSpecificQueryWorkerAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched query worker access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, API key, or query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific query worker access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the access level for the query worker *query worker* in the GeoFabric *geofabric* of API key with *keyid*. After this runs, the default query worker access level is used. If there is no defined default query worker access level, then it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearQueryWorkerAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared query worker access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, API key, or query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the query worker access level.", "tags": [ "API Keys" ] }, "put": { "description": "Sets the access level for the *query worker* in the GeoFabric *geofabric* for an API key with *keyid*.\n\nRequires a JSON object with these properties:\n\n - **grant**: Use \"rw\" to set the query worker level access to *Read/Write*. Use \"ro\" to set the query worker level access to *Read Only*. Use \"none\" to set the query worker level access to *No access*.\n\n - **query worker**: Use \"*\" to set default access level for all query workers.\n\nIf access level for a query worker is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetQueryWorkerAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_queryworker" }, "responses": { "200": { "description": "Successfully changed access permissions.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "_system/testQueryWorker": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, API key, or query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the query worker access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{geofabric}/managedkey": { "get": { "description": "Fetch the list of managed keys access level for a specific *keyid*.\n\n If access level for a managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetApiKeyManagedKeyAccessLevel", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all managed keys.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched managed keys access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_database_managedkey_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key or GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the managed keys access level for a specific keyid", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/database/{geofabric}/managedkey/{managed-key-name}": { "get": { "description": "Fetch the access level for a specific managed key.\n\n If the access level for the managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetSpecificManagedKeyAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched managed key access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, API key, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific managed key access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the access level for the *managed key name* in the GeoFabric *geofabric* of API key with *keyid*. After the access level is removed, the default managed key access level is used. If there is no defined default managed key access level, then it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearManagedKeyAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared managed key access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, API key, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the managed key access level", "tags": [ "API Keys" ] }, "put": { "description": "Sets the access level for the *managed key name* in the GeoFabric *geofabric* for an API key with *keyid*.\n\nRequires a JSON object with these properties:\n\n - **grant**: Use \"rw\" to set the managed key level access to *Read/Write*. Use \"ro\" to set the managed key level access to *Read Only*. Use \"none\" to set the managed key worker level access to *No access*.\n\n - **managed keyr**: Use \"*\" to set default access level for all managed keys.\n\nIf access level for the managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetManagedKeyAccessLevelForApiKey", "parameters": [ { "description": "The ID of the API key querying the GeoFabric.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_managedkey" }, "responses": { "200": { "description": "Successfully changed access permissions.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "_system/testManagedKey": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, API key, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the managed key access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/billing": { "get": { "description": "Fetch the billing access level.", "operationId": "GetTheBillingAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key for which you want to query the billing access level.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched billing access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_200_billing" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the billing access level", "tags": [ "API Keys" ] }, "delete": { "description": "Clears the billing access level of *keyid*.", "operationId": "ClearTheBillingAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the billing access level", "tags": [ "API Keys" ] }, "put": { "description": "Sets the billing access levels for API key with *keyid*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheBillingAccessLevelForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully changed access level.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_dbname_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the billing access level", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/attributes": { "get": { "description": "Fetch the list of attributes for the specified *keyid*.", "operationId": "GetTheAttributesForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http_examples_rc_200_attributes" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the API key attributes", "tags": [ "API Keys" ] }, "put": { "description": "Update attributes of a key.\n\n**Note**: Requires *administrator* permissions.", "operationId": "UpdateTheAttributesForApiKey", "parameters": [ { "description": "The id of the API key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/attribute_values" }, "responses": { "202": { "description": "Successfully changed attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http_examples_rc_200_attributes" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update attributes", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/attributes/truncate": { "delete": { "description": "Remove all attributes from *keyid*.", "operationId": "ClearAllAttributesForApiKey", "parameters": [ { "description": "The id of the api key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove all attributes", "tags": [ "API Keys" ] } }, "/_api/key/{keyid}/attributes/{attributeid}": { "delete": { "description": "Remove the attribute from *keyid*.", "operationId": "ClearTheAttributesForApiKey", "parameters": [ { "description": "The id of the api key.", "in": "path", "name": "keyid", "required": true, "schema": { "type": "string", "format": "string" } }, { "in": "path", "name": "attributeid", "required": true, "description": "Attribute id.", "schema": { "type": "string", "format": "string", "default": "attributeid" } } ], "responses": { "202": { "description": "Successfully removed attribute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove attribute", "tags": [ "API Keys" ] } }, "/_open/auth": { "post": { "description": "Obtain a JWT Authentication for a user.\n\nAfter obtaining the token, REST API calls may be invoked by passing the obtained token in the REST header. Either email or both tenant and username are required. Add the following to your header when you make REST calls: *\"Authorization: bearer TOKEN\"*", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auth_token" } } }, "required": true }, "responses": { "200": { "description": "Successfully created token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authentication_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "429": { "description": "Requests count from this IP exceeds the rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 429 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": "102020" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Obtain JWT Authentication token for user.", "tags": [ "Authentication" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/count": { "get": { "description": "Get number of key-value pairs in collection.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "groupID", "required": false, "description": "Get count of key-value pairs belonging to this groupID.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched number of key-value pairs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get number of key-value pairs in collection", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/keys": { "get": { "description": "Fetch keys from key-value collection.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "groupID", "required": false, "description": "Get keys belonging to this groupID.", "schema": { "type": "string", "format": "string" } }, { "description": "This option simulates paging.", "in": "query", "name": "offset", "required": false, "schema": { "type": "string", "default": 0 } }, { "description": "This option limits results while simulating paging.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "maximum": 100, "default": 20 } }, { "description": "Order the results ascending (asc) or descending (desc).", "in": "query", "name": "order", "required": false, "schema": { "type": "string", "default": "asc" } } ], "responses": { "200": { "description": "Successfully fetched the key-value keys.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_array_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Gets keys from key-value collection", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv": { "get": { "description": "Fetch all key-value collections.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched all key-value collection with expiration details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keys_array_rc_200_1" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Lists all key-value collections", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}": { "post": { "description": "Create key-value collection.", "operationId": "CreateNamespace", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "description": "Enable TTL support.", "in": "query", "name": "expiration", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "Enable KV group support.", "in": "query", "name": "group", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "stream": { "description": "Flag for on-demand stream collection", "type": "boolean", "example": false }, "enableShards": { "description": "Enabling sharding for the collection", "type": "boolean", "example": false }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": true }, "cacheEnabled": { "description": "*True* if collection has cache enabled", "type": "boolean", "default": false }, "blobs": { "description": "*True* if collection is a blob-only collection.", "type": "boolean", "default": false }, "shardKeys": { "type": "array", "items": { "description": "Array of shard keys", "type": "string", "example": "key1" } } } } } }, "description": "A JSON object with these optional properties:\n\n - **stream**: *True* if creating a stream with this collection.\n - **enableShards**: *True* if enabling sharding\n - **waitForSync**: *True* if all data must be synced to storage before operation returns.\n - **shardKeys**: an array of shard keys\n - **blobs**: *True* if this is a blob-only collection.", "required": true }, "responses": { "200": { "description": "Successfully created key-value collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_collection_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because collection already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "429": { "description": "Collection count exceeds the maximum number of collections per fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_429" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create key-value collection", "tags": [ "Key Value" ] }, "delete": { "description": "Remove key-value collection.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed the collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_collection_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove key-value collection", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/value/{key}": { "get": { "description": "Fetch value from key-value collection.\n\nNote that you should only specify multipart/form-data as the response content type when you are retrieving from a blob collection.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "path", "name": "key", "required": true, "description": "The key.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_key_examples_rc_200" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/key_blob" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get value from key-value collection", "tags": [ "Key Value" ] }, "delete": { "description": "Remove key-value pair.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "path", "name": "key", "required": true, "description": "The key.", "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove key-value pair", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/values": { "post": { "description": "Fetch key-value pairs from collection. Optional list of keys.\n\n**Note:** Max limit is 100 keys per request.\n\nNote that you should specify multipart/form-data as the response content type when you are retrieving from a blob collection.", "operationId": "GetValues", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "groupID", "required": false, "description": "Get key-value pairs belonging to this groupID.", "schema": { "type": "string", "format": "string" } }, { "description": "This option can be used to simulate paging.", "in": "query", "name": "offset", "required": false, "schema": { "type": "string", "default": 0 } }, { "description": "This option can be used to simulate paging. Limit the result.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "maximum": 100, "default": 20 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keys_array" } } }, "description": "An optional JSON array of keys." }, "responses": { "200": { "description": "Successfully fetched an array of key-value pairs from collection. If no keys are found and empty array is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_get_values_examples_rc_200" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/key_blob_array" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get key-value pairs from collection", "tags": [ "Key Value" ] }, "delete": { "description": "Remove key-value pairs. Requires a list of keys.\n\n**Note:** Max limit is 1000 keys per request.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keys_array" } } }, "description": "A JSON array of keys.", "required": true }, "responses": { "202": { "description": "Successfully removed key-value pairs.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" } } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, collection or key-value pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove key-value pairs.", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/value": { "put": { "description": "Set one or more key-value pairs in key-value collection.\n\nIf the input is an array of objects, then key-value pairs are created in a batch.\n\nIf the key does not exist, then the key-value pairs are created. Otherwise, the entry for the key is updated.\n\nSpecify expiration in UTC timestamp.\n\nNote that you can use this API for both normal (text) and blob KV collections. When setting blob data in a blob collection, specify the multipart/form-data as the content type for the request body, and provide multi-part data in the request body.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key_value_array" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/key_blob" } } }, "description": "An object of a single document or of an array of documents.\n\nIf you are working with text (json) KV collections, please select \"application/json\" as the type of the request body. Here, you can set the following fields:\n* \"_key\" - if it is not set, then it is generated by the system\n* \"value\" - string or JSON object. Required.\n* \"expireAt\" - UNIX timestamp, indicating when the value expires (-1 means no expiration)\n\nIf you are working with blob collections, please select \"multipart/form-data\" as the type of the request body. Here, you can set following fields:\n\n* \"meta\" - This is a JSON that can specify a _key and expireAt values for the KV pair. If a _key is not provided, then it is generated by the system. \"expireAt\" is UNIX timestamp, showing when the value expires (-1 means no expiration). If both are to be set to defaults, please specify an empty (\"{}\") JSON value.\n* \"value\" - corresponds to the file to be uploaded as the blob value for this KV pair.", "required": true }, "responses": { "202": { "description": "Successfully updated key-value pair.", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "updated _rev details of collection.", "type": "string", "example": "_dPSbTGC---" }, "_oldrev": { "description": "prvious _rev details of collection.", "type": "string", "example": "_dPRuHxe--_" } }, "type": "object" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set one or more key-value pairs in key-value collection", "tags": [ "Key Value" ] } }, "/_fabric/{fabric}/_api/kv/{collection}/truncate": { "put": { "description": "Remove all key-value pairs in a collection.", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the key-value collection.", "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "groupID", "required": false, "description": "Truncate the key-value pairs belonging to this group ID.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed all key-value entries.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kv_collection_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove all key-value pairs in a collection", "tags": [ "Key Value" ] } }, "/_api/dynamo": { "post": { "description": "Dynamo-like API interface.\n\nSet your JWT token or APIKEY as a aws_access_key_id (ex. '*bearer XXXXX*' or '*apikey XXXXX*').\n\nCurrently supported Dynamo actions (set as *'x-amz-target'* header tag):\n\n - **CreateTable**\n - **CreateGlobalTable**\n - **DeleteItem**\n - **DeleteTable**\n - **DescribeGlobalTable**\n - **DescribeTable**\n - **DescribeTimeToLive**\n - **GetItem**\n - **ListGlobalTables**\n - **ListTables**\n - **PutItem**\n - **Query**\n - **UpdateItem**\n - **UpdateTable**\n - **UpdateTimeToLive**\n - **Scan**\n - **BatchGetItem**\n - **BatchWriteItem**", "operationId": "DynamoLikeInterfaceAPI", "parameters": [ { "description": "Dynamo actions", "in": "header", "name": "x-amz-target", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "AttributeDefinitions": { "type": "array", "items": { "properties": { "AttributeName": { "type": "string" }, "AttributeType": { "type": "string" } } } }, "TableName": { "type": "string" }, "KeySchema": { "type": "array", "items": { "type": "object", "properties": { "AttributeName": { "type": "string" }, "KeyType": { "type": "string" } } } }, "ProvisionedThroughput": { "properties": { "ReadCapacityUnits": { "type": "number" }, "WriteCapacityUnits": { "type": "number" } } } }, "example": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "Music", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 } } } } }, "description": "The body depends on the action." }, "responses": { "200": { "description": "Successfully returned after execution.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Result is based on Dynamo actions given in JSON body.", "type": "object", "properties": { "TableDescription": { "type": "object", "properties": { "AttributeDefinitions": { "type": "array", "items": { "type": "object", "properties": { "AttributeName": { "type": "string" }, "AttributeType": { "type": "string" } } } }, "TableName": { "type": "string" }, "KeySchema": { "type": "array", "items": { "type": "object", "properties": { "AttributeName": { "type": "string" }, "KeyType": { "type": "string" } } } }, "TableStatus": { "type": "string" }, "CreationDateTime": { "type": "number" }, "TableSizeBytes": { "type": "number" }, "ItemCount": { "type": "number" } } } }, "example": { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "Music", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "ACTIVE", "CreationDateTime": 1637001376, "TableSizeBytes": 0, "ItemCount": 0 } } } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Dynamo-like API interface", "tags": [ "Dynamo" ] } }, "/_fabric/{fabric}/_api/redis/{collection}": { "post": { "description": "This API provides a REST API to access Redis databases. The REST API follows the same convention that the Redis Protocol uses.\n\n Using an HTTP POST request, the redis command and its parameters can be set the in the request body. The command can also be in the url suffix with the parameter set in the request body. The parameter suffixes can vary in number, depending upon the command. For example http://api.macrometa.io/_fabric/myfabric/_api/redis/SET/foo/bar.\n\n Currently supported Redis commands :\n\n * **String:** - **APPEND** - **DECR** - **DECRBY** - **GET** - **GETDEL** - **GETEX** - **GETRANGE** - **GETSET** - **INCR** - **INCRBY** - **INCRBYFLOAT** - **MGET** - **MSET** - **MSETNX** - **PSETEX** - **SET** - **SETBIT** - **SETEX** - **SETNX** - **SETRANGE** - **STRLEN** - **BITCOUNT** - **BITOP** - **BITPOS** - **GETBIT**\n\n * **Hash:** - **HDEL** - **HEXISTS** - **HGET** - **HGETALL** - **HINCRBY** - **HINCRBYFLOAT** - **HKEYS** - **HLEN** - **HMGET** - **HMSET** - **HSCAN** - **HSET** - **HSETNX** - **HSTRLEN** - **HRANDFIELD** - **HVALS**\n\n * **List:** - **LINDEX** - **LINSERT** - **LLEN** - **LMOVE** - **LPOP** - **LPOS** - **LPUSH** - **LPUSHX** - **LRANGE** - **LREM** - **LSET** - **LTRIM** - **RPOP** - **RPOPLPUSH** - **RPUSH** - **RPUSHX**\n\n * **Set:** - **SADD** - **SCARD** - **SDIFF** - **SDIFFSTORE** - **SINTER** - **SINTERSTORE** - **SISMEMBER** - **SMEMBERS** - **SMISMEMBER** - **SMOVE** - **SPOP** - **SRANDMEMBER** - **SREM** - **SSCAN** - **SUNION** - **SUNIONSTORE**\n\n * **SortedSet:** - **ZADD** - **ZCARD** - **ZCOUNT** - **ZDIFF** - **ZDIFFSTORE** - **ZINCRBY** - **ZINTER** - **ZINTERSTORE** - **ZLEXCOUNT** - **ZMSCORE** - **ZPOPMAX** - **ZPOPMIN** - **ZRANDMEMBER** - **ZRANGE** - **ZRANGEBYLEX** - **ZRANGEBYSCORE** - **ZRANGESTORE** - **ZRANK** - **ZREM** - **ZREMRANGEBYLEX** - **ZREMRANGEBYRANK** - **ZREMRANGEBYSCORE** - **ZREVRANGE** - **ZREVRANGEBYLEX** - **ZREVRANGEBYSCORE** - **ZREVRANK** - **ZSCAN** - **ZSCORE** - **ZUNION** - **ZUNIONSTORE**\n\n * **Generic:** - **COPY** - **DEL** - **EXISTS** - **EXPIRE** - **EXPIREAT** - **PERSIST** - **PEXPIRE** - **PEXPIREAT** - **PTTL** - **RANDOMKEY** - **RENAME** - **RENAMENX** - **SCAN** - **TTL** - **TYPE** - **UNLINK**\n\n * **Server:** - **ECHO** - **PING** - **PIPELINE** - **DBSIZE** - **FLUSHDB** - **TIME**\n\n", "operationId": "RedisPost", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the Redis collection.", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": {}, "example": [ "SET", "foo", "bar" ] } } }, "description": "The body depends on the command to be executed." }, "responses": { "200": { "description": "Successfully returned after execution.", "content": { "application/json": { "schema": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "result": { "description": "Result depending upon Redis command. It can be a string, number or an array.", "type": "array", "items": {}, "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to invalid command parameters. Verify that all parameters are correct.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message if there is an error in response.", "type": "string", "example": "Invalid cmd params." }, "code": { "description": "HTTP response code.", "type": "integer", "example": 400 } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have execute permissions.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "Error message if there is an error in response.", "type": "string", "example": "not authorized to execute this request" }, "code": { "description": "HTTP response code.", "type": "integer", "example": 401 } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Redis-like API interface", "tags": [ "Redis" ] } }, "/_fabric/{fabric}/_api/redis/{collection}/{command}": { "get": { "description": "This API provides a REST API to access Redis databases. The REST API follows the same convention that the Redis Protocol uses. \n\n Give the command name and parameters in the same order as the Redis protocol, separating commands with a '/'. The parameter suffixes can vary in number, depending upon the command. For example http://api.macrometa.io/_fabric/myfabric/_api/redis/SET/foo/bar. Query params can also be used along with suffixes, for example http://api.macrometa.io/_fabric/myfabric/_api/redis/SET/foo/bar?ex=100.\n\n Currently supported Redis commands :\n\n * **String:** - **APPEND** - **DECR** - **DECRBY** - **GET** - **GETDEL** - **GETEX** - **GETRANGE** - **GETSET** - **INCR** - **INCRBY** - **INCRBYFLOAT** - **MGET** - **MSET** - **MSETNX** - **PSETEX** - **SET** - **SETBIT** - **SETEX** - **SETNX** - **SETRANGE** - **STRLEN** - **BITCOUNT** - **BITOP** - **BITPOS** - **GETBIT**\n\n * **Hash:** - **HDEL** - **HEXISTS** - **HGET** - **HGETALL** - **HINCRBY** - **HINCRBYFLOAT** - **HKEYS** - **HLEN** - **HMGET** - **HMSET** - **HSCAN** - **HSET** - **HSETNX** - **HSTRLEN** - **HRANDFIELD** - **HVALS**\n\n * **List:** - **LINDEX** - **LINSERT** - **LLEN** - **LMOVE** - **LPOP** - **LPOS** - **LPUSH** - **LPUSHX** - **LRANGE** - **LREM** - **LSET** - **LTRIM** - **RPOP** - **RPOPLPUSH** - **RPUSH** - **RPUSHX**\n\n * **Set:** - **SADD** - **SCARD** - **SDIFF** - **SDIFFSTORE** - **SINTER** - **SINTERSTORE** - **SISMEMBER** - **SMEMBERS** - **SMISMEMBER** - **SMOVE** - **SPOP** - **SRANDMEMBER** - **SREM** - **SSCAN** - **SUNION** - **SUNIONSTORE**\n\n * **SortedSet:** - **ZADD** - **ZCARD** - **ZCOUNT** - **ZDIFF** - **ZDIFFSTORE** - **ZINCRBY** - **ZINTER** - **ZINTERSTORE** - **ZLEXCOUNT** - **ZMSCORE** - **ZPOPMAX** - **ZPOPMIN** - **ZRANDMEMBER** - **ZRANGE** - **ZRANGEBYLEX** - **ZRANGEBYSCORE** - **ZRANGESTORE** - **ZRANK** - **ZREM** - **ZREMRANGEBYLEX** - **ZREMRANGEBYRANK** - **ZREMRANGEBYSCORE** - **ZREVRANGE** - **ZREVRANGEBYLEX** - **ZREVRANGEBYSCORE** - **ZREVRANK** - **ZSCAN** - **ZSCORE** - **ZUNION** - **ZUNIONSTORE**\n\n * **Generic:** - **COPY** - **DEL** - **EXISTS** - **EXPIRE** - **EXPIREAT** - **PERSIST** - **PEXPIRE** - **PEXPIREAT** - **PTTL** - **RANDOMKEY** - **RENAME** - **RENAMENX** - **SCAN** - **TTL** - **TYPE** - **UNLINK**\n\n * **Server:** - **ECHO** - **PING** - **PIPELINE** - **DBSIZE** - **FLUSHDB** - **TIME**\n\n", "operationId": "RedisGet", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the collection.", "schema": { "type": "string", "format": "string" } }, { "in": "path", "name": "command", "required": true, "description": "The name of the redis command.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully returned after execution.", "content": { "application/json": { "schema": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "result": { "description": "Result depending upon Redis command. It can be a string, number or an array.", "type": "array", "items": {}, "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to invalid command parameters. Verify that all parameters are correct.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message if there is an error in response.", "type": "string", "example": "Invalid cmd params." }, "code": { "description": "HTTP response code.", "type": "integer", "example": 400 } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have execute permissions.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "Error message if there is an error in response.", "type": "string", "example": "not authorized to execute this request" }, "code": { "description": "HTTP response code.", "type": "integer", "example": 401 } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Redis-like API interface", "tags": [ "Redis" ] } }, "/_fabric/{fabric}/_api/document/{collection}": { "delete": { "description": "The body of the request is an array consisting of selectors for documents. A selector can either be a string with a key or a string with a document handle or an object with a *_key* attribute.\n\nThis API call removes all specified documents from *collection*. If the selector is an object and has a *_rev* attribute, it is a precondition that the actual revision of the removed document in the collection is the specified one.\n\nThe body of the response is an array of the same length as the input array. For each input selector, the output contains a JSON object with the information about the outcome of the operation. If no error occurred, an object is built in which the attribute *_id* contains the known *document-handle* of the removed document, *_key* contains the key which uniquely identifies a document in a given collection, and the attribute *_rev* contains the document revision.\n\nIn case of an error, an object with the attribute *error* set to *true* and *errorCode* set to the error code is built. If the query parameter *returnOld* is *true*, the previous revision of the document is returned under the *old* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with some of the documents, the return code is still 200 or 202, but the additional HTTP header *X-C8-Error-Codes* is set, which contains a map of the error codes that occurred together with their multiplicities, as in: *1200:17,1205:10* which means that in 17 cases the error 1200 \"revision conflict\" and in 10 cases the error 1205 \"illegal document handle\" has happened.", "operationId": "removeDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Collection from which documents are removed.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, adds the *old* attribute which displays original document.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, ignore any *_rev* attribute in the selectors. No revision check is performed.", "in": "query", "name": "ignoreRevs", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "key" } } } }, "description": "An array of keys or documents.", "required": true }, "responses": { "200": { "description": "Successfully removed documents when *waitForSync* is enabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "202": { "description": "Successfully removed documents when *waitForSync* is disabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "404": { "description": "Failed to find specified documents.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove multiple documents", "tags": [ "Documents" ] }, "patch": { "description": "Partially update documents. The *_key* attributes in the body specify which documents should be updated. The body of the request must contain a JSON array of document updates with the attributes to patch (the patch documents). All attributes from the patch documents are added to the existing documents if they do not yet exist and overwritten in the existing documents if they do exist.\n\nSetting an attribute value to *null* in the patch documents causees a value of *null* to be saved for the attribute.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a document in the body and its value does not match the revision of the corresponding document in the database, the precondition is violated.\n\nIf the document exists and can be updated, a *HTTP 201* or a *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nThe body of the response contains a JSON array of the same length as the input array with the information about the handle and the revision of the updated documents. In each entry:\n - *_id* contains the known *document-handle* of each updated document.\n - *_key* contains the key that uniquely identifies a document.\n - *_rev* contains the new document revision.\n\nIn case of an error or violated precondition, an error object with the attribute *error* set to *true* and the attribute *errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each generated document, the previous revision of the document is returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each generated document, the new document is returned under the *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with some of the documents, the return code is still 201 or 202, but the additional HTTP header *X-C8-Error-Codes* is set, which contains a map of the error codes that occurred together with their multiplicities, as in: *1200:17,1205:10* which means that in 17 cases the error 1200 \"revision conflict\" and in 10 cases the error 1205 \"illegal document handle\" has happened.", "operationId": "updateDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection in which the documents are updated.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *false*, you can use the patch command to remove attributes from an existing document if the patch document contains the same attributes with a null value.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "Controls whether objects (not arrays) are merged if present in both the existing and the patch document. If set to *false*, the value in the patch document overwrites the existing document's value. If set to *true*, objects are merged.", "in": "query", "name": "mergeObjects", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If this is set to *true*, the *_rev* attributes in the given documents are ignored. If this is set to *false*, any *_rev* attribute given in a body document is taken as a precondition. The document is only updated if the current revision is the one specified.", "in": "query", "name": "ignoreRevs", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, adds the *old* attribute which displays document revisions.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, adds the new documents to the *new* attribute.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": [ { "_key": "key1", "item1": "data1" } ] } } }, "description": "A JSON representation of an array of document updates as objects.", "required": true }, "responses": { "201": { "description": "Successfully updated documents when *waitForSync* is enabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "202": { "description": "Successfully updated documents when *waitForSync* is disabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update documents", "tags": [ "Documents" ] }, "post": { "description": "Create a new document from the document given in the body, unless there is already a document with the *_key* given. If no *_key* is given, a new unique *_key* is generated automatically.\n\nThe body can be an array of documents, in which case all documents in the array are inserted with the same semantics as for a single document. The result body contains a JSON array of the same length as the input array, and each entry contains the result of the operation for the corresponding input. In case of an error the entry is a document with attributes *error* set to *true* and errorCode set to the error code that has happened.\n\nPossibly given *_id* and *_rev* attributes in the body are always ignored, the URL part or the query parameter collection respectively counts.\n\nIf the document is created successfully, the *Location* header contains the path to the newly created document. The *Etag* header field contains the revision of the document. Both are only set in the single document case.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON object (single document case) with the following attributes:\n\n - *_id* contains the document handle of the newly created document.\n - *_key* contains the document key.\n - *_rev* contains the document revision.\n\nIn the multi case the body is an array of such objects. If the query parameter *returnNew* is *true*, then, for each generated document, the new document is returned under the *new* attribute in the result.", "operationId": "insertDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The *collection* in which the document is to be created.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the collection. This is only for backward compatibility.", "in": "query", "name": "collection", "required": false, "schema": { "type": "string" } }, { "description": "If set to *true*, adds the new documents to the *new* attribute.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, adds the *old* attribute which displays the previous version of the document. Only available if the *overwrite* option is set to *true*.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, an empty object is returned as response. No meta-data is returned for the created document. This option can be used to save some network traffic.", "in": "query", "name": "silent", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, the insert becomes a replace-insert. If a document with the same *_key* already exists the new document is not rejected with unique constraint violated but replaces the old document.", "in": "query", "name": "overwrite", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "example": [ { "item1": "data1" }, { "item2": "data2" } ] } } }, "description": "A JSON representation of a single document or of an array of documents.", "required": true }, "responses": { "201": { "description": "Successfully created documents when *waitForSync* is enabled. If more than one document is specified in the JSON body, check the response body to verify the creations succeeded.", "headers": { "x-c8-error-codes": { "description": "If an error occurred while inserting an array of documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "202": { "description": "Successfully created documents when *waitForSync* is disabled.", "headers": { "x-c8-error-codes": { "description": "If an error occurred while inserting an array of documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed to create document, in the single document case. If a document with the same qualifiers in an indexed attribute conflicts with an already existing document and thus violates that unique constraint, the response body contains an error document. In the array case only 201 or 202 is returned, but if an error occurred, the additional HTTP header *X-C8-Error-Codes* is set, which contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create document", "tags": [ "Documents" ] }, "put": { "description": "Replaces multiple documents in the specified collection with the ones in the body. The replaced documents are specified by the *_key* attributes in the body documents.\n\nIf *ignoreRevs* is *false*,, a *_rev* attribute in each document body must match the revision of the corresponding document in the database. Otherwise, the call fails\n\nIf the document exists and can be updated, a *HTTP 201* or a *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nThe body of the response contains a JSON array of the same length as the input array with the information about the handle and the revision of the replaced documents. In each entry:\n - *_id* contains the known *document-handle* of each updated document.\n - *_key* contains the key which uniquely identifies a document.\n - *_rev* contains the new document revision.\n\nIn case of an error or violated precondition, an error object with the attribute *error* set to *true* and the attribute *errorCode* set to the error code.\n\nIf the query parameter *returnOld* is *true*, for each generated document the previous revision of the document is returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, for each generated document the new document is returned under the *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with some of the documents, the return code is still 201 or 202, but the additional HTTP header *X-C8-Error-Codes* is set, that contains a map of the error codes that occurred together with their multiplicities, as in: *1200:17,1205:10* which means that in 17 cases the error 1200 \"revision conflict\" and in 10 cases the error 1205 \"illegal document handle\" has happened.", "operationId": "replaceDocument:multiple", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "This URL parameter is the name of the collection in which the documents are replaced.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If this is set to *true*, the *_rev* attributes in the given documents are ignored. If this is set to *false*, any *_rev* attribute given in a body document is taken as a precondition. The document is only replaced if the current revision is the one specified.", "in": "query", "name": "ignoreRevs", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, adds the *old* attribute which displays document revisions.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, adds the new documents to the *new* attribute.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": [ { "_key": "key1", "item1": "data1" } ] } } }, "description": "A JSON representation of an array of documents.", "required": true }, "responses": { "201": { "description": "Successfully replaced documents when *waitForSync* is enabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "202": { "description": "Successfully replaced documents when *waitForSync* is disabled.", "headers": { "x-c8-error-codes": { "description": "If any precondition is violated or an error occurred with some of the documents, this header contains a map of the error codes that occurred together with their multiplicities, as in: *1205:10,1210:17* which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_array" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Replace documents", "tags": [ "Documents" ] } }, "/_fabric/{fabric}/_api/document/{collection}/{key}": { "delete": { "description": "If *silent* is set to *false*, the body of the response contains a JSON object with the information about the handle and the revision.\n\n - *_id* contains the known *key* of the removed document.\n - *_key* contains the key which uniquely identifies a document.\n - *_rev* contains the document revision.\n\nIf the query parameter *returnOld* is *true*, the previous revision of the document is returned under the *old* attribute in the result.", "operationId": "removeDocument2", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Remove the document identified by *collection*.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Remove the document identified by *key*.", "in": "path", "name": "key", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, adds the *old* attribute which displays document revisions.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, an empty object is returned as response. No meta-data is returned for the removed document. This option can be used to save some network traffic.", "in": "query", "name": "silent", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "You can conditionally remove a document based on a target revision id by using the *if-match* HTTP header.", "in": "header", "name": "If-Match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully removed document when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed document when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection or document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to remove document due to different version if a *If-Match* header or *rev* is given. The response contains the found document's current revision in the *_rev* attribute. Additionally, the attributes *_id* and *_key* are returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document_get_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove a document", "tags": [ "Documents" ] }, "get": { "description": "Fetch the document identified by *key*. The returned document contains three special attributes:\n - *_id* containing the document handle.\n - *_key* containing key which uniquely identifies a document.\n - *_rev* containing the revision.", "operationId": "readDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The key of the document.", "in": "path", "name": "key", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If the *If-None-Match* header is given, it must contain exactly one ETag. The document is returned, if it has a different revision than the given ETag. Otherwise a *HTTP 304* is returned.", "in": "header", "name": "If-None-Match", "schema": { "type": "string" } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is returned, if it has the same revision as the given ETag. Otherwise a *HTTP 412* is returned.", "in": "header", "name": "If-Match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_data" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "304": { "description": "Document has the same revision if the *If-None-Match* header is given.", "content": { "application/json": { "schema": { "type": "string", "example": "Error: Not modified" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified collection or document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Document has different version if an *If-Match* header is given. The response contains the found document's current revision in the *_rev* attribute. Additionally, the attributes *_id* and *_key* are returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document_get_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read document", "tags": [ "Documents" ] }, "head": { "description": "Like GET, but only fetch the header fields and not the body. You can use this call to get the current revision of a document or check if the document was deleted.", "operationId": "checkDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The key of the document.", "in": "path", "name": "key", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If the *If-None-Match* header is given, it must contain exactly one ETag. If the current document revision is not equal to the specified ETag, a *HTTP 200* response is returned. If the current document revision is identical to the specified ETag, a *HTTP 304* is returned.", "in": "header", "name": "If-None-Match", "schema": { "type": "string" } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is returned, if it has the same revision as the given ETag. Otherwise a *HTTP 412* is returned.", "in": "header", "name": "If-Match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_data" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "304": { "description": "Document has the same version if the *If-None-Match* header is given.", "content": { "application/json": { "schema": { "type": "string", "example": "Error: Not modified" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified collection or document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Document has different version if an *If-Match* header is given. The response contains the found document's current revision in the *_rev* attribute. Additionally, the attributes *_id* and *_key* are returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document_get_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read document header", "tags": [ "Documents" ] }, "patch": { "description": "Partially updates the document identified by *key*. The body of the request must contain a JSON document with the attributes to patch (the patch document). All attributes from the patch document are added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.\n\nSetting an attribute value to *null* in the patch document causes a value of *null* to be saved for the attribute by default.\n\nIf the *If-Match* header is specified and the revision of the document in the database is unequal to the given revision, the precondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false*, a *_rev* attribute in each document bodymust match the revision of the corresponding document in the database. Otherwise, the call fails.\n\nIf a precondition is violated, a *HTTP 412* is returned.\n\nIf the document exists and can be updated, a *HTTP 201* or a *HTTP 202* is returned, the *ETag* header field contains the new revision of the document (in double quotes) and the *Location* header contains a URL under which the document can be queried.\n\nIf *silent* is set to *false*, the body of the response contains a JSON object with the information about the handle and the revision.\n - *_id* contains the known *document-handle* of the updated document.\n - *_key* contains the key that uniquely identifies a document.\n - *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, the previous revision of the document is returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, the new document is returned under the *new* attribute in the result.\n\nIf the document does not exist, a *HTTP 404* is returned and the body of the response contains an error document.", "operationId": "updateDocument2", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "This URL parameter must be a document key.", "in": "path", "name": "key", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If the intention is to remove existing attributes with the patch command, the URL query parameter *keepNull* can be used with a value of *false*. This modifies the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of *null*.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "Controls whether objects (not arrays) is merged if present in both the existing and the patch document. If set to *false*, the value in the patch document overwrites the existing document's value. If set to *true*, objects is merged. The default is *true*.", "in": "query", "name": "mergeObjects", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, the *_rev* attributes in the given document is ignored. If set to *false*, the *_rev* attribute given in the body document is taken as a precondition. The document is only updated if the current revision is the one specified.", "in": "query", "name": "ignoreRevs", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, adds the *old* attribute which displays document revisions.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, adds the new documents to the *new* attribute.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, an empty object is returned as response. No meta-data is returned for the updated document. This option can be used to save some network traffic.", "in": "query", "name": "silent", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "You can conditionally update a document based on a target revision id by using the *if-match* HTTP header.", "in": "header", "name": "If-Match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "_key": "key1", "item1": "data1" } } } }, "description": "A JSON representation of a document update as an object.", "required": true }, "responses": { "201": { "description": "Successfully updated document when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_oldrev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully updated document when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_oldrev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection or document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to the precondition being violated. The response contains the found documents' current revisions in the *_rev* attributes. Additionally, the attributes *_id* and *_key* are returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document_get_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update document", "tags": [ "Documents" ] }, "put": { "description": "Replaces the document with key with the one in the body, provided there is such a document and no precondition is violated.\n\nIf the *If-Match* header is specified and the revision of the document in the database is unequal to the given revision, the precondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false*, a *_rev* attribute in each document body must match the revision of the corresponding document in the database. Otherwise, the call fails.\n\nIf a precondition is violated, a *HTTP 412* is returned.\n\nIf the document exists and can be updated, a *HTTP 201* or a *HTTP 202* is returned (depending on *waitForSync*, see below), the *ETag* header field contains the new revision of the document and the *Location* header contains a URL under which the document can be queried.\n\nIf *silent* is set to *false*, the body of the response contains a JSON object with the information about the handle and the revision.\n - *_id* contains the known *document-handle* of each document.\n - *_key* contains the key that uniquely identifies a document.\n - *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, the previous revision of the document is returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, the new document is returned under the *new* attribute in the result.\n\nIf the document does not exist, a *HTTP 404* is returned and the body of the response contains an error document.", "operationId": "replaceDocument", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "This URL parameter must be a document key.", "in": "path", "name": "key", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, the *_rev* attributes in the given document is ignored. If set to *false*, the *_rev* attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified.", "in": "query", "name": "ignoreRevs", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, adds the *old* attribute which displays document revisions.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, adds the new documents to the *new* attribute.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, an empty object is returned as response. No meta-data is returned for the replaced document. This option can be used to save some network traffic.", "in": "query", "name": "silent", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, returns only after data has been synced to disk.", "in": "query", "name": "waitForSync", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "You can conditionally replace a document based on a target revision id by using the *if-match* HTTP header.", "in": "header", "name": "If-Match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "item1": "data1" } } } }, "description": "A JSON representation of a single document.", "required": true }, "responses": { "201": { "description": "Successfully replaced documents when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_oldrev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully replaced documents when *waitForSync* is disbled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/examples_id_key_rev_oldrev" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection or document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to the precondition being violated. The response contains the found documents' current revisions in the *_rev* attributes. Additionally, the attributes *_id* and *_key* are returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document_get_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Replace document", "tags": [ "Documents" ] } }, "/_fabric/{fabric}/_api/collection": { "get": { "description": "Fetch the list of all collections.", "operationId": "handleCommandGet", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Whether or not system collections should be excluded from the result.", "in": "query", "name": "excludeSystem", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully fetched collections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all collections", "tags": [ "Collections" ] }, "post": { "description": "Create collection.", "operationId": "handleCommandPost:CreateCollection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fabric_collection_validate" } } }, "required": true }, "responses": { "200": { "description": "Successfully created collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_http_200_help" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create collection", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}": { "delete": { "description": "Remove the collection.", "operationId": "handleCommandDelete:collection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection to remove.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Whether or not the collection to remove is a system collection. This parameter must be set to *true* in order to remove system collections.", "in": "query", "name": "isSystem", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully removed collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_post_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove collection", "tags": [ "Collections" ] }, "get": { "description": "Fetch the information about collection.", "operationId": "handleCommandGet:collectionGetProperties", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_get_collection_name_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the information about collection", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}/workflows": { "get": { "description": "Retrieve details of assigned workflows to a collection.", "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Collection" } ], "summary": "Get workflows", "tags": [ "Collections" ], "operationId": "getWorkflows", "responses": { "200": { "description": "Successfully fetched the workflows assigned to the collection.", "content": { "application/json": { "schema": { "title": "WorkflowsResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEntity" } } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "post": { "description": "Create a new workflow to an external data source or target from an existing collection.", "summary": "Create a workflow", "tags": [ "Collections" ], "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Collection" } ], "operationId": "createWorkflow", "requestBody": { "description": "Workflow definition.", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "201": { "description": "Successfully created the workflow.", "content": { "application/json": { "schema": { "title": "WorkflowResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/WorkflowEntity" } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/collection/{collection-name}/workflows/{workflow-name}": { "delete": { "description": "Remove a workflow from a collection.", "summary": "Remove workflow", "tags": [ "Collections" ], "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Collection" }, { "$ref": "#/components/parameters/Workflow" } ], "operationId": "deleteWorkflow", "responses": { "200": { "description": "Successfully deleted the workflow.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection or workflow.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/collection/{collection-name}/metadata": { "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Collection" } ], "get": { "description": "Retrieve metadata related to the collection.", "summary": "Retrieve additional collection metadata", "tags": [ "Collections" ], "operationId": "getMetadata", "responses": { "200": { "description": "Successfully retrieved metadata of a collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionMetadataResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the metadata entry for the collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "put": { "description": "Update metadata related to the collection.", "summary": "Update collection metadata", "tags": [ "Collections" ], "operationId": "updateMetadata", "requestBody": { "description": "Metadata to update. Not all fields of metadata entity can be updated. You can only update the object properties of workflows.", "required": true, "content": { "application/json": { "schema": { "type": "object", "title": "CollectionMetadataUpdateEntity", "properties": { "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowMetadataEntity" } } } } } } }, "responses": { "200": { "description": "Successfully updated metadata of the collection.", "content": { "application/json": { "schema": { "type": "object", "title": "CollectionMetadataUpdateResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "object", "title": "CollectionMetadataUpdateResponseEntity", "properties": { "_key": { "type": "string", "example": 123456 }, "_rev": { "type": "string", "example": "_3er45_" } } } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the metadata entry for the collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/collection/{collection-name}/reload": { "put": { "description": "Truncate the collection and reload data from source connection.", "summary": "Truncate and reload data", "tags": [ "Collections" ], "operationId": "reloadCollection", "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Collection" } ], "responses": { "200": { "description": "Successfully reloaded collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBase" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/collection/{collection-name}/count": { "get": { "description": "Retrieve the count of documents within the collection.\n\n**Note**: This always loads the collection into memory.", "operationId": "handleCommandGet:getCollectionCount", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched number of documents in a collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_get_count_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get number of documents in a collection", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}/figures": { "get": { "description": "Returns an object containing statistics about a collection.\n\n**Note**: This always loads the collection into memory.", "operationId": "handleCommandGet:collectionFigures", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Returns information about the collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_api_collection_figures_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Return figures of a collection", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}/truncate": { "put": { "description": "Remove all documents from the collection but leaves the indexes intact.", "operationId": "handleCommandPut:truncateCollection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed all the documents.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_get_collection_name_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Truncate collection", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}/properties": { "put": { "description": "Changes the properties of a collection.", "operationId": "handleCommandPut:modifyProperties", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_put_properties_http_examples_rc_200" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated the document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_put_collection_property_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update collection properties", "tags": [ "Collections" ] } }, "/_fabric/{fabric}/_api/function": { "get": { "description": "List multiple edge functions.", "operationId": "ListAllFunctionWorkerByType", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "type", "in": "query", "description": "Type of edge function.", "schema": { "type": "string", "enum": [ "all", "akamai", "macrometa" ], "default": "all" } } ], "responses": { "200": { "description": "Successfully fetched edge functions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_edge_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List multiple edge functions.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/generate": { "post": { "description": "Deploy the query worker to the edge worker environment.\n\n**Note**: The edge worker activation is delayed while the environment is setup. Use the get edge function information API to get the activation status of the edge worker.", "operationId": "GenerateFunctionWorkerFromQueryWorker", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "type", "in": "query", "description": "Type of edge worker.", "schema": { "type": "string", "enum": [ "akamai" ], "default": "akamai" } }, { "name": "name", "required": true, "in": "query", "description": "Name of the edge worker.", "schema": { "type": "string" } }, { "name": "queryWorkerName", "required": true, "in": "query", "description": "Name of the Macrometa query worker.", "schema": { "type": "string" } }, { "name": "environment", "required": false, "in": "query", "description": "The environment in which the edge worker is activated.", "schema": { "type": "string", "enum": [ "STAGING", "PRODUCTION" ], "default": "PRODUCTION" } } ], "responses": { "202": { "description": "Successfully deployed the query worker to the edge worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generate_edge_worker_from_query_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Deploy the query worker to the edge worker.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/generate/publisher": { "post": { "description": "Deploy the stream publisher to the edge worker environment.\n\n**Note**: The edge worker activation is delayed while the environment is setup. Use the get edge function information API to get the activation status of the edge worker.", "operationId": "GenerateFunctionWorkerFromStreamPublisher", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "type", "in": "query", "description": "Type of edge worker.", "schema": { "type": "string", "enum": [ "akamai" ], "default": "akamai" } }, { "name": "name", "required": true, "in": "query", "description": "Name of the edge worker.", "schema": { "type": "string" } }, { "name": "streamWorkerName", "required": true, "in": "query", "description": "Name of the stream worker.", "schema": { "type": "string" } }, { "name": "streamName", "required": true, "in": "query", "description": "Name of the stream.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "The environment in which the edge worker is activated.", "schema": { "type": "string", "enum": [ "STAGING", "PRODUCTION" ], "default": "PRODUCTION" } } ], "responses": { "202": { "description": "Successfully deployed the stream publisher to the edge worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generate_edge_worker_from_query_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Deploy the stream publisher to the edge worker.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/generate/query": { "post": { "description": "Deploy the stream adhoc query to the edge worker environment. \n\n**Note**: The edge worker activation is delayed while the environment is setup. Use the get edge function information API to get the activation status of the edge worker.", "operationId": "GenerateFunctionWorkerFromStreamQuery", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "type", "in": "query", "description": "Type of edge worker.", "schema": { "type": "string", "enum": [ "akamai" ], "default": "akamai" } }, { "name": "name", "required": true, "in": "query", "description": "Name of the edge worker.", "schema": { "type": "string" } }, { "name": "streamWorkerName", "required": true, "in": "query", "description": "Name of the stream worker.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "The environment in which the edge worker is activated.", "schema": { "type": "string", "enum": [ "STAGING", "PRODUCTION" ], "default": "PRODUCTION" } } ], "responses": { "202": { "description": "Successfully deploy the stream adhoc query to the edge worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generate_edge_worker_from_query_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Deploy the stream adhoc query to the edge worker.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/{fx-name}": { "get": { "description": "Get edge function information.", "operationId": "GetFunctionWorkerByFunctionName", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "fx-name", "required": true, "in": "path", "description": "The name of the edge function.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched information about the edge function.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edge_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get edge function information.", "tags": [ "Function" ] }, "delete": { "description": "Remove a edge function.", "operationId": "DeleteFunctionWorkerByFunctionName", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "fx-name", "required": true, "in": "path", "description": "The name of the edge function.", "schema": { "type": "string", "format": "string" } } ], "responses": { "204": { "description": "Successfully removed edge function.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove a edge function.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/invoke/{fx-name}": { "post": { "description": "Invoke a edge function.", "operationId": "InvokeFunctionWorkerByFunctionName", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "name": "fx-name", "required": true, "in": "path", "description": "The name of the edge function.", "schema": { "type": "string", "format": "string" } }, { "name": "params", "required": false, "in": "query", "description": "Params for edge worker like bindVars or query. E.g: {'key1':'val1'}.", "schema": { "type": "string", "default": "{}" } } ], "responses": { "201": { "description": "Successfully invoked the edge function.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoke_function_worker_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Invoke a edge function.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/function/metadata": { "get": { "description": "Get metadata about the edge worker.", "operationId": "GetFunctionWorkerMetadata", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched the metadata about the edge worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/function_worker_metadata_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get metadata about the edge worker.", "tags": [ "Function" ] }, "put": { "description": "Modify the edge worker metadata.", "operationId": "ModifyFunctionWorkerMetadata", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modify_function_worker_metadata" } } }, "required": true }, "responses": { "201": { "description": "Successfully modified the edge worker metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_function_metadata_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify the edge worker metadata.", "tags": [ "Function" ] }, "post": { "description": "Create the edge worker metadata.", "operationId": "UpdateFunctionWorkerMetadata", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/function_worker_metadata" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the edge worker metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_function_metadata_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create the edge worker metadata.", "tags": [ "Function" ] }, "delete": { "description": "Remove metadata for an edge worker.", "operationId": "RemoveFunctionWorkerMetadata", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "204": { "description": "Successfully removed edge worker metadata.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove the edge worker metadata.", "tags": [ "Function" ] } }, "/_fabric/{fabric}/_api/cursor": { "post": { "description": "Queries are executed on the server and the results are returned to the client.\n\n If the resulting queries returned a number of documents less than the *batchSize* (attribute set in query), then all documents are returned in the *result* JSON attribute.\n\n If there are more documents than the defined *batchSize*, then the *hasMore* JSON attribute is set to *true* and the *id* JSON attribute contains the cursor ID. The cursor ID is then used in subsequent calls to the cursor API to retrieve all documents. This is repeated until the *hasMore* JSON attribute is set to false. The cursor ID will cease to exist after the seconds specified in the *ttl* attribute.\n\n In the event that a search view is used in the query and this search view has been paused due to resource constraints, the *x-gdn-view* header is set with the list of all paused views.", "operationId": "createQueryCursor", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the cursor.", "headers": { "x-gdn-view": { "description": "List of paused search views used by query.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_201" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create cursor from C8QL query", "tags": [ "Query" ] } }, "/_fabric/{fabric}/_api/cursor/sql": { "post": { "description": "To more efficiently batch communication, results of SQL queries are returned as cursors. Each REST API call returns a portion of the documents in a batch and indicates if this is the final batch. Batches are sent until the batch with the final indicator.\n\nDepending on the query, the total number of documents in the result set might not be known in advance.\n\nIn order to free resources, delete the cursor as soon as it is no longer needed.", "operationId": "createSqlQueryCursor", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sql_api_cursor" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create cursor from SQL query.", "tags": [ "Query" ] } }, "/_fabric/{fabric}/_api/cursor/{cursor-identifier}": { "delete": { "description": "Remove the cursor and free the resources associated with it. The cursor is automatically removed on the server when the client has retrieved all documents from it. The client can also explicitly remove the cursor at any earlier time using a HTTP DELETE request. The cursor *ID* must be included as part of the URL.\n\n**Note**: The server automatically removes abandoned cursors after a period of time specified by the *ttl* attribute when the cursor was created.", "operationId": "deleteQueryCursor", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The id of the cursor.", "in": "path", "name": "cursor-identifier", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed the cursor.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Id of cursor", "type": "string", "example": "11177234" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove cursor", "tags": [ "Query" ] }, "put": { "description": "If the cursor has not been deleted, fetch an object with the following attributes:\n\n- *id*: the *cursor-identifier*\n- *result*: a list of documents for the current batch\n- *hasMore*: *false* if this was the last batch\n- *count*: if present the total number of elements\n\nIf *hasMore* returns *true*, the next call might still return no documents. If *hasMore* is *false*, the cursor is exhausted. Once the *hasMore* attribute has a value of *false*, the client can stop.", "operationId": "modifyQueryCursor", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the cursor.", "in": "path", "name": "cursor-identifier", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched JSON object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_cursor_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read next batch from cursor", "tags": [ "Query" ] } }, "/_fabric/{fabric}/_api/query": { "post": { "description": "This endpoint is for query validation only. To query the database, see `/api/cursor`.", "operationId": "parseQuery", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_query_properties" } } }, "required": true }, "responses": { "200": { "description": "Successfull fetched *collections* attributes with an array of collections used in the query and *bindVars* attribute with names of the bind parameters found in the query (if any).\n\nIf the query is parsed successfully, the *ast* attribute of the returned JSON contain the abstract syntax tree representation of the query. The format of the *ast* is subject to change in future versions of database, but it can be used to inspect how database interprets a given query. Note that the abstract syntax tree is returned without any optimizations applied to it.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "parsed": true, "collections": [ "testCollection" ], "bindVars": [], "ast": [ { "type": "root", "subNodes": [ { "type": "for", "subNodes": [ { "type": "variable", "name": "u", "id": 0 }, { "type": "collection", "name": "testCollection" }, { "type": "no-op" } ] }, { "type": "return", "subNodes": [ { "type": "reference", "name": "u", "id": 0 } ] } ] } ] } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing, malformed data or the query contains a parse error. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Parse an C8QL query", "tags": [ "Query" ] } }, "/_fabric/{fabric}/_api/query/explain": { "post": { "description": "To explain how an C8QL query would run on the server, the query string can be sent to the server via a HTTP POST request. The server validates the query and creates an execution plan for it. The execution plan is returned, but the query does not run.\n\nThe execution plan that is returned by the server can be used to estimate the probable performance of the query. Though the actual performance depends on many different factors, the execution plan normally can provide some rough estimates on the amount of work the server needs to do in order to run the query.\n\nBy default, the explain operation returns the optimal plan as chosen by the query optimizer. The optimal plan is the plan with the lowest total estimated cost. The response object contains the plan as a *plan* attribute. If the option *allPlans* is specified in the request, the result contains all plans created by the optimizer. The plans are returned in the attribute *plans*.\n\nThe result also contains an attribute *warnings*, that is an array of warnings that occurred during optimization or execution of plan creation. Additionally, the result contains a *stats* attribute with optimizer statistics. If *allPlans* is set to *false*, the result contains an attribute *cacheable* that states whether the query results can be cached on the server if the query result cache were used. The *cacheable* attribute is not present when *allPlans* is set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan.\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple plans, the optimizer chooses the plan with the lowest total cost.\n- *collections*: an array of collections used in the query\n- *rules*: an array of rules the optimizer applied.\n- *variables*: array of variables used in the query.", "operationId": "explainQuery", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_explain" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched the optimal execution plan in the *plan* attribute. If option *allPlans* is set in the request, an array of plans is returned in the *allPlans* attribute instead.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "plans": [ { "nodes": [ { "type": "SingletonNode", "dependencies": [], "id": 1, "estimatedCost": 1, "estimatedNrItems": 1 }, { "type": "EnumerateCollectionNode", "dependencies": [ 1 ], "id": 2, "estimatedCost": 9, "estimatedNrItems": 7, "random": false, "indexHint": { "forced": false, "type": "none" }, "outVariable": { "id": 0, "name": "u" }, "projections": [], "producesResult": true, "database": "_system", "collection": "testCollection", "satellite": false }, { "type": "ReturnNode", "dependencies": [ 2 ], "id": 3, "estimatedCost": 16, "estimatedNrItems": 7, "inVariable": { "id": 0, "name": "u" }, "count": true } ], "rules": [], "collections": [ { "name": "testCollection", "type": "read" } ], "variables": [ { "id": 0, "name": "u" } ], "estimatedCost": 16, "estimatedNrItems": 7, "initialize": true, "isModificationQuery": false } ], "warnings": [], "stats": { "rulesExecuted": 35, "rulesSkipped": 1, "plansCreated": 1 } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing, malformed data or the query contains a parse error. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to validate query due to non-existing collection being accessed by the query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Explain an C8QL query", "tags": [ "Query" ] } }, "/_fabric/{fabric}/_api/restql": { "post": { "description": "Save a query for a user for a fabric.", "operationId": "SaveRestqlByName", "parameters": [ { "description": "Fabric name for which to save query.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_queries_create_user_queries" } } }, "required": true }, "responses": { "200": { "description": "Successfully saved query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_workers_post_restql_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Save query worker", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/restql/import": { "post": { "description": "Import custom queries.", "operationId": "ImportCustomRestQL", "parameters": [ { "description": "Fabric name for which to import queries.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_queries_import_custom_queries" } } }, "required": true }, "responses": { "200": { "description": "Successfully imported queries.\n\nIf there are any errors, an additional header *X-C8-Error-Codes* is set, that contains a map of the error codes that occurred together with their multiplicities, as in: 1205:10,1210:17 which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened. The response body has additional failed document details in *details* object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_import_custom_query_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed because of missing or malformed user-query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the GeoFabric or you have reached the limit on *Max Stored Query Workers*. You need to upgrade to *Scale* plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Import custom query workers", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/restql/execute/{name}": { "post": { "description": "Run a saved query for a given fabric. If there are more that 100 records (*default batch-size*), the *hasMore* flag is set to *true* and the *id* is set. This *id* is used to query subsequent records.", "operationId": "ExecuteRestqlByName", "parameters": [ { "description": "Fabric name of the saved query.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Query name to run.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_queries_execute_saved_queries" } } }, "required": true }, "responses": { "201": { "description": "Successfully ran the query.", "headers": { "x-gdn-view": { "description": "List of paused search views used by query.", "schema": { "type": "string" } }, "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_workers_post_restql_execute_rc_201" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to run the query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Run query worker", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/restql/fetch/{id}": { "put": { "description": "If the query worker cursor is still valid, returns an object with the following attributes:\n\n- *id*: the *cursor-identifier*\n- *result*: a list of documents for the current batch\n- *hasMore*: *false* if this was the last batch\n- *count*: if present the total number of elements\n\nIf *hasMore* returns *true*, the next call might still return no documents. If *hasMore* is *false*, the cursor is exhausted. Once the *hasMore* attribute has a value of *false*, the client can stop.", "operationId": "fetchRestqlCursor", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The id of the cursor.", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the next batch of records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_workers_post_restql_execute_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read next batch from cursor", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/restql/user": { "get": { "description": "Fetch list of saved queries for the fabric.", "operationId": "ListRestqlAssociatedWithCurrentUser", "parameters": [ { "description": "Fabric name for which to list saved queries.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched queries.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_workers_get_restql_user_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have permission to list query workers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List current query workers", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/restql/{name}": { "delete": { "description": "Remove a query for the fabric.", "operationId": "DeleteRestqlByName", "parameters": [ { "description": "Fabric name for which to remove a query.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Query name to be removed.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed query.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "example": [], "items": {} } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to remove the query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove query worker", "tags": [ "Query Workers" ] }, "put": { "description": "Update a saved query for a fabric.", "operationId": "UpdateRestqlByName", "parameters": [ { "description": "Fabric name for which to update a query.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Query name to update.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_queries_update_user_queries" } } }, "required": true }, "responses": { "200": { "description": "Sucessfully updated the query.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "object", "properties": { "value": { "description": "The query being saved", "type": "string", "example": "for u in testCollection return u" }, "_key": { "description": "The key for this record", "type": "string", "example": "testuser._system.testQueryName" } } } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to update the query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update query worker", "tags": [ "Query Workers" ] } }, "/_fabric/{fabric}/_api/index": { "get": { "description": "Fetch the list of all indexes of a collection.", "operationId": "getIndexes", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched indexes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all indexes of a collection", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/fulltext": { "post": { "description": "Create full-text index, if it does not already exist.", "operationId": "createIndex:fulltext", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_fulltext_body" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_fulltext_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_fulltext_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create fulltext index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/general": { "post": { "description": "Create a new index.\n\n**Note**: Indexing the system attribute _id is not supported for user-defined indexes. Manually creating an index using _id as an index attribute fails with an error.", "operationId": "createIndex:general", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_general_body" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_fulltext_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_fulltext_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/geo": { "post": { "description": "Create a geo index.\n\n**Note**: Geo indexes are always sparse, meaning that documents that do not contain the index attributes or have non-numeric values in the index attributes are not indexed.", "operationId": "createIndex:geo", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_geo" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing geo index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_geo_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created geo index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_geo_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create geo-spatial index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/hash": { "post": { "description": "Create a hash index.\n\n**Note**:\n- In a sparse index all documents are excluded from the index that do not contain at least one of the specified index attributes (i.e. *fields*) or that have a value of *null* in any of the specified index attributes. Such documents are not indexed and are not taken into account for uniqueness checks if the *unique* flag is set.\n- In a non-sparse index, these documents are indexed (for non-present indexed attributes, a value of *null* is used) and are taken into account for uniqueness checks if the *unique* flag is set.\n- Unique indexes on non-shard keys are not supported in a cluster.", "operationId": "createIndex:hash", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_hash" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing hash index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_hash_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created hash index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_hash_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create hash index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/persistent": { "post": { "description": "Create a hash index.\n\n **Note**:\n- In a sparse index all documents are excluded from the index that do not contain at least one of the specified index attributes (i.e. *fields*) or that have a value of *null* in any of the specified index attributes. Such documents are not indexed and are not taken into account for uniqueness checks if the unique flag is set.\n- In a non-sparse index, these documents are indexed (for non-present indexed attributes, a value of *null* is used) and are taken into account for uniqueness checks if the *unique* flag is set.\n- Unique indexes on non-shard keys are not supported in a cluster.", "operationId": "createIndex:persistent", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_persistent" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing persistent index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_persistent_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created persistent index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_persistent_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create a persistent index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/skiplist": { "post": { "description": "Create a hash index.\n\n**Note**:\n- In a sparse index all documents are excluded from the index that do not contain at least one of the specified index attributes (i.e. *fields*) or that have a value of *null* in any of the specified index attributes. Such documents are not indexed and are not taken into account for uniqueness checks if the *unique* flag is set.\n- In a non-sparse index, these documents are indexed (for non-present indexed attributes, a value of *null* is used) and are taken into account for uniqueness checks if the *unique* flag is set.\n- Unique indexes on non-shard keys are not supported in a cluster.", "operationId": "createIndex:skiplist", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_skiplist" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing skiplist index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_skiplist_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created skiplist index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_skiplist_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create skip list", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/ttl": { "post": { "description": "Create a hash index.", "operationId": "createIndex:ttl", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "query", "name": "collection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_ttl" } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched existing ttl index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_ttl_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "201": { "description": "Successfully created ttl index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_ttl_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create TTL index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/index/{collection}/{indexName}": { "delete": { "description": "Remove an index.", "operationId": "dropIndex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the index.", "in": "path", "name": "indexName", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_ttl_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove index", "tags": [ "Indexes" ] }, "get": { "description": "Fetch the information about index.", "operationId": "getIndexes:handle", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The collection name.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the index.", "in": "path", "name": "indexName", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched index information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_index_post_fulltext_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read index", "tags": [ "Indexes" ] } }, "/_fabric/{fabric}/_api/graph": { "get": { "description": "Lists all graphs stored in this GeoFabric.", "operationId": "ListAllGraphs", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched graphs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_list_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all graphs", "tags": [ "Graphs" ] }, "post": { "description": "To create a graph, you must name the graph and define its edges.\n\n**Note**: Requires *Administrator* permissions to access the GeoFabric and *Read Only* access on every collection used within this graph.", "operationId": "CreateAGraph", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_create_http_examples" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the graph when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_create_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully created the graph when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_create_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed to store graph. Verify that a graph with this name does not already exist. Also, verify that the edge definitions are not used with a different signature by another graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create a graph", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}": { "delete": { "description": "Remove an existing graph object by name. Optionally all collections not used by other graphs can be removed as well.\n\n**Note**: Requires *administrator* permissions.", "operationId": "DropAGraph", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Remove collections of this graph. Collections are only removed if they are not used in other graphs.", "in": "query", "name": "dropCollections", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "201": { "description": "Successfully removed the graph when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "example": { "code": 201, "error": false, "removed": true } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed the graph when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false, "removed": true } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove a graph", "tags": [ "Graphs" ] }, "get": { "description": "Fetch information for a graph. Returns the edge definitions and orphan collections.", "operationId": "GetAGraph", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the graph data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get a graph", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/edge": { "get": { "description": "Fetch all edge collections within this graph.", "operationId": "ListEdgedefinitions", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched edge definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_list_edge_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List edge definitions", "tags": [ "Graphs" ] }, "post": { "description": "Adds an additional edge definition to the graph.\n\nThis edge definition has to contain a *collection* and an array of each *from* and *to* vertex collections. An edge definition can only be added if this definition is either not used in any other graph, or it is used with exactly the same definition. It is not possible to store a definition \"e\" from \"v1\" to \"v2\" in the one graph, and \"e\" from \"v2\" to \"v1\" in the other graph.\n\n**Note**: Requires *administrator* permissions.", "operationId": "AddEdgedefinition", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_add_http_examples" } } }, "required": true }, "responses": { "201": { "description": "Successfully added edge when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_add_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully added edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_add_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing, malformed data, or if the definition is used in another graph with a different signature. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Add edge definition", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/edge/{edgeCollection}": { "post": { "description": "Create a new edge in the collection.\n\n**Note:** Requires *Read Only* permissions on the GeoFabric and *Write* access on the collection.", "operationId": "CreateAnEdge", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "edgeCollection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, the response contains the complete new version of the document.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_create_http_examples" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the edge when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_create_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully created the edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_create_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find graph, edge collection, `_from` or `_to`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create an edge", "tags": [ "Graphs" ] }, "put": { "description": "Change a specified edge definition.\n\nThis modifies all occurrences of this definition in all graphs known to your GeoFabric.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ReplaceAnEdgedefinition", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "edgeCollection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, also removes the collection. Collection is only removed if it is not used in other graphs.", "in": "query", "name": "dropCollections", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_modify_http_examples" } } }, "required": true }, "responses": { "201": { "description": "Successfully replaced edge when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_modify_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully replaced edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_modify_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Replace an edge definition", "tags": [ "Graphs" ] }, "delete": { "description": "Remove one edge definition from the graph. This only removes the edge collection, the vertex collections can still be used in your queries.\n\n**Note**: Requires *administrator* permissions.", "operationId": "RemoveAnEdgedefinitionFromTheGraph", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "edgeCollection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Set *true* to remove the collection. Collection is only removed if it is not used in other graphs.", "in": "query", "name": "dropCollections", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "201": { "description": "Successfully removed edge definition when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_remove_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed edge definition when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_definition_remove_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph or edge definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove an edge definition", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/edge/{collection}/{edge}": { "delete": { "description": "Remove an edge from the collection.\n\n**Note:** Requires *Read Only* permissions on the GeoFabric and *Write* access on the collection.", "operationId": "RemoveAnEdge", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the edge.", "in": "path", "name": "edge", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, the removed document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean" } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is updated, if it has the same revision as the given ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully removed the edge.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_delete_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed the edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_delete_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find graph, collection, or edge.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to remove document due to different version if a *If-Match* header or *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove an edge", "tags": [ "Graphs" ] }, "get": { "description": "Fetch an edge from the given collection.\n\n**Note**: Requires *Read Only* permissions to access the GeoFabric and *Read Only* access on the collection.", "operationId": "GetAnEdge", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the edge.", "in": "path", "name": "edge", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Must contain a revision. If this is set a document is only returned if it has exactly this revision. Also see *if-match* header as an alternative to this.", "in": "query", "name": "rev", "required": false, "schema": { "type": "string" } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is returned if it does *not* have the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } }, { "description": "If the *If-None-Match* header is given, it must contain exactly one ETag. The document is returned if it does *not* have the same revision as the provided ETag. Otherwise a HTTP 304 is returned.", "in": "header", "name": "if-none-match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched edge.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "304": { "description": "If the *If-None-Match* header was used, the document has the same revision since the last time the edge was fetched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirect_example_rc_304" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find graph, collection, or vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get an edge", "tags": [ "Graphs" ] }, "patch": { "description": "Update the data of the specific edge in the collection.\n\n**Note:** Requires *Read Only* permissions on the GeoFabric and *Write* access on the collection.", "operationId": "ModifyAnEdge", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "edge", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *false*, null attributes are deleted from the document.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, the deleted document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, the new document is returned in the response object.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is only updated if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "data": 1234 } } } }, "description": "The body has to contain a JSON object containing exactly the attributes that should be overwritten, all other attributes remain unchanged.", "required": true }, "responses": { "200": { "description": "Successfully updated edge when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_modify_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully updated edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_modify_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find graph, collection, vertex, `_from` or `_to`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or *rev* is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify an edge", "tags": [ "Graphs" ] }, "put": { "description": "Replaces the data of an edge in the collection.\n\n**Note:** Requires *Read Only* permissions on the GeoFabric and *Write* access on the collection.", "operationId": "ReplaceAnEdge", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the edge collection the edge belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "edge", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *false*, null attributes are deleted from the document.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, the deleted document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, the new document is returned in the response object.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is only updated if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_replace_http_examples" } } }, "required": true }, "responses": { "201": { "description": "Successfully replaced edge when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_replace_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully replaced edge when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_edge_replace_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find graph, collection, vertex, `_from` or `_to`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Replace an edge", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/vertex": { "get": { "description": "Fetch all vertex collections within this graph.", "operationId": "ListVertexCollections", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched array of vertex collections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_list_vertex_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List vertex collections", "tags": [ "Graphs" ] }, "post": { "description": "Adds a vertex collection to the set of orphan collections of the graph. If the collection does not exist, it is created.\n\n**Note:** Requires *Administrator* permissions to access the GeoFabric and *Read Only* access on every collection used within this graph.", "operationId": "AddVertexCollection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "201": { "description": "Successfully created the vertex collection when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_collection_add_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully created the vertex collection when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_collection_add_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Add vertex collection", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/vertex/{collection}": { "delete": { "description": "Remove a vertex collection from the graph and optionally the collection, if it is not used in any other graph. It only removes vertex collections that are no longer part of edge definitions.\n\n**Note**: Requires *administrator* permissions.", "operationId": "RemoveVertexCollection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Set *true* to remove the collection. Collection is only removed if it is not used in other graphs.", "in": "query", "name": "dropCollection", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully removed vertex collection when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_collection_remove_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed vertex collection when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_collection_remove_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed because the vertex collection is still used in an edge definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove vertex collection", "tags": [ "Graphs" ] }, "post": { "description": "Adds a vertex to the given collection.\n\n**Note:** Requires *Read Only* permissions to access the GeoFabric and *Write* permissions to access the collection.", "operationId": "CreateAVertex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection the vertex should be inserted into.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, the response contains the complete new document.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "collection": "demo1" } } } }, "description": "The body has to be the JSON object to be stored.", "required": true }, "responses": { "201": { "description": "Successfuly added the vertex when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_create_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfuly added the vertex when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_create_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph or collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create a vertex", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/graph/{graph}/vertex/{collection}/{vertex}": { "delete": { "description": "Remove a vertex from the collection.\n\n**Note:** Requires *Read Only* permissions to access the GeoFabric and *Write* permissions to access the collection.", "operationId": "RemoveAVertex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection the vertex belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "vertex", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, the deleted document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is only updated if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully removed vertex when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_delete_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully removed vertex when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_delete_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph, collection, or vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove a vertex", "tags": [ "Graphs" ] }, "get": { "description": "Fetch a vertex from the given collection.\n\n**Note:** Requires *Read Only* permissions to access the GeoFabric and *Read Only* permissions to access the collection.", "operationId": "GetAVertex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection the vertex belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "vertex", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Must contain a revision. If this is set a document is only returned if it has exactly this revision. Also see *if-match* header as an alternative to this.", "in": "query", "name": "rev", "required": false, "schema": { "type": "string", "default": false } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is returned if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } }, { "description": "If the *If-None-Match* header is given, it must contain exactly one ETag. The document is returned if it does *not* have the same revision as the provided ETag. Otherwise a HTTP 304 is returned.", "in": "header", "name": "if-none-match", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched the vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_get_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "304": { "description": "Document has the same revision as specified in the *If-None-Match* header. There is no update since the last time the vertex was fetched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_get_http_examples_rc_304" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph, collection, or vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get a vertex", "tags": [ "Graphs" ] }, "patch": { "description": "Update the data of the specific vertex in the collection.\n\n**Note:** Requires *Read Only* permissions to access the GeoFabric and *Write* permissions to access the collection.", "operationId": "UpdateAVertex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection the vertex belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "vertex", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *false*, null attributes are deleted from the document.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": true } }, { "description": "If set to *true*, the deleted document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, the new document is returned in the response object.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is only updated if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "data": "demo1" } } } }, "description": "The body has to contain a JSON object containing exactly the attributes that should be overwritten, all other attributes remain unchanged.", "required": true }, "responses": { "200": { "description": "Successfully updated the vertex when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_modify_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully updated the vertex when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_modify_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph, collection, or vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or rev is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update a vertex", "tags": [ "Graphs" ] }, "put": { "description": "Replaces the data of a vertex in a collection.\n\n**Note:** Requires *Read Only* permissions to access the GeoFabric and *Write* permissions to access the collection.", "operationId": "ReplaceAVertex", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the graph.", "in": "path", "name": "graph", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the vertex collection the vertex belongs to.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The *_key* attribute of the vertex.", "in": "path", "name": "vertex", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *false*, null attributes are deleted from the document.", "in": "query", "name": "keepNull", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, the deleted document is returned in the response object.", "in": "query", "name": "returnOld", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If set to *true*, the new document is returned in the response object.", "in": "query", "name": "returnNew", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "If the *If-Match* header is given, it must contain exactly one ETag. The document is only updated if it has the same revision as the provided ETag. Otherwise a HTTP 412 is returned. As an alternative you can supply the ETag in a query parameter *rev*.", "in": "header", "name": "if-match", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "data": "demo1" } } } }, "description": "The body has to be the JSON object to be stored.", "required": true }, "responses": { "200": { "description": "Successfully replace vertex when *waitForSync* is enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_replace_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "202": { "description": "Successfully replaced vertex when *waitForSync* is disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph_vertex_replace_http_examples_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified graph, collection, or vertex.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed to return document due to different version if a *If-Match* header or a *rev* attribute is given.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Replace a vertex", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/edges/{collection-id}": { "get": { "description": "Fetch an array of edges starting or ending in the vertex identified by *vertex*.", "operationId": "ReadIn-OrOutboundEdges", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The id of the collection.", "in": "path", "name": "collection-id", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The id of the start vertex.", "in": "query", "name": "vertex", "required": true, "schema": { "type": "string" } }, { "description": "Select *in* or *out* direction for edges. If not set, all edges are returned.", "in": "query", "name": "direction", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched the edges.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified edge collection.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read in- or outbound edges", "tags": [ "Graphs" ] } }, "/_fabric/{fabric}/_api/streams": { "get": { "description": "Fetch the list of all streams.", "operationId": "ListOfStreams", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": false, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully fetched the list of all streams.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_streams_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get list of streams", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}": { "post": { "description": "Create a stream.", "operationId": "CreateStream", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 230 characters).", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Whether the stream is geo-replicated globally", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully created the stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_stream_example_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because stream already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create stream", "tags": [ "Streams" ] }, "delete": { "description": " Remove a stream.", "operationId": "DeleteStream", "parameters": [ { "description": "Fabric name of the stream.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Stop all producers/consumers and delete the stream forcefully. *deprecated*", "in": "query", "name": "force", "required": true, "schema": { "type": "boolean", "format": "string", "default": true } } ], "responses": { "200": { "description": "Successfully removed stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_stream_example_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove stream", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/publish": { "post": { "description": "Publish message in a stream.", "operationId": "PublishStreamMessage", "parameters": [ { "description": "Fabric name of the stream.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Name of the message.", "required": true }, "responses": { "200": { "description": "Successfully published message to the stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publish_stream_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Publish message", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/backlog": { "get": { "description": "Get the estimated backlog for the stream.", "operationId": "Backlog", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the stream backlog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_stream_backlog_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get backlog for the stream", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/stats": { "get": { "description": "Get the statistics for a stream.", "operationId": "Stats", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "If set to *true*, returns precise backlog", "in": "query", "name": "getPreciseBacklog", "required": false, "schema": { "type": "boolean", "format": "string", "default": "false" } }, { "description": "If set to *true*, returns backlog size for each subscription.\n\nNote: This requires locking the ledger so be careful not to use it when there's heavy traffic.", "in": "query", "name": "subscriptionBacklogSize", "required": false, "schema": { "type": "boolean", "format": "string", "default": "false" } } ], "responses": { "200": { "description": "Successfully fetched the stream statistics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_stream_stats_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get stats for the stream", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/subscriptions": { "get": { "description": "Get the list of subscriptions for a stream.", "operationId": "GetSubscriptionsList", "parameters": [ { "description": "Fabric name.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the subscriptions for a stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_stream_subs_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get stream subscriptions", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/ttl": { "get": { "description": "Fetch the Time To Live (TTL) in seconds for messages in streams.", "operationId": "GetStreamsTTL", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully fetched the message TTL for the stream", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed due to missing authentication data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get message TTL for streams", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/ttl/{ttl}": { "post": { "description": " Set the message Time To Live (TTL) in seconds for all streams.", "operationId": "SetStreamsTTL", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "TTL in seconds.", "in": "path", "name": "ttl", "required": true, "schema": { "type": "integer", "format": "string", "default": 3600 } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully set the message TTL for streams.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed due to missing authentication data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set message TTL for streams", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/clearbacklog": { "post": { "description": "Clear backlog for all streams.", "operationId": "ClearBacklog", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully cleared backlog for all streams.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed due to missing authentication data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear backlog", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/clearbacklog/{subscription}": { "post": { "description": "Clear stream backlogs for a specified subscription.", "operationId": "ClearSubscription'sBacklog", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully cleared backlog for specified subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed due to missing authentication data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear subscription's backlog", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/expiry/{seconds}": { "post": { "description": " Set the expiration time for all messages on the stream, this applies to all subscriptions.", "operationId": "ExpireMessages", "parameters": [ { "description": "Fabric name.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Expiry time in seconds.", "in": "path", "name": "seconds", "required": true, "schema": { "type": "integer", "format": "int", "default": 3600 } } ], "responses": { "200": { "description": "Successfully set the expiration time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed due to expiration of message by timestamp not issued on a topic.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Expire messages on the stream", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/subscription/{subscription}": { "delete": { "description": "Remove the specified subscription on all streams.", "operationId": "DeleteAllSubscriptions", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Whether the stream is geo-replicated globally.", "in": "query", "name": "global", "required": true, "schema": { "type": "boolean", "format": "string", "default": false } } ], "responses": { "200": { "description": "Successfully removed the specified subscription on all streams.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed due to missing authentication data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Unsubscribe", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streams/{stream}/subscriptions/{subscription}": { "delete": { "description": "Removed the specified subscription from a stream. There should not be any active consumers.", "operationId": "DeleteSubscription", "parameters": [ { "description": "Fabric name of the streams.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream (up to 240 characters). It should start with *c8locals.* or *c8globals.*.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed the specified subscription from a stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_stream_ttl_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to removing active consumer from subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Delete subscription", "tags": [ "Streams" ] } }, "/_fabric/{fabric}/_api/streamapps/validate": { "post": { "tags": [ "Stream Workers" ], "summary": "Validate the definition of a stream application.", "description": "Validate the definition of a stream application.", "operationId": "validate", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_validate_request" } } }, "description": "Stream application.", "required": true }, "responses": { "200": { "description": "Successfully validated stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_operation_success_rc_200_validate_stream_worker" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "422": { "description": "Failed to validate stream application because there is an error in the definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_422" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps": { "get": { "tags": [ "Stream Workers" ], "summary": "Fetch all stream applications.", "description": "Fetch all stream applications.", "operationId": "getAll", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched stream applications.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_response_container" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "post": { "tags": [ "Stream Workers" ], "summary": "Create and deploy a stream application.", "description": "Create and deploy a stream application.", "operationId": "create", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/stream_app_request" }, "responses": { "201": { "description": "Successfully created stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_response_container_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed becasue stream application already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "422": { "description": "Failed to create stream application because there is an error in the definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_422" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps/samples": { "get": { "tags": [ "Stream Workers" ], "summary": "Fetch all sample stream applications.", "description": "Fetch all sample stream applications.", "operationId": "getSamples", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched sample stream applications.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_sample_stream_apps_response" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps/{appname}": { "get": { "tags": [ "Stream Workers" ], "summary": "Fetch a stream application.", "description": "Fetch the specified stream application.", "operationId": "getApplication", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appname", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_stream_apps_response" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "put": { "tags": [ "Stream Workers" ], "summary": "Update and redeploy a stream application.", "description": "Update and redeploy a stream application.", "operationId": "update", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appname", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/stream_app_request" }, "responses": { "200": { "description": "Successfully updated stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_response_container" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "422": { "description": "Failed to update stream application because there is an error in the definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_422" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "delete": { "tags": [ "Stream Workers" ], "summary": "Stop and remove a stream application.", "description": "Stop and remove a stream application.", "operationId": "delete", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appname", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully removed stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_operation_success_rc_204_delete_stream_worker" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps/query/{appName}": { "post": { "tags": [ "Stream Workers" ], "summary": "Submit an ad hoc stream query and get the result", "description": "Submit an ad hoc stream query and get the resulting records from a store.", "operationId": "queryStreamApp", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_query_request" } } }, "description": "Query object.", "required": true }, "responses": { "200": { "description": "Successfully ran query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_query_response" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "422": { "description": "Failed to run query because there is an error in the stream application definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_422" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps/{appname}/active": { "patch": { "tags": [ "Stream Workers" ], "summary": "Enable or disable a stream application.", "description": "Enable or disable a stream application.", "operationId": "enableApplication", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appname", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successfully set the stream application active status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_stream_apps_response" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified stream application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/streamapps/http/{appName}/{streamName}": { "post": { "tags": [ "Stream Workers" ], "summary": "Publish message via HTTP-Source stream.", "description": "Publish message via HTTP-Source stream.", "operationId": "publishHttpSourceMessage", "parameters": [ { "name": "fabric", "in": "path", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "appName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "streamName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_http_source_request" } } }, "description": "Message.", "required": true }, "responses": { "202": { "description": "Successfully published message via HTTP-Source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publish_http_source_example_rc_202" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "HTTP-Source not found. Verify that HTTP-Source is running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/search": { "post": { "description": "Search a collection for string matches.\n\nThe specified search query is ran for the collection. If there are too many results, the cursor *id* can be used to obtain the remaining results.\n\n **Note**: This API is applicable for collections with search capability enabled. For user created views, use C8QL query to run search operation.", "operationId": "SearchView", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_view_search" } } }, "description": "Collection in which to search.", "required": true }, "responses": { "200": { "description": "Successfully fetched search results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_get_view_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Search in collection", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/collection/{collection-name}": { "post": { "description": "Enable or disable search capability of a collection. The collection is created if it does not exist. Search capability is enabled only for one field per collection.", "operationId": "SearchViewUpdate", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection-name", "required": true, "description": "Collection for which to set search capability.", "schema": { "type": "string" } }, { "in": "query", "name": "enable", "required": true, "description": "*True* enables search. *False* disables search.", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "field", "required": false, "description": "The field for which you want to enable search. Required if *enable* is set to *true*.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully set search capablitiy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_operation_success_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set Search Capability", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/view/{view-name}": { "delete": { "description": "Remove the search view identified by *view-name*.", "operationId": "deleteView", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the search view to remove.", "in": "path", "name": "view-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed search view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_operation_success_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove search view", "tags": [ "Search" ] }, "get": { "description": "Fetch information about a search view.", "operationId": "getViews:Properties", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the search view.", "in": "path", "name": "view-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched search view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search_get_view_rc_200_example" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the information about search view", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/view/{view-name}/properties": { "get": { "description": "Fetch an object containing the definition of the search view identified by *view-name*.", "operationId": "getView", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the search view.", "in": "path", "name": "view-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched search view properties.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/search_get_semantic_view_properties_rc_200_example" }, { "$ref": "#/components/schemas/search_get_view_properties_rc_200_example" } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Read properties of search view", "tags": [ "Search" ] }, "put": { "description": "Changes the properties of search view.", "operationId": "modifyViewPut", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the search view.", "in": "path", "name": "view-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/post_api_view_iresearch" }, "responses": { "201": { "description": "Successfully updated search view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_post_view_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Change properties of search view", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/view/{view-name}/rename": { "put": { "description": "Renames a search view.\n\n**Note**: This method is not available in a cluster.", "operationId": "modifyView:rename", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the search view to rename.", "in": "path", "name": "view-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rename_view" } } }, "required": true }, "responses": { "200": { "description": "Successfully renamed search view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/example_operation_success_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Rename search view", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/view": { "get": { "description": "Fetch an array of all search view descriptions.", "operationId": "getViews:AllViews", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully found search views descriptions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_get_views_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all search views.", "tags": [ "Search" ] }, "post": { "description": "Create a search view. Search view is updated with collection data changes every 10 seconds.\n\n**Note**: Search view can't be created with the links. Use PUT/PATCH for links management.", "operationId": "createView", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/post_api_view_search" }, "responses": { "201": { "description": "Successfully created search view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_post_view_http_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Successfully found existing search view with same name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create search view", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/analyzer": { "get": { "description": "Fetch an array of all anlyzer descriptions.", "operationId": "RestAnalyzerHandler:List", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched analyzer descriptions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_get_analyzers_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all analyzers", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/search/analyzer/{analyzer-name}": { "get": { "description": "Fetch the information about analyzer.", "operationId": "RestAnalyzerHandler:GetDefinition", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the analyzer to retrieve.", "in": "path", "name": "analyzer-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched analyzer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_search_get_analyzer_det_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified analyzer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Return the analyzer definition", "tags": [ "Search" ] } }, "/_fabric/{fabric}/_api/kms/managedkey": { "get": { "tags": [ "Managed Keys" ], "summary": "List of managed keys.", "description": "Fetch managed keys with filter and pagination.", "operationId": "ListOfManagedKey", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "name", "description": "The name of the manged key.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "service", "in": "query", "required": false, "description": "The type of GND service used by the key.", "schema": { "type": "string", "enum": [ "STORAGE", "SECRETS", "AUDIT" ] } }, { "name": "managedKeyType", "in": "query", "required": false, "description": "Who manages the key, Macrometa or customer(CMK)", "schema": { "type": "string", "enum": [ "MACROMETA", "CMK" ] } }, { "name": "keyProvider", "in": "query", "required": false, "description": "The service that provides the root key.", "schema": { "type": "string", "enum": [ "MACROMETA", "AWS" ] } }, { "name": "offset", "in": "query", "required": false, "description": "Number of managed keys to skip before displaying results. Default: 0", "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "description": "The number of managed keys to return. Default: 50", "schema": { "type": "integer" } }, { "name": "sortBy", "description": "Sort by field name.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Order the results ascending (ASC) or descending (DESC). Use with sortBy.", "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } } ], "responses": { "200": { "description": "Successfully fetched the list of managed keys.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_managedkeys_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "post": { "tags": [ "Managed Keys" ], "summary": "Create managed key.", "description": "Create managed key.", "operationId": "CreateManagedKey", "parameters": [ { "description": "The name of the fabric.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/create_managed_key_request" }, "responses": { "200": { "description": "Successfully created the managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_managed_key_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "422": { "description": "Failed because key policy has not been added to customer's ARN.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_422" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/kms/managedkey/{id}": { "get": { "tags": [ "Managed Keys" ], "summary": "Fetch managed key by ID.", "description": "Fetch managed key by ID.", "operationId": "FetchManagedKey", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "id", "in": "path", "required": true, "description": "The ID of the managed key.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched the managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_managedkey_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "delete": { "tags": [ "Managed Keys" ], "summary": "Delete managed key by ID.", "description": "Set the managed key to status = `DELETING` or completely delete it returning status = `DELETED` if the key doesn't have encoded data.", "operationId": "DeleteManagedKey", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "id", "in": "path", "required": true, "description": "The ID of the managed key.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched the managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_managedkey_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/kms/managedkey/{id}/enable/{enable}": { "patch": { "tags": [ "Managed Keys" ], "summary": "Enable or disable the managed key.", "description": "Enable or disable the managed key by ID.", "operationId": "EnableOrDisableManagedKey", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "id", "in": "path", "required": true, "description": "The ID of the managed key.", "schema": { "type": "string" } }, { "name": "enable", "in": "path", "required": true, "description": "Enable or disable the key.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successfully set the managed key status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_managedkey_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/kms/secret": { "get": { "tags": [ "Secrets" ], "summary": "List of secrets.", "description": "Fetch secrets with filter and pagination.", "operationId": "ListOfSecrets", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "name", "description": "The name of the secret.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keyName", "description": "Name of the secret's key.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keyId", "description": "ID of the secret's key.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Number of secrets to skip before displaying results. Default: 0", "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "description": "The number of secrets to return. Default: 50", "schema": { "type": "integer" } }, { "name": "sortBy", "description": "Sort by field name.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Order the results ascending (ASC) or descending (DESC). Use with sortBy.", "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } } ], "responses": { "200": { "description": "Successfully fetched the list of secrets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_secrets_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "post": { "tags": [ "Secrets" ], "summary": "Create secret.", "description": "It encodes sensitive data and assigns a name.", "operationId": "CreateSecret", "parameters": [ { "description": "The name of the fabric.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/create_secret_request" }, "responses": { "200": { "description": "Successfully created the secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_secret_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because a secret with this name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "delete": { "tags": [ "Secrets" ], "summary": "Delete all secrets.", "description": "Delete all secrets.", "operationId": "DeleteAllSecrets", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "all", "in": "query", "required": true, "description": "Confirm deleting all secrets.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successfully deleted all secrets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_all_secret_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/kms/secret/{name}": { "get": { "tags": [ "Secrets" ], "summary": "Fetch secret.", "description": "Fetch secret by name.", "operationId": "FetchSecret", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "name", "in": "path", "required": true, "description": "The name of the secret.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully deleted the secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_secret_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "put": { "tags": [ "Secrets" ], "summary": "Update secret.", "description": "Update secret.", "operationId": "UpdateSecret", "parameters": [ { "description": "The name of the fabric.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "default": "_system" } }, { "name": "name", "in": "path", "required": true, "description": "The name of the secret.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/update_secret_request" }, "responses": { "200": { "description": "Successfully updated the secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_secret_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "delete": { "tags": [ "Secrets" ], "summary": "Delete secret.", "description": "Delete secret by name", "operationId": "DeleteSecret", "parameters": [ { "name": "fabric", "in": "path", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "default": "_system" } }, { "name": "name", "in": "path", "required": true, "description": "The name of the secret.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully fetched the secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_secret_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed due to credentials restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "412": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_412" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/_system/_api/database": { "get": { "description": "Fetch the list of all existing GeoFabrics\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListOfGeo-fabrics", "responses": { "200": { "description": "Successfully fetched the list of GeoFabrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_GeoFabrics_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List of GeoFabrics", "tags": [ "GeoFabrics" ] }, "post": { "description": "Create a new GeoFabric.\n\n**Note**: Creating a new GeoFabric is only possible from within the *_system* fabric.", "operationId": "CreateGeo-fabric", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_database" } } }, "required": true }, "responses": { "201": { "description": "Successfully created the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_GeoFabric_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because GeoFabric already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create GeoFabric", "tags": [ "GeoFabrics" ] } }, "/_fabric/_system/_api/database/user": { "get": { "description": "Fetch a list of all GeoFabrics the current user can access along with the corresponding information for each GeoFabric.", "operationId": "ListOfAccessibleGeoFabrics", "responses": { "200": { "description": "Successfully fetched list of GeoFabrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_user_GeoFabrics_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List of accessible GeoFabrics", "tags": [ "GeoFabrics" ] } }, "/_fabric/_system/_api/database/{fabric}": { "delete": { "description": "Remove the GeoFabric along with all the data stored in it.\n\n**Note**: Requires *administrator* permissions.", "operationId": "DropGeo-fabric", "parameters": [ { "description": "The name of the GeoFabric.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dropped_GeoFabrics_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove GeoFabric", "tags": [ "GeoFabrics" ] } }, "/_fabric/{fabric}/_api/database/metadata": { "get": { "description": "Fetch information about a GeoFabric.", "operationId": "InformationOfTheGeo-fabric", "parameters": [ { "description": "The GeoFabric name for which we want the information.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched the information for the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_GeoFabric_info_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Information of the GeoFabric", "tags": [ "GeoFabrics" ] }, "put": { "description": "Set the GeoFabric Metadata.", "operationId": "SetMetadataInformationOfTheGeo-fabric", "parameters": [ { "description": "The GeoFabric name for which metadata should be set.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/database_metadata" } } }, "description": "A JSON object with user defined key-value pairs.\n\nFields:\n* metadata - json object", "required": true }, "responses": { "201": { "description": "Successfully set the GeoFabric metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_GeoFabric_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set GeoFabric metadata", "tags": [ "GeoFabrics" ] }, "patch": { "description": "Modfiy the GeoFabric metadata.", "operationId": "UpdateMetadataInformationOfTheGeo-fabric", "parameters": [ { "description": "The GeoFabric name for which metadata should be updated.", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/database_metadata" } } }, "description": "A JSON object with user defined key-value pairs.\n\nFields:\n* metadata - JSON object", "required": true }, "responses": { "201": { "description": "Successfully updated the GeoFabric metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_GeoFabric_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify GeoFabric metadata", "tags": [ "GeoFabrics" ] } }, "/_fabric/{fabric}/_api/connections": { "parameters": [ { "$ref": "#/components/parameters/Fabric" } ], "post": { "description": "Create a connection using a connector to an external data source.", "summary": "Create a connection", "tags": [ "Connections" ], "operationId": "createConnection", "requestBody": { "$ref": "#/components/requestBodies/Connection" }, "responses": { "200": { "description": "Successfully created the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "get": { "description": "Get the list of existing connections.\nTo get complete information about a connection, use [getConnection API]](#/Collections/getConnection) with the connection name.", "summary": "List all connections", "tags": [ "Connections" ], "operationId": "getConnections", "parameters": [ { "$ref": "#/components/parameters/ConnectionType" } ], "responses": { "200": { "description": "Successfully fetched the connections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/connections/validate": { "post": { "description": "Validate a connection to an external data source.", "summary": "Validate a connection", "tags": [ "Connections" ], "operationId": "validateConnection", "parameters": [ { "$ref": "#/components/parameters/Fabric" } ], "requestBody": { "$ref": "#/components/requestBodies/Connection" }, "responses": { "200": { "description": "Successfully validated the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_fabric/{fabric}/_api/connections/{connection-name}": { "parameters": [ { "$ref": "#/components/parameters/Fabric" }, { "$ref": "#/components/parameters/Connection" } ], "get": { "description": "Get information about a specific connection to an external data source.", "summary": "Get connection details", "tags": [ "Connections" ], "operationId": "getConnection", "responses": { "200": { "description": "Successfully fetched the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "delete": { "description": "Delete a connection to an external data source.", "summary": "Delete a connection", "tags": [ "Connections" ], "operationId": "deleteConnection", "parameters": [ { "name": "isInternal", "description": "Setting this parameter to `true` allows internal connections to be deleted.", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully deleted the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } }, "put": { "description": "Update a connection. Note that if the connection is already in use, then it will not be updated in the workflows.", "summary": "Update connection details", "tags": [ "Connections" ], "operationId": "updateConnection", "requestBody": { "$ref": "#/components/requestBodies/Connection" }, "responses": { "200": { "description": "Successfully updated the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/connections/metrics": { "get": { "description": "Retrieve connections metrics.", "summary": "Retrieve metrics", "tags": [ "Connections" ], "operationId": "getMetrics", "parameters": [ { "name": "start", "description": "A Unix timestamp. Use this parameter to filter metrics generated after the specified date and time. Must be used together with `end` parameter.", "in": "query", "required": true, "schema": { "type": "string" }, "example": "1689592893735" }, { "name": "end", "description": "A Unix timestamp. Use this parameter to filter metrics generated before the specified date and time. Must be used together with `start` parameter.", "in": "query", "required": true, "schema": { "type": "string" }, "example": "1689592893735" }, { "name": "step", "description": "Metric results step duration.", "in": "query", "schema": { "type": "string" }, "example": "24h" } ], "responses": { "200": { "description": "Successfully fetched the metrics for connections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/environments": { "get": { "description": "Fetch the list of all existing environments.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListEnvironments", "responses": { "200": { "description": "Successfully fetched the list of available environments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_all_environment_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List of all environments", "tags": [ "Environments" ] }, "post": { "description": "Creates a new environment.\n\n**Note**: Requires *administrator* permissions.", "operationId": "CreateEnvironment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_environment_database" } } }, "required": true }, "responses": { "201": { "description": "Successfully created new environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_environment_examples_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because environment already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create an environment", "tags": [ "Environments" ] } }, "/_api/environments/user": { "get": { "description": "Fetch a list of all _environments_ the current user can access along with the corresponding information for each environment.", "operationId": "ListOfAccessibleEnvironments", "responses": { "200": { "description": "Successfully fetched the list of _environments_", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_user_environments_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all environments", "tags": [ "Environments" ] } }, "/_api/environments/{environment}": { "delete": { "description": "Remove the environment with all the data stored in it.\n\n**Note**: Requires *administrator* permissions.", "operationId": "DropEnvironment", "parameters": [ { "description": "The name of the environment.", "in": "path", "name": "environment", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully removed the environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dropped_environment_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove an environment", "tags": [ "Environments" ] } }, "/_api/environments/{environment}/metadata": { "get": { "description": "Fetch information about an environment.", "operationId": "InformationOfTheEnvironment", "parameters": [ { "description": "The Database name for which we want the information.", "in": "path", "name": "environment", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched the information for the environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_environment_info_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Information about the environment", "tags": [ "Environments" ] }, "put": { "description": "Set the metadata for an environment.", "operationId": "SetMetadataInformationOfTheEnvironment", "parameters": [ { "description": "The environment name for which metadata should be set.", "in": "path", "name": "environment", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/database_metadata" }, "responses": { "201": { "description": "Successfully set the environment metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/set_environment_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the environment metadata", "tags": [ "Environments" ] }, "patch": { "description": "Update the environment metadata.", "operationId": "UpdateMetadataInformationOfTheEnvironment", "parameters": [ { "description": "Environment name.", "in": "path", "name": "environment", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/database_metadata" }, "responses": { "201": { "description": "Successfully updated the environment metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_environment_example_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify the environment metadata", "tags": [ "Environments" ] } }, "/_api/version": { "get": { "description": "Fetch the server name and version number.", "operationId": "RestVersionHandler", "responses": { "200": { "description": "Successfully fetched server name and version number.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_api_return_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Return server version", "tags": [ "Users" ] } }, "/_api/user": { "post": { "description": "Create a new user.\n\n**Note**: Requires *administrator* permissions.", "operationId": "CreateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_create" } } }, "required": true }, "responses": { "201": { "description": "Successfully created user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "user": { "description": "The id of the user.", "type": "string", "example": "Ugr0xjYMS9y0eN5gBxSSmg" }, "active": { "description": "Account status", "type": "boolean", "example": true }, "email": { "description": "The email of the user for whom we want the auth token.", "type": "string", "example": "joe@foo.com" }, "extra": { "description": "A JSON object with extra data about the user.", "type": "object", "example": {} }, "tenant": { "description": "The name of the tenant for whose user we want the auth token.", "type": "string", "example": "foo" }, "displayName": { "description": "The name of the user for whom we want the auth token.", "type": "string", "example": "joe" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because user already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create User", "tags": [ "Users" ] } }, "/_api/user/": { "get": { "description": "Fetch data about all users.", "operationId": "ListAvailableUsers", "responses": { "200": { "description": "Successfully fetched all users.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "tenant": { "description": "The name of the tenant.", "type": "string", "example": "_mm" }, "user": { "description": "The id of the user.", "type": "string", "example": "Ugr0xjYMS9y0eN5gBxSSmg" }, "displayName": { "description": "The username of the tenant.", "type": "string", "example": "test1" }, "email": { "description": "The email of the user.", "type": "string", "example": "test@foo.com" }, "active": { "description": "(Optional) If set to *true*, the user is active.", "type": "boolean", "default": true }, "apikey": { "description": "Hash of API key.", "type": "object", "properties": { "hash": { "description": "Hash of API key.", "type": "string", "example": "1467ad2eed8e823f5a5db74aacd716d2f87dc3dde2bced8799e3c07dcf1c88ee" }, "parent": { "description": "Hash of API key.", "type": "string", "example": "" } } } } } } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List available Users", "tags": [ "Users" ] } }, "/_api/user/{user}": { "delete": { "description": "Remove an existing user.\n\n**Note**: Requires *administrator* permissions.", "operationId": "RemoveUser", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove User", "tags": [ "Users" ] }, "get": { "description": "Fetch data about the specified user.\n\n**Note**: Requires *administrator* permissions to access other users data.", "operationId": "FetchUser", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_200_0" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch User", "tags": [ "Users" ] }, "patch": { "description": "Update the data of an existing user.\n\n**Note**: Requires *administrator* permissions if changing the email address.", "operationId": "ModifyUser", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_modify" } } }, "required": true }, "responses": { "200": { "description": "Successfully modified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_key_http_examples_rc_200_0" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify User.", "tags": [ "Users" ] } }, "/_api/user/{user}/database": { "get": { "description": "Fetch the list of GeoFabrics available.\n\nThe *result* object contains the GeoFabric names as object keys and the associated privileges for the GeoFabric as values.\n\nIn case *full* is specified, the result contains the permissions for the GeoFabric as well as the permissions for the collections and streams.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListTheAccessibleDatabasesForAUser", "parameters": [ { "description": "The id of the user for which you want to query the databases.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Return the full set of access levels for all GeoFabrics and all collections.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched list of GeoFabrics.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": { "test": "rw" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List the GeoFabrics available to user.", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}": { "get": { "description": "Fetch the access level for a specific GeoFabric.", "operationId": "GetTheDatabaseAccessLevel", "parameters": [ { "description": "The id of the user for which you want to query the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched GeoFabric access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "rw" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the GeoFabric access level.", "tags": [ "Users" ] }, "delete": { "description": "Clear the access level for the GeoFabric *geoname* of user *user*. As consequence the default GeoFabric access level is used. If there is no defined default GeoFabric access level, it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearTheDatabaseAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "202": { "description": "Successfully cleared GeoFabric access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the GeoFabric access level", "tags": [ "Users" ] }, "put": { "description": "Set the access levels for the GeoFabric *geoname* of user *user*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheDatabaseAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully set GeoFabric access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "testgeo": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the GeoFabric access level", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/collection": { "get": { "description": "Fetch the list of collections access level for a specific *user*\n\n If access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set GeoFabric access level is used.", "operationId": "GetTheAllCollectionAccessLevel", "parameters": [ { "description": "The id of the user for which you want to query the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all collections.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched collections access level.", "content": { "application/json": { "schema": { "example": { "error": false, "code": 200, "result": { "testCollection": "rw" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the collections access level for specific user", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/collection/{collection}": { "get": { "description": "Fetch the collection access level for a specific collection\n\n If access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set GeoFabric access level is used.", "operationId": "GetTheSpecificCollectionAccessLevel", "parameters": [ { "description": "The id of the user for which you want to query the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched collection access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "rw" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific collection access level", "tags": [ "Users" ] }, "delete": { "description": "Clear the collection access level for the collection *collection* in the GeoFabric *geofabric* of user *user*. As consequence the default collection access level is used. If there is no defined default collection access level, it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearTheCollectionAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared collection access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the collection access level.", "tags": [ "Users" ] }, "put": { "description": "Set the collection access level for the *collection* in the GeoFabric *geoname* for user *user*.\n\nIf access level for collection is not set default(\"*\") access level is used. If default(\"*\") access level is also not set GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheCollectionAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the collection.", "in": "path", "name": "collection", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_collection" }, "responses": { "200": { "description": "Successfully changed access permissions.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "_system/testCollection": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the collection access level", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/stream": { "get": { "description": "Fetch the list of streams available to the specified *user*.\n\nThe *result* object contains the stream names as object keys, and the associated privileges for the stream as values.\n\nIf access level for stream is not set default(\"*\") access level is used. If default(\"*\") access level is also not set GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListTheAccessibleStreamsForAUser", "parameters": [ { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The id of the user for which you want to query the streams.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Return the full set of access levels for all streams. If set to *false*, return the read-only streams.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched stream access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "rw" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List the accessible streams", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/stream/{stream}": { "get": { "description": "Fetch the stream access level for a specific stream.", "operationId": "GetTheStreamAccessLevel", "parameters": [ { "description": "The id of the user for which you want to query the streams.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream to query.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched the stream access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the stream access level", "tags": [ "Users" ] }, "delete": { "description": "Clear the stream access level for the *stream* of user *user*. As consequence the default stream access level is used. If there is no defined default stream access level, it defaults to *No access*.", "operationId": "ClearTheStreamAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared the stream access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the stream access level.", "tags": [ "Users" ] }, "put": { "description": "Set the stream access levels for the *stream* of API key with *keyid*.\n\nIf access level for stream is not set the default(\"*\") access level is used. If default(\"*\") access level is also not set the GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheStreamAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the database.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the stream.", "in": "path", "name": "stream", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully set stream access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "c8globals.testStream": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user or collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the stream access level", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/restql": { "get": { "description": "Fetch the list of query worker access level for a specific *user*\n\n If access level for query worker is not set, then default(\"*\") access level is used. If default(\"*\") access level is also not set, then GeoFabric access level is used.", "operationId": "GetTheAllQueryWorkerAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all query workers.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched query workers access level.", "content": { "application/json": { "schema": { "example": { "error": false, "code": 200, "result": { "testQueryWorker": "rw" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user, or query worker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the query workers access level for a specific user", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/restql/{query-worker}": { "get": { "description": "Fetch the access level for a specific query worker\n\n If access level for query worker is not set, then default(\"*\") access level is used. If default(\"*\") access level is also not set, then GeoFabric access level is used.", "operationId": "GetTheSpecificQueryWorkerAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched query worker access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "rw" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user, or query worker.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific query worker access level", "tags": [ "Users" ] }, "delete": { "description": "Clear the access level for the query worker *query worker* in the GeoFabric *geofabric* of user *user*. After this runs, the default query worker access level is used. If there is no defined default query worker access level, it defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearTheQueryWorkerAccessLevel", "parameters": [ { "description": "The ID of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared query worker access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user, or query worker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the query worker access level.", "tags": [ "Users" ] }, "put": { "description": "Set the access level for the *query worker* in the GeoFabric *geofabric* for user *user*.\n\nIf access level for query worker is not set, then default(\"*\") access level is used. If default(\"*\") access level is also not set, then GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheQueryWorkerAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the query worker.", "in": "path", "name": "query-worker", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_queryworker" }, "responses": { "200": { "description": "Successfully changed access permissions.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "_system/testQueryWorker": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric, user, or query worker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the query worker access level", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/managedkey": { "get": { "description": "Fetch the list of managed keys access level for a specific *user*.\n\n If the access level for a managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetAllManagedKeyAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "Return the full set of access levels for all managed keys.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully fetched managed keys access level.", "content": { "application/json": { "schema": { "example": { "error": false, "code": 200, "result": { "testManagedKey": "rw" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, user, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the managed keys access level for a specific user", "tags": [ "Users" ] } }, "/_api/user/{user}/database/{geofabric}/managedkey/{managed-key-name}": { "get": { "description": "Fetch the access level for a specific managed key.\n\n If the access level for the managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.", "operationId": "GetSpecificManagedKeyAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric to query.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched managed key access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": "rw" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, user, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the specific managed key access level", "tags": [ "Users" ] }, "delete": { "description": "Clear the access level for the *managed key name* in the GeoFabric *geofabric* of user *user*. After the access level is removed, the default managed key access level is used. If there is no defined default managed key access level, then the access level defaults to *No access*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ClearManagedKeyAccessLevel", "parameters": [ { "description": "The ID of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared managed key access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, user, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the managed key access level", "tags": [ "Users" ] }, "put": { "description": "Set the access level for the *managed key* in the GeoFabric *geofabric* for user *user*.\n\nIf the access level for the managed key is not set, then the default(\"*\") access level is used. If the default(\"*\") access level is also not set, then the GeoFabric access level is used.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetManagedKeyAccessLevel", "parameters": [ { "description": "The ID of the user querying the GeoFabric.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the GeoFabric.", "in": "path", "name": "geofabric", "required": true, "schema": { "type": "string", "format": "string", "default": "_system" } }, { "description": "The name of the managed key.", "in": "path", "name": "managed-key-name", "required": true, "schema": { "type": "string", "format": "string", "default": "*" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_managedkey" }, "responses": { "200": { "description": "Successfully changed access permissions.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "_system/testManagedKey": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified GeoFabric, user, or managed key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the managed key access level", "tags": [ "Users" ] } }, "/_api/user/{user}/billing": { "get": { "description": "Fetch the billing access level.", "operationId": "GetTheBillingAccessLevel", "parameters": [ { "description": "The id of the user for which you want to query the billing.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched billing access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "result": { "billing": "rw" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the billing access level", "tags": [ "Users" ] }, "delete": { "description": "Clear the billing access level of user *user*.", "operationId": "ClearTheBillingAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully cleared the billing access level.", "content": { "application/json": { "schema": { "example": { "code": 202, "error": false } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Clear the billing access level", "tags": [ "Users" ] }, "put": { "description": "Set the billing access levels for user *user*.\n\n**Note**: Requires *administrator* permissions.", "operationId": "SetTheBillingAccessLevel", "parameters": [ { "description": "The id of the user.", "in": "path", "name": "user", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/user_grant_database" }, "responses": { "200": { "description": "Successfully set billing access level.", "content": { "application/json": { "schema": { "example": { "code": 200, "error": false, "billing": "ro" } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the billing access level.", "tags": [ "Users" ] } }, "/_api/user/{user}/attributes": { "get": { "description": "Fetch the list of attributes for the specified user.", "operationId": "GetTheAttributesForUser", "parameters": [ { "in": "path", "name": "user", "required": true, "description": "The id of the user.", "schema": { "type": "string", "format": "string", "default": "user" } } ], "responses": { "200": { "description": "Successfully fetched attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http_examples_rc_200_attributes" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the user attributes", "tags": [ "Users" ] }, "put": { "description": "Update the attributes for the user.\n\n**Note**: Requires *administrator* permissions.", "operationId": "CreateTheAttributesForUser", "parameters": [ { "in": "path", "name": "user", "required": true, "description": "The id of the user.", "schema": { "type": "string", "format": "string", "default": "user" } } ], "requestBody": { "$ref": "#/components/requestBodies/attribute_values" }, "responses": { "200": { "description": "Successfully changed attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http_examples_rc_200_attributes" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update attributes", "tags": [ "Users" ] } }, "/_api/user/{user}/attributes/truncate": { "delete": { "description": "Remove all user's attribute.", "operationId": "ClearAllAttributesForUser", "parameters": [ { "in": "path", "name": "user", "required": true, "description": "The id of the user.", "schema": { "type": "string", "format": "string", "default": "user" } } ], "responses": { "202": { "description": "Successfully removed attributes.", "content": { "application/json": { "schema": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false } }, "required": [ "error" ], "type": "object" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove all attributes", "tags": [ "Users" ] } }, "/_api/user/{user}/attributes/{attributeid}": { "delete": { "description": "Remove a user's attribute.", "operationId": "ClearTheAttributesForUser", "parameters": [ { "in": "path", "name": "user", "required": true, "description": "The id of the user.", "schema": { "type": "string", "format": "string", "default": "user" } }, { "in": "path", "name": "attributeid", "required": true, "description": "Attribute id.", "schema": { "type": "string", "format": "string", "default": "attributeid" } } ], "responses": { "202": { "description": "Successfully removed attribute.", "content": { "application/json": { "schema": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false } }, "required": [ "error" ], "type": "object" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove attribute", "tags": [ "Users" ] } }, "/_api/billing/account": { "get": { "description": "Get account details (plan, contact and payment settings) for given tenant.\n\n **Note**: this API is not applicable for system tenants.", "operationId": "GetBillingAccount", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched account details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Account_Get" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get account details", "tags": [ "Billing" ] } }, "/_api/billing/contact": { "put": { "description": "Update contact details for given tenant name.\n\n**Note**:\n- This API is not applicable for system tenants.\n- Updates the Stripe account.", "operationId": "UpdateContactDetails", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact_Update" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated contact details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed becasue billing plan already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update contact details", "tags": [ "Billing" ] } }, "/_api/billing/payments": { "get": { "description": "Fetch all payments details of the tenant for specified number of previous months.\n\n**Note**: This API is not applicable for system tenants.", "operationId": "GetPayments", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } }, { "description": "Number of previous months for which payment details are required.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "integer", "default": 10 } } ], "responses": { "200": { "description": "Successfully fetched payment details.\n\nExample - https://stripe.com/docs/api/payment_intents/list\n\n**Note**: the example here is an excerpt please follow the link above for a complete example.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stripe_200_intent_list" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get payment details of the previous months for the given tenant.", "tags": [ "Billing" ] } }, "/_api/billing/invoices": { "get": { "description": "Fetch all invoice details of the tenant for specified number of previous months.\n\n**Note**: this API is not applicable for system tenants.", "operationId": "GetBillingInvoices", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } }, { "description": "Number of previous months for which invoices are required.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "integer", "default": 3 } } ], "responses": { "200": { "description": "Successfully fetched invoice details.\n\nExample - https://stripe.com/docs/api/invoices/list\n\n**Note**: the example here is an excerpt please follow the link above for a complete example.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stripe_200_invoice_list" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get invoices for the previous months", "tags": [ "Billing" ] } }, "/_api/billing/invoice/current": { "get": { "description": "Fetch invoice of the tenant for the current month.\n\n**Note**: this API is not applicable for system tenants.", "operationId": "GetCurrentMonthInvoice", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched invoice details.\n\nExample - https://stripe.com/docs/api/invoices/upcoming\n\n**Note**: the example here is an excerpt please follow the link above for a complete example.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stripe_200_invoice_upcoming" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get invoice of the current month for the given tenant.", "tags": [ "Billing" ] } }, "/_api/billing/invoices/{year}/{month}": { "get": { "description": "Fetch invoices for a tenant, in a specific month and year.\n\n**Note**: This API is not applicable for system tenants.", "operationId": "GetInvoiceForMonthYear", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } }, { "description": "Year in 'YYYY' format.", "in": "path", "name": "year", "required": true, "schema": { "type": "integer", "format": "integer" } }, { "description": "Month. Valid values:[1..12]", "in": "path", "name": "month", "required": true, "schema": { "type": "integer", "format": "integer" } } ], "responses": { "200": { "description": "Successfully fetched invoice details.\n\nExample - https://stripe.com/docs/api/invoices/retrieve\n\n**Note**: the example here is an excerpt please follow the link above for a complete example.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stripe_200_invoice_month_year" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get invoice of specific year and month for the tenant", "tags": [ "Billing" ] } }, "/_api/billing/usage": { "get": { "description": "Fetch usage of a tenant in a specific date range. If no query parameters are specified, usage from start date of the month to current date is returned.\n\n**Note**: This API is not applicable for system tenants.", "operationId": "GetAccountUsage", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } }, { "description": "Start date in 'YYYY-MM-DD' format.", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string", "format": "string" } }, { "description": "End date in 'YYYY-MM-DD' format.", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched usage of tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Usage_Get" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get usage of the tenant", "tags": [ "Billing" ] } }, "/_api/billing/region/{region}/usage": { "get": { "description": "Fetch usage of a tenant in specific date range for a specific region. If no query parameters are specified, usage from start date of the month to current date is returned.\n\n**Note**: This API is not applicable for system tenants.", "operationId": "GetAccountUsageOfSpecificRegion", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } }, { "description": "Name of the region.", "in": "path", "name": "region", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "Start date in 'YYYY-MM-DD' format.", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string", "format": "string" } }, { "description": "End date in 'YYYY-MM-DD' format.", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched usage of tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Usage_Get" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get usage of the tenant for specific region", "tags": [ "Billing" ] } }, "/_fabric/{fabric}/_api/export": { "post": { "description": "Run the **query** and return list of result documents. **Query** cannot contain the following keywords: **INSERT**, **UPDATE**, **REPLACE**, **REMOVE** and **UPSERT**.", "operationId": "ExportQueryData", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_export" } } }, "required": true }, "responses": { "200": { "description": "Successfully exported data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Export data", "tags": [ "Import Export" ] } }, "/_fabric/{fabric}/_api/export/{collection}": { "get": { "description": "Fetch a list of documents in the specified collection. If offset, limit and order are not specified their default values are applied.", "operationId": "ExportCollectionData", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the collection.", "schema": { "type": "string", "format": "string" } }, { "description": "This option can be used to simulate paging.", "in": "query", "name": "offset", "required": false, "schema": { "type": "string", "default": 0 } }, { "description": "This option can be used to simulate paging. Limit the result. **Maximum: 1000**.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "minimum": 1, "maximum": 1000, "default": 20 } }, { "description": "Order the results asc or desc.", "in": "query", "name": "order", "required": false, "schema": { "type": "string", "default": "asc" } } ], "responses": { "200": { "description": "Successfully fetched list of documents.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Export collection data", "tags": [ "Import Export" ] } }, "/_fabric/{fabric}/_api/import/{collection}": { "post": { "description": "Create documents in the collection identified by collection parameter.", "operationId": "ImportCollectionData", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection", "required": true, "description": "The name of the collection.", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_import" } } }, "required": true }, "responses": { "200": { "description": "Successfully imported data.\n\nIf there are any errors, an additional header *X-C8-Error-Codes* is set, that contains a map of the error codes that occurred together with their multiplicities, as in: 1205:10,1210:17 which means that in 10 cases the error 1205 \"illegal document handle\" and in 17 cases the error 1210 \"unique constraint violated\" has happened. The response body has additional failed document details in *details* object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import_http_examples_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to validate because you do not have access to the GeoFabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Import collection data", "tags": [ "Import Export" ] } }, "/datacenter/all": { "get": { "description": "Fetch data about all the data centers.", "operationId": "ReturnListOfAllEdgeLocations", "responses": { "200": { "description": "Successfully fetched data centers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_datacenter_response_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Lists all data centers", "tags": [ "Data Centers" ] } }, "/datacenter/local": { "get": { "description": "Fetch data for a local/regional the data center.", "operationId": "ListDetailsOfLocalEdgeLocation", "responses": { "200": { "description": "Successfully fetched data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_regional_datacenter_response_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get a regional data center", "tags": [ "Data Centers" ] } }, "/datacenter/{dc-name}": { "get": { "description": "Fetch data for data center, identified by *dc-name*.", "operationId": "ListDetailsOfSpecifiedEdgeLocation", "parameters": [ { "description": "The name of the data center.", "in": "path", "name": "dc-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/datacenter_get_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get data center", "tags": [ "Data Centers" ] } }, "/datacenter/{location}/{status}": { "put": { "description": "Changes the properties of a data center.", "operationId": "ChangeSpotCapabilityOfAnEdgeLocation", "parameters": [ { "description": "The name of the data center.", "in": "path", "name": "location", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The on-spot capability of the data center.", "in": "path", "name": "status", "required": true, "schema": { "type": "boolean", "format": "boolean" } } ], "responses": { "200": { "description": "Successfully changed data center on-spot capability.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set data center spot capability", "tags": [ "Data Centers" ] } }, "/datacenter/_tenant/{tenant-name}": { "get": { "description": "Fetch data for all data centers for tenant identified by *tenant-name*.", "operationId": "ListEdgeLocation(akaDatacenter)DetailsForSpecifiedTenant", "parameters": [ { "description": "The name of the tenant", "in": "path", "name": "tenant-name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/datacenter_get_rc_200_array" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all available data centers.", "tags": [ "Data Centers" ] } }, "/_api/members": { "get": { "description": "Fetch data for all the clusters in the federation.", "operationId": "ListOfFederationMembers", "responses": { "200": { "description": "Successfully fetched clusters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/datacenter_members_get_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List all clusters", "tags": [ "Data Centers" ] }, "post": { "description": "Update the clusters in federation.", "operationId": "JoinFederationOfClusters", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/federation_member_peerip" } } }, "description": "A JSON Object with properties.", "required": true }, "responses": { "202": { "description": "Successfully updated clusters in federation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/datacenter_members_post_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update clusters in federation", "tags": [ "Data Centers" ] } }, "/_api/members/{member}": { "delete": { "description": "Remove the cluster from federation, identified by *member*.", "operationId": "DeleteMemberFromFederation", "parameters": [ { "description": "The name of the cluster.", "in": "path", "name": "member", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed cluster from federation.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove a cluster from federation", "tags": [ "Data Centers" ] } }, "/_api/tenants": { "get": { "description": "Fetch a list of tenants in the system.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ReturnListOfTenants", "responses": { "200": { "description": "Successfully fetched tenants.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_tenants_get_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch list of tenants", "tags": [ "Administration" ] } }, "/_api/tenant": { "post": { "description": "Create a new tenant.\n\n**Note**: Requires *administrator* permissions.", "operationId": "CreateTenant(requiresSuperuserPrivileges)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_create" } } }, "required": true }, "responses": { "201": { "description": "Successfully created tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_tenant_create_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed because tenant already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create Tenant", "tags": [ "Administration" ] } }, "/_api/tenant/{tenant}": { "delete": { "description": "Remove the tenant. The system tenant _mm account cannot remove.\n\n**Note**: Requires *administrator* permissions.", "operationId": "RemoveTenant(requiresSuperuserPrivileges)", "parameters": [ { "description": "The tenant name to remove. The main default system tenant *_mm* cannot remove.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_tenant_delete_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove Tenant", "tags": [ "Administration" ] }, "get": { "description": "Fetch information about the tenant.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ListDetailsOfTenant", "parameters": [ { "description": "The tenant name for whom we want to fetch info.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_tenant_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List details of the tenant", "tags": [ "Administration" ] }, "patch": { "description": "Update a tenant.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ModifyTenant", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_modify" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_modify_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify Tenant", "tags": [ "Administration" ] } }, "/_api/plan": { "get": { "description": "Fetch a list of billing plans.\n\n**Note**: Requires *administrator* permissions.", "operationId": "GetListOfPlans", "responses": { "201": { "description": "Successfully fetched billing plans.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_plan_list_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch list of billing plans", "tags": [ "Administration" ] }, "post": { "description": "Create a new billing plan.\n\n**Note**: Requires *administrator* permissions.", "operationId": "CreatePlan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_create" } } }, "required": true }, "responses": { "201": { "description": "Successfully created billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_201_billing" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "409": { "description": "Failed becasue billing plan already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_409" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create billing plan", "tags": [ "Administration" ] } }, "/_api/plan/{name}": { "get": { "description": "Fetch information about a billing plan.", "operationId": "ListDetailsOfPlan", "parameters": [ { "description": "The billing plan name for which we want to fetch info.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched details of the billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_201_billing" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "List details of the billing plan", "tags": [ "Administration" ] }, "patch": { "description": "Update the billing plan.", "operationId": "ModifyPlan", "parameters": [ { "description": "The name of the billing plan to modify.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_modify" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated billing plan data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_modify" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Modify billing plan", "tags": [ "Administration" ] }, "delete": { "description": "Remove an existing billing plan.", "operationId": "RemovePlan", "parameters": [ { "description": "The billing plan name to remove.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "202": { "description": "Successfully removed billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_201_billing" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove billing plan", "tags": [ "Administration" ] } }, "/_api/plan/update": { "post": { "description": "Update the billing plan for a tenant.\n\n**Note**: If tenant name is not specified, the tenant invoking the API is used to update billing plan.", "operationId": "UpdateTenantPlan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_tenant_plan" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_update_plan_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update tenant billing plan", "tags": [ "Administration" ] } }, "/_api/billing/paymentsettings": { "put": { "description": "Update payment settings for given tenant.\n\n **Note**: This API is not applicable for system tenants `_mm` and `demo`.", "operationId": "UpdatePaymentSettings", "parameters": [ { "description": "Tenant name. *If not set it uses the tenant invoking the request.*", "in": "header", "name": "tenant", "schema": { "type": "string", "format": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment_Update" } } }, "required": true }, "responses": { "200": { "description": "Successfully updated payment settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Billing_Code_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update payment settings", "tags": [ "Administration" ] } }, "/_api/limits/defaults": { "get": { "description": "Fetch the default limits for tenants.", "operationId": "GetDefaultTenantLimits", "responses": { "200": { "description": "Successfully fetched billing plan limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch the default limits for tenants", "tags": [ "Administration" ] }, "put": { "description": "Set the default tenant limits.\n\n **Note**: If data fields are omitted, they are set to GDN default values. The GDN limits can be retrieved via the `GET /_api/tenant/{tenant}` API.", "operationId": "SetDefaultTenantLimits", "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value" }, "responses": { "200": { "description": "Successfully updated the default tenant limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the default tenant limits", "tags": [ "Administration" ] }, "patch": { "description": "Update default tenant limits.\n\n **Note**: Omitted data fields keep their current value.", "operationId": "UpdateDefaultTenantLimits", "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value" }, "responses": { "200": { "description": "Successfully updated the default tenant limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update default tenant limits", "tags": [ "Administration" ] }, "delete": { "description": "Reset default tenant limits.", "operationId": "ResetDefaultTenantLimits", "responses": { "200": { "description": "Successfully reset default tenant limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Reset default tenant limits", "tags": [ "Administration" ] } }, "/_api/limits/defaults/{service}": { "get": { "description": "Fetch the default service limits for tenants.\n\n This API supports these services: `[apiServer, cep, database, eventHub, streamsGlobal, streamsLocal, and dataMeshIntegration]`.", "operationId": "GetServiceDefaultLimits", "parameters": [ { "description": "The name of the service.", "in": "path", "name": "service", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched service.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/streams_limits_example" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch the default limits for tenants", "tags": [ "Administration" ] } }, "/_api/limits/enable": { "get": { "description": "Fetch weather limits are configured for all tenants.\n\n **Note**: If set to *false* the limits are not enforced", "operationId": "GetEnableLimits", "responses": { "200": { "description": "Successfully fetched whether limits are configured.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Return the value of enable limits flag. *True* if its enabled, else *false*", "type": "object", "example": { "value": true } } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get limits configured", "tags": [ "Administration" ] }, "post": { "description": "Enable configuration of limits for all tenants. If set to *false* the limits are not enforced.", "operationId": "SetEnableLimits", "parameters": [ { "description": "The flag indication whether limits are enabled for all tenants. The default value is *true*. If set to *false*, the configured limits are not applicable.", "in": "query", "name": "value", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully enabled limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/set_enable_limits_flag" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set limits configured", "tags": [ "Administration" ] } }, "/_api/limits/tenant/{tenant}": { "get": { "description": "Fetch the limits for a tenant.", "operationId": "GetTenantLimits", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched tenant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Fetch the limits for a tenant", "tags": [ "Administration" ] }, "put": { "description": "Set the tenant limits.\n\n**Note**: If data fields are omitted, they are set to GDN default values. The GDN limits can be retrieved via the `GET /_api/tenant/{tenant}` API.", "operationId": "SetTenantLimits", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value" }, "responses": { "200": { "description": "Successfully updated the tenant limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the tenant limits", "tags": [ "Administration" ] }, "patch": { "description": "Update tenant limits.\n\n **Note**: Omitted data fields keep their current value.", "operationId": "UpdateTenantLimits", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value" }, "responses": { "200": { "description": "Successfully updated the tenant limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update tenant limit", "tags": [ "Administration" ] }, "delete": { "description": "Reset tenant limits.", "operationId": "ResetTenantLimits", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully reset limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Reset tenant limits", "tags": [ "Administration" ] } }, "/_api/limits/tenant/{tenant}/{service}": { "get": { "description": "Fetch the limit for a tenant.\n\n This API supports these services: `[apiServer, cep, database, eventHub, streamsGlobal, streamsLocal, and dataMeshIntegration]`", "operationId": "GetTenantServiceLimits", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the service.", "in": "path", "name": "service", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched tenant service limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/streams_limits_example" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the limits for a tenant service", "tags": [ "Administration" ] } }, "/_api/limits/plan/{attribution}/{name}": { "get": { "description": "Fetch the limits for a billing plan.", "operationId": "GetPlanLimits", "parameters": [ { "description": "The attribution of the billing plan.", "in": "path", "name": "attribution", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the billing plan.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched specified billing plan limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/tenant_limits_value" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the limits for a billing plan", "tags": [ "Administration" ] }, "put": { "description": "Set the billing plan limits.\n\n **Note**: If data fields are omitted, they are set to GDN defined default values.", "operationId": "SetPlanLimits", "parameters": [ { "description": "The attribution of the billing plan.", "in": "path", "name": "attribution", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the billing plan.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value2" }, "responses": { "200": { "description": "Successfully updated billing plan limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the billing plan limits were set successfully.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set the billing plan limits", "tags": [ "Administration" ] }, "patch": { "description": "Update billing plan limits.\n\n **Note**: Omitted data fields keep their current value.", "operationId": "UpdatePlanLimits", "parameters": [ { "description": "The attribution of the billing plan.", "in": "path", "name": "attribution", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the billing plan.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/tenant_limits_value2" }, "responses": { "200": { "description": "Successfully updated the billing plan limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the billing plan limits were updated successfully.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update billing plan limits", "tags": [ "Administration" ] }, "delete": { "description": "Reset specified billing plan limits.", "operationId": "ResetPlanLimits", "parameters": [ { "description": "The attribution of the billing plan.", "in": "path", "name": "attribution", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the billing plan.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully reset billing plan limits.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the billing plan limits were reset successfully.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Reset billing plan limits", "tags": [ "Administration" ] } }, "/_api/limits/plan/{attribution}/{name}/{service}": { "get": { "description": "Fetch the service limits for a billing plan.\n\n This API supports these services: `[apiServer, cep, database, eventHub, streamsGlobal, streamsLocal, and dataMeshIntegration]`", "operationId": "GetPlanServiceLimits", "parameters": [ { "description": "The attribution of the billing plan.", "in": "path", "name": "attribution", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the billing plan.", "in": "path", "name": "name", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The name of the service.", "in": "path", "name": "service", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched service.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/streams_limits_example" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified billing plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the service limits for a billing plan", "tags": [ "Administration" ] } }, "/_api/features/tenant/{tenant}": { "delete": { "description": "Reset features for a tenant to default values.", "operationId": "ResetFeaturesForATenant", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully reset features for a tenent.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if successfully reset features.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Reset features for a tenant", "tags": [ "Administration" ] }, "get": { "description": "Fetch features for a tenant.", "operationId": "LookupFeaturesForATenant", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched features.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/features_list_with_availability_flag_example" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get features for a tenant", "tags": [ "Administration" ] }, "post": { "description": "Set the features for a tenant.", "operationId": "UpdateFeaturesForATenant", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/features_list_with_availability_flag_example" }, "responses": { "200": { "description": "Successfully sets features.", "content": { "application/json": { "schema": { "description": "*True* if successfully sets features", "type": "boolean", "example": "true" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set features for a tenant", "tags": [ "Administration" ] }, "put": { "description": "Update the features for a tenant.", "operationId": "UpdateFeaturesForSpecifiedTenant", "parameters": [ { "description": "The name of the tenant.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/features_list_with_availability_flag_example" }, "responses": { "200": { "description": "Successfully updated features.", "content": { "application/json": { "schema": { "description": "*True* if successfully updated features", "type": "boolean", "example": "true" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Update features for a tenant", "tags": [ "Administration" ] } }, "/_api/tenant/{tenant}/datacenter/{datacenter}": { "post": { "description": "Add data center to a tenant.\n\n**Note**:\n- While the new data center is being added to the tenant, the new data center is not available for normal operations until all tenant data is synced to it.\n- Requires *administrator* permissions", "operationId": "AddDatacentersToTenant(superuser)", "parameters": [ { "description": "The tenant to which the data center is added. You cannot add the system tenants `_mm` and `demo` to a data center.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } }, { "in": "path", "name": "datacenter", "description": "Data center that needs to add to the tenant.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "description": "Force syncing fabric data.", "required": false, "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "copyLocalCollections", "description": "Copy local collections data.", "required": false, "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "remoteDc", "description": "Name of remote data center to sync fabric data from.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "excludeCollections", "description": "Collections to exclude from syncing (comma-separated).", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "fabric", "description": "Fabric to which the data center needs to add.", "required": false, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully added data center to tenant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if successfully added data center to tenant.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Add data center to the tenant", "tags": [ "Administration" ] }, "delete": { "description": "Remove data center from a tenant.\n\n**Note**: Requires *administrator* permissions.", "operationId": "RemoveTenantDatacenter(superuser)", "parameters": [ { "description": "The tenant to modify. You cannot modify the system tenants `_mm` and `demo`.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The data center to remove.", "in": "path", "name": "datacenter", "required": true, "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "fabric", "description": "Fabric from which the data center needs to remove.", "required": false, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully removed data center from tenant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if successfully removed data center from tenant.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove data center from the tenant.", "tags": [ "Administration" ] }, "put": { "description": "Reconcile data center of a tenant.\n\n**Note**: Requires *administrator* permissions.", "operationId": "ReconcileTenantDatacenter(superuser)", "parameters": [ { "description": "The tenant to reconcile. You cannot modify the system tenants `_mm` and `demo`.", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string", "format": "string" } }, { "description": "The data center on which to perform reconciling.", "in": "path", "name": "datacenter", "required": true, "schema": { "type": "string", "format": "string" } }, { "in": "query", "name": "force", "description": "Force syncing fabric data.", "required": false, "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "remoteDc", "description": "Name of remote data center to sync fabric data from (leave empty to use default).", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "excludeCollections", "description": "Collections to exclude from syncing (comma-separated).", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "fabric", "description": "Fabric that needs to reconcile.", "required": false, "schema": { "type": "string", "default": "_system" } }, { "in": "query", "name": "resume", "description": "*True* if sync resumes from last point of failure. *False* if sync starts from the beginning and removes all data replicated from previous sync.", "required": false, "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "cleanup", "description": "If true, all collections, views and stream are removed from local data center which are not available on remoteDc.", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully reconcile data center.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if successfully reconcile data center.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Reconcile tenant from given data center", "tags": [ "Administration" ] } }, "/_api/tenant/{tenant}/datacenter/status": { "get": { "description": "Fetch the current sync status.\n\n**Note**: Requires *administrator* permissions.", "operationId": "GetSyncStatus(superuser)", "parameters": [ { "in": "path", "name": "tenant", "description": "Name of the tenant.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fabric", "description": "Name of the fabric.", "required": false, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetch fabric sync status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fabric_sync_get_status_example" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get the current sync status of a tenant or fabric", "tags": [ "Administration" ] } }, "/_api/tenant/datacenter/{datacenter}/syncall": { "post": { "description": "Add data center to all fabrics from all tenants.\n\n**Note**:\n- Synchronize all *tenants* from remote regions, including all *GeoFabrics* created for each tenant.\n- While the new data center is being added to the all fabrics, the new data center is not available for normal operations until after the synchronization is finished.\n- Requires *administrator* permissions.", "operationId": "AddDatacentersToAllTenant(superuser)", "parameters": [ { "in": "path", "name": "datacenter", "description": "Data center that needs to add to the tenant.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "remoteDc", "description": "Name of remote data center to sync fabric data from (leave empty to use default).", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "command", "description": "The command which decides the mode of sync operation. The allowed values are: \n - region_add(To sync the newly added region.)\n - region_add_copy_local(Add region and copy local collections data)\n - catchup_start(Start sync in catchup mode.)\n - catchup_pause(Pause the sync in catchup mode.)\n - catchup_resume(Resume the sync in catchup mode.)\n - catchup_kill(Stop the sync in catchup mode.) ", "required": false, "schema": { "type": "string", "default": "region_add" } }, { "in": "query", "name": "skip", "description": "If *true* automatically exclude tenants and fabrics which are not added to all dc except the one passed in data center parameter.", "required": false, "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "excludeTenants", "description": "Tenants to exclude from syncing (comma-separated).", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "force", "description": "Force restart the sync call.", "required": false, "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "priority", "description": "Priority for the catchup mode sync.", "required": false, "schema": { "type": "string", "default": "-20" } } ], "responses": { "200": { "description": "Successfully added data center to all fabrics form all tenants.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if successfully added data center to all febrics from all tenant.", "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified data center.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Add data center to all fabrics from all tenants", "tags": [ "Administration" ] } }, "/_api/tenant/{tenant}/fabric/{fabric}/publish-local-collections": { "put": { "description": "Enable publishing changes to local collections.\n\n**Note**: Requires *administrator* permissions.", "operationId": "EnableLocalCollectionsUpdatesPublishing(superuser)", "parameters": [ { "in": "path", "name": "tenant", "description": "Tenant.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "fabric", "description": "Fabric.", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully enabled publishing changes to local collections.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Enable publishing changes to local collections", "tags": [ "Administration" ] }, "delete": { "description": "Disable publishing changes to local collections.\n\n**Note**: Requires *administrator* permissions.", "operationId": "DisableLocalCollectionsUpdatesPublishing(superuser)", "parameters": [ { "in": "path", "name": "tenant", "description": "Tenant.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "fabric", "description": "Fabric.", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully disabled publishing changes to local collection.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Disable publishing changes to local collections", "tags": [ "Administration" ] } }, "/_api/tenant/{tenant}/fabric/{fabric}/accept-local-collections-updates": { "put": { "description": "Enable accepting updates to local collections.\n\n**Note**: Requires *administrator* permissions.", "operationId": "EnableAcceptingLocalCollectionsUpdates(superuser)", "parameters": [ { "in": "path", "name": "tenant", "description": "Tenant.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "fabric", "description": "Fabric.", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully enabled accepting updates to local collection.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Enable accepting updates to local collections", "tags": [ "Administration" ] }, "delete": { "description": "Disable accepting updates to local collections.\n\n**Note**: Requires *administrator* permissions.", "operationId": "DisableAcceptingLocalCollectionsUpdates(superuser)", "parameters": [ { "in": "path", "name": "tenant", "description": "Tenant.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "fabric", "description": "Fabric.", "required": true, "schema": { "type": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully disabled accepting updates to local collection.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Disable accepting updates to local collections", "tags": [ "Administration" ] } }, "/_fabric/{fabric}/_api/collection/{collection-name}/compact": { "put": { "description": "Compacts the data of a collection in order to reclaim disk space.\n The operation compacts the document and index data by rewriting the data while keeping the relevant entries.\nUnder normal circumstances running a compact operation is not necessary, as the collection data eventually gets compacted anyway. However, in some situations, e.g. after running many update or remove operations, the data for a collection may contain a lot of outdated data for which the space shall be reclaimed. In this case, the compaction operation can be used.", "operationId": "handleCommandPut:compactCollection", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } }, { "in": "path", "name": "collection-name", "required": true, "description": "The name of the collection.", "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully compacted the collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_collection_put_collection_compact_http_example_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Compact Collection", "tags": [ "Administration" ] } }, "/_fabric/{fabric}/_api/events": { "delete": { "description": "Remove one or more events by _id.", "operationId": "DeleteEvent", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": [ "_events/2885469" ] } } }, "description": "A JSON array of strings (event _ids).", "required": true }, "responses": { "201": { "description": "Successfully removed events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_get_event_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Remove event", "tags": [ "Administration" ] }, "post": { "description": "Create an event.", "operationId": "CreateEvent", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_create" } } }, "required": true }, "responses": { "201": { "description": "Successfully created event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_create_event_rc_201" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create event", "tags": [ "Administration" ] }, "get": { "description": "Fetch events for a given fabric.", "operationId": "LookupEventsForATenantAndFabric", "parameters": [ { "description": "The fabric name to use in the URL path for this API call. The main default system database is _system", "in": "path", "name": "fabric", "required": true, "schema": { "type": "string", "format": "string" } } ], "responses": { "200": { "description": "Successfully fetched events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_get_events_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Lookup events for a tenant and fabric", "tags": [ "Administration" ] } }, "/_fabric/{fabric}/_api/metrics/names": { "get": { "description": "Fetch an array of all metrics names.", "operationId": "names", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "responses": { "200": { "description": "Successfully fetched metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_api_get_metrics_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Get metrics names", "tags": [ "Administration" ] } }, "/_fabric/{fabric}/_api/metrics/query": { "post": { "description": "Query user metrics.", "operationId": "query", "parameters": [ { "in": "path", "name": "fabric", "required": true, "description": "The name of the fabric.", "schema": { "type": "string", "format": "string", "default": "_system" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_metrics_query" } } }, "required": true }, "responses": { "200": { "description": "Sucessfully fetched metrics details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/administration_api_query_metrics_rc_200" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified fabric.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Query user metrics", "tags": [ "Administration" ] } }, "/_api/repair/all": { "post": { "responses": { "200": { "description": "Successfully repaired.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "default": "*True* if successfully repaired", "type": "boolean", "example": "true" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "tags": [ "Administration" ], "description": "Fixes streams settings for all tenants and fabrics.", "operationId": "FixesC8StreamsSettingsForAll", "summary": "Fixes streams settings for all tenants and fabrics" } }, "/_api/repair/tenant/{tenant}": { "post": { "parameters": [ { "in": "path", "name": "tenant", "required": true, "description": "The name of the tenant.", "schema": { "type": "string", "format": "string", "default": "_mm" } } ], "responses": { "200": { "description": "Successfully repaired.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "default": "*True* if successfully repaired", "type": "boolean", "example": "true" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "tags": [ "Administration" ], "description": "Fixes streams settings for all fabrics of a specific tenant.", "operationId": "FixesC8StreamsSettingsForTenant", "summary": "Fixes streams settings for a specific tenant and its fabrics" } }, "/_api/repair/check": { "post": { "description": "Returns an array of all metrics names.", "operationId": "repairCheckCollections", "requestBody": { "$ref": "#/components/requestBodies/repairCheckCollectionsJsonRequestBody" }, "responses": { "200": { "description": "Returned when operation is successful", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Check if regions are in sync", "tags": [ "Administration" ] } }, "/_api/repair/sync": { "post": { "requestBody": { "$ref": "#/components/requestBodies/repairCheckCollectionsJsonRequestBody" }, "responses": { "200": { "description": "Returned if the call succeeded.", "content": { "application/json": { "schema": { "type": "object" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "tags": [ "Administration" ], "description": "Provides a way to synchronize global collections across remote regions using RICE data", "operationId": "repairSyncCollections", "summary": "Synchronize global collections that are experiencing data discrepancies between regions" } }, "/_api/repair/sync/priority/{priority}": { "post": { "description": "Set sync priority.", "operationId": "SyncPriority", "parameters": [ { "description": "Priority of sync operation.", "in": "path", "name": "priority", "required": true, "schema": { "type": "integer", "format": "integer", "default": "-20" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Returned if the sync operation is not running.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Set sync priority", "tags": [ "Administration" ] } }, "/_api/repair/sync/cancel": { "post": { "description": "Cancel sync operation if it is already running.", "operationId": "CancelSync", "responses": { "200": { "description": "Success.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Returned if the sync operation is not running.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "405": { "description": "Failed due to unsupported HTTP method.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Cancel sync operation", "tags": [ "Administration" ] } }, "/_api/trigger/zendesk": { "post": { "description": "Create a new support ticket.", "operationId": "zendeskAPI", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_zendesk_api" } } }, "required": true }, "responses": { "201": { "description": "Successfully created a support ticket.", "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/support_trigger_zendesk_post_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Create a support ticket", "tags": [ "Support" ] } }, "/_api/_admin/_billing/usage/hourly": { "post": { "description": "Generates hourly usage data for all tenants. Requires administrator permissions.", "operationId": "GenerateHourlyBillingUsage(superuser)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_hourly_usage_create" } } }, "required": true }, "responses": { "200": { "description": "Successfully generated hourly usage data for billing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. _False_ for this response.", "type": "boolean", "example": false }, "message": { "description": "_OK_ if successfully generated daily usage data for billing. An error description is displayed if there is an error..", "type": "string", "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Generates hourly usage data.", "tags": [ "Administration" ] } }, "/_api/_admin/_billing/usage/daily": { "post": { "description": "Generates daily usage data for tenants. Requires administrator permissions.", "operationId": "GenerateDailyUsage(superuser)", "requestBody": { "$ref": "#/components/requestBodies/billing_usage_create" }, "responses": { "200": { "description": "Successfully generated daily usage data for billing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. _False_ for this response.", "type": "boolean", "example": false }, "message": { "description": "_OK_ if successfully generated daily usage data for billing. An error description is displayed if there is an error.", "type": "string", "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Generates daily usage data for billing.", "tags": [ "Administration" ] } }, "/_api/_admin/_billing/usage/federation": { "post": { "description": "Generates aggregated usage data for tenants. Requires administrator permissions.", "operationId": "GenerateFederationUsage(superuser)", "requestBody": { "$ref": "#/components/requestBodies/billing_usage_create" }, "responses": { "200": { "description": "Successfully generated aggregated usage data for billing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. _False_ for this response.", "type": "boolean", "example": false }, "message": { "description": "_OK*_ if successfully generated aggregated usage data for billing. An error description is displayed if an error occurs.", "type": "string", "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Generates aggregated usage data for billing.", "tags": [ "Administration" ] } }, "/_api/_admin/_billing/usage/report": { "post": { "description": "Upload usage data to Stripe for billing invoice. Requires administrator permissions.", "operationId": "ReportUsageToStripe(superuser)", "requestBody": { "$ref": "#/components/requestBodies/billing_usage_create" }, "responses": { "200": { "description": "Upload usage data to stripe for billing invoice.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. _False_ for this response.", "type": "boolean", "example": false }, "message": { "description": "_OK_ if successfully generated aggregated usage data for billing. An error description is displayed if an error occurs.", "type": "string", "example": "OK" } } } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_429" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Upload usage data to Stripe for billing invoice.", "tags": [ "Administration" ] } }, "/_api/_admin/_billing/usage/missing": { "get": { "description": "Returns the list of missing usage record between start and end date. List contains records from daily and federation usage. Requires administrator permissions.", "operationId": "CheckBillingUsage(superuser)", "requestBody": { "$ref": "#/components/requestBodies/billing_usage_create" }, "responses": { "200": { "description": "Returns the list of missing usage records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_missing_usage_record_get" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Returns the list of missing usage records of tenants.", "tags": [ "Administration" ] } }, "/_api/_admin/_billing/usage/missing/generate": { "post": { "description": "Generate missing usage records from daily and federation usage between start and end date. Requires administrator permissions.", "operationId": "GenerateMissingBillingUsage(superuser)", "requestBody": { "$ref": "#/components/requestBodies/billing_usage_create" }, "responses": { "200": { "description": "Returns the list of generated records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_missing_usage_record_get" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed because you do not have administrator permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "403": { "description": "Failed to validate because you do not have access to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_403" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } }, "summary": "Generate missing usage records.", "tags": [ "Administration" ] } }, "/_api/connectors": { "get": { "description": "Get available connectors.", "summary": "Get available connectors", "tags": [ "Connections" ], "operationId": "getConnectors", "responses": { "200": { "description": "Successfully fetched the connector list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorEntitiesResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/connectors/{connector-name}": { "get": { "description": "Obtain comprehensive information about the connector,\nincluding the configuration details necessary for setting up an connection using this connector.", "summary": "Get connector details", "tags": [ "Connections" ], "operationId": "getConnector", "parameters": [ { "$ref": "#/components/parameters/Connector" }, { "name": "type", "in": "query", "required": false, "description": "Specifies which type of connector to retrieve, \nNo value returns both source and target connectors.", "schema": { "type": "string", "enum": [ "source", "target" ] } } ], "responses": { "200": { "description": "Succesfully fetched the connector.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorEntityResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connector.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/connectors/{connector-name}/sample": { "post": { "description": "Retrieve sample data from the data source by supplying the connector configuration.\nThe response includes both the schema and sample data.", "summary": "Retrieve sample data from the data source", "tags": [ "Connections" ], "operationId": "retrieveSample", "requestBody": { "description": "Connector configuration.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorSampleRequest" } } } }, "parameters": [ { "$ref": "#/components/parameters/Connector" } ], "responses": { "200": { "description": "Successfully retrieved the connnector sample.", "content": { "application/json": { "schema": { "title": "ConnectorSampleResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSample" } } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connector.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/connectors/{connector-name}/schema": { "post": { "description": "Retrieve schema for the connector by supplying the connector configurations.", "summary": "Retrieve schema from the data source", "tags": [ "Connections" ], "operationId": "retrieveSchema", "requestBody": { "description": "Connector configuration.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorSampleRequest" } } } }, "parameters": [ { "$ref": "#/components/parameters/Connector" } ], "responses": { "200": { "description": "Successfully retrieved connector schema.", "content": { "application/json": { "schema": { "title": "ConnectorSchemaResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSchema" } } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "404": { "description": "Failed to find the connector.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_404" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/transformations/sample": { "post": { "description": "Generate a sample transformation query based on the schema of the specific data source.\nThis API serves as the initial step in creating a data transformation process.\nUse this API's generated sample transformation query to construct your transformation logic.", "summary": "Generate a transformation query sample", "tags": [ "Connections" ], "operationId": "getSampleTransformation", "requestBody": { "description": "Schema of the data source.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorSchema" } } } }, "responses": { "200": { "description": "Successfully fetched the sample transformation query.", "content": { "application/json": { "schema": { "title": "SampleTransformationResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "properties": { "query": { "description": "Transformation query.", "type": "string" }, "inputSchema": { "$ref": "#/components/schemas/ConnectorSchema" } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/transformations/validate": { "post": { "description": "Validate the provided transformation query and the parameters.", "summary": "Validate transformation", "tags": [ "Connections" ], "operationId": "validateTransformation", "requestBody": { "description": "Details of transformation to validate.", "required": true, "content": { "application/json": { "schema": { "type": "object", "title": "TransformationValidationRequest", "properties": { "collection": { "description": "Name of the GDN collection.", "type": "string" }, "type": { "description": "Connection type (source or target).", "type": "string" }, "query": { "description": "Transformation query.", "type": "string" }, "inputSchema": { "description": "Schema of the input data to the transformation.", "$ref": "#/components/schemas/ConnectorSchema" } } } } } }, "responses": { "200": { "description": "Successfully validated the transformation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransformationValidationResponse" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } }, "/_api/transformations/preview": { "post": { "description": "Generate a preview of the data after the transformation. The preview is generated based on a sample data set from the data source.\nYou can use [get connector sample API](#/Connections/retrieveSample) to retrieve a sample dataset from the data source.", "summary": "Generate transformed data preview", "tags": [ "Connections" ], "operationId": "previewTransformation", "requestBody": { "description": "Parameters required to generate a transformation preview.", "required": true, "content": { "application/json": { "schema": { "type": "object", "title": "TransformationPreviewRequest", "properties": { "query": { "description": "Transformation query.", "type": "string" }, "inputSchema": { "$ref": "#/components/schemas/ConnectorSchema" }, "outputSchema": { "$ref": "#/components/schemas/ConnectorSchema" }, "data": { "description": "Sample dataset from the data source.", "type": "array", "items": { "type": "object" } } } } } } }, "responses": { "200": { "description": "Successfully generated the transformation preview.", "content": { "application/json": { "schema": { "title": "TransformationPreviewResponse", "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "properties": { "result": { "$ref": "#/components/schemas/ConnectorSample" } } } ] } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "400": { "description": "Failed due to missing or malformed data. Verify that all parameters are complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_400" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } }, "401": { "description": "Failed to authenticate the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_example_rc_401" } } }, "headers": { "x-gdn-region": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-region" } }, "x-gdn-requestid": { "schema": { "$ref": "#/components/schemas/headers/x-gdn-requestid" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Provide an API Key to the `Authorization` header, prefixed with \"apikey\".\n\nExample: `Authorization: apikey `" }, "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Provide a JSON Web Token (JWT) to the `Authorization` header, prefixed with \"bearer\".\n\nExample: `Authorization: bearer `" } }, "requestBodies": { "billing_usage_create": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_usage_create" } } }, "required": true }, "user_grant_collection": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_grant_collection" } } }, "required": true }, "tenant_limits_value": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_limits_value" } } }, "description": "The new default values.", "required": true }, "user_grant_database": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_grant_database" } } }, "required": true }, "user_grant_queryworker": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_grant_queryworker" } } }, "required": true }, "user_grant_managedkey": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_grant_managedkey" } } }, "required": true }, "attribute_values": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attribute_values" } } }, "required": true }, "stream_app_request": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stream_app_request" } } }, "description": "Stream application.", "required": true }, "create_managed_key_request": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_managed_key_request" } } }, "description": "JSON for a new managed key.", "required": true }, "create_secret_request": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_secret_request" } } }, "description": "JSON for a new secret.", "required": true }, "update_secret_request": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_secret_request" } } }, "description": "JSON for updating a secret.", "required": true }, "post_api_view_iresearch": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_view_iresearch" } } }, "required": true }, "post_api_view_search": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/post_api_view_semantic" }, { "$ref": "#/components/schemas/post_api_view_iresearch" } ] } } }, "required": true }, "database_metadata": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/database_metadata" } } }, "description": "A JSON object with user defined key-value pairs.", "required": true }, "tenant_limits_value2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_limits_value" } } }, "description": "The new default values with billing plan information", "required": true }, "features_list_with_availability_flag_example": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/features_list_with_availability_flag_example" } } }, "description": "The features to update (each value must be either *true* or *false*).", "required": true }, "repairCheckCollectionsJsonRequestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "collection" ], "properties": { "tenant": { "type": "string", "example": "_mm", "description": "The name of the tenant." }, "fabric": { "type": "string", "example": "_system", "description": "The name of the fabric." }, "collection": { "type": "string", "example": "[]", "description": "The names of the collection." } } } } }, "description": "Collection in which to search.", "required": true }, "Connection": { "description": "Connection definition.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } } }, "schemas": { "headers": { "x-gdn-region": { "description": "The federation's region hostname that served the request.", "type": "string" }, "x-gdn-requestid": { "description": "A unique request ID for each API request.", "type": "string" } }, "document_get_412": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 412 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorNum": { "example": 1200 }, "errorMessage": { "example": "precondition failed" }, "_id": { "example": "xxx/8753101" }, "_key": { "example": "8753101" }, "_rev": { "example": "_dpDlw6W--_" } } }, "import_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "properties": { "created": { "description": "Number of records created.", "type": "integer", "example": 3 }, "errors": { "description": "Number of records with errors.", "type": "integer", "example": 0 }, "unprocessed": { "description": "Number of records not processed.", "type": "integer", "example": 0 } } } } }, "query_workers_get_restql_user_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/examples_id_key_rev_data" } } } }, "query_workers_post_restql_execute_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "hasMore": { "type": "boolean", "example": true }, "id": { "type": "integer", "example": 11894969 }, "cached": { "type": "boolean", "example": false }, "extra": { "type": "object", "properties": { "stats": { "type": "array", "example": [], "items": {} }, "warnings": { "type": "array", "example": [], "items": {} } } }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/examples_id_key_rev_data" } } } }, "query_workers_post_restql_execute_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "hasMore": { "type": "boolean", "example": true }, "id": { "type": "integer", "example": 11894969 }, "cached": { "type": "boolean", "example": false }, "extra": { "type": "object", "properties": { "warnings": { "type": "array", "example": [], "items": {} } } }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/examples_id_key_rev_data" } } } }, "query_workers_post_restql_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "properties": { "userid": { "description": "The userid", "type": "string", "example": "testuser" }, "tenant": { "description": "The tenant", "type": "string", "example": "_mm" }, "fabric": { "description": "The fabric", "type": "string", "example": "_system" }, "name": { "description": "Query name", "type": "string", "example": "testQueryName" }, "value": { "description": "The query being saved", "type": "string", "example": "for u in testCollection return u" }, "_key": { "description": "The key for this record", "type": "string", "example": "testuser._system.testQueryName" }, "type": { "description": "Record Type", "type": "string", "example": "c8ql" } } } } }, "example_id_key_rev": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" } }, "type": "object" }, "example_old_id_key_rev": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_zPad4Hxd--_" } }, "type": "object" }, "example_operation_success_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Return *true* flag if operation is successfully completed.", "type": "boolean", "example": true } } }, "example_operation_success_rc_204_delete_stream_worker": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 204 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Successfully removed stream application" } } }, "example_operation_success_rc_200_validate_stream_worker": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Successfully validated stream application" } } }, "redirect_example_rc_304": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 304 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 102020 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_400": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 400 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 102020 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_401": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 401 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": "102020" } }, "required": [ "error" ], "type": "object" }, "error_example_rc_403": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 403 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_404": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 404 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_409": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 409 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_412": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 412 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_429": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 429 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Error number returned from the database.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "error_example_rc_422": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 422 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" } }, "required": [ "error" ], "type": "object" }, "export_http_examples_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "1634556" }, "name": { "type": "string", "example": "test1" } } } } } }, "api_key_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of API keys with details as keyid, user name and tenant name.", "items": { "$ref": "#/components/schemas/apikey200_help" }, "type": "array" } }, "required": [ "error" ], "type": "object" }, "apikey200_help": { "properties": { "keyid": { "description": "Keyid of the API key.", "type": "string", "example": "test1" }, "user": { "description": "Name of the user.", "type": "string", "example": "root" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "_mm" }, "isSystem": { "description": "Indicates whether the key is a system API key.", "type": "boolean", "example": "false" } } }, "api_key_dbname_collection_put_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "_system/test1": { "type": "string", "example": "rw" } } }, "api_key_dbname_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "string", "example": "rw" } } }, "api_key_put_dbname_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "string", "example": "rw" } }, "required": [ "error" ], "type": "object" }, "api_key_database_collection_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "List of collections and the access level.", "type": "object", "properties": { "test1": { "type": "string", "example": "rw" } } } }, "required": [ "error" ], "type": "object" }, "api_key_database_stream_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "properties": { "c8locals.streamTest": { "type": "string", "example": "rw" } } } }, "required": [ "error" ], "type": "object" }, "api_key_database_queryworker_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in the response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Lists query workers and the permissions assigned to that API key for each query worker.", "type": "object", "properties": { "test1": { "type": "string", "example": "rw" } } } }, "required": [ "error" ], "type": "object" }, "api_key_database_managedkey_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in the response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Lists managed keys and the permissions assigned to that API key for each managed key.", "type": "object", "properties": { "test1": { "type": "string", "example": "rw" } } } }, "required": [ "error" ], "type": "object" }, "api_key_http_examples_rc_200_billing": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Billing tag with billing access level present.", "properties": { "billing": { "type": "string", "example": "rw" } } } }, "required": [ "error" ], "type": "object" }, "http_examples_rc_200_attributes": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/attribute_values" } } }, "http_examples_rc_201_attributes": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "attributes": { "$ref": "#/components/schemas/attribute_values" } }, "required": [ "error" ], "type": "object" }, "attribute_values": { "properties": { "key1": { "description": "Attribute key-value.", "format": "string", "type": "string", "example": "value1" }, "key2": { "description": "Attribute key-value.", "format": "string", "type": "string", "example": "value2" } } }, "api_key_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "key": { "description": "The generated key.", "type": "string", "example": "test1.KqEsCra56Nr6qiBvDhIUr7Fiey9gxUHCdg8dLuY75rOSAQtMUdeh6Hf851kd6atM3ccf69" }, "keyid": { "description": "keyid of the key.", "type": "string", "example": "test1" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "_mm" }, "user": { "description": "Name of the user.", "type": "string", "example": "root" } }, "required": [ "error" ], "type": "object" }, "api_key_http_examples_rc_200_0": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False*for this response.", "type": "boolean", "example": false }, "tenant": { "description": "The name of the tenant.", "type": "string", "example": "_mm" }, "user": { "description": "The id of the user.", "type": "string", "example": "Ugr0xjYMS9y0eN5gBxSSmg" }, "displayName": { "description": "The username of the tenant.", "type": "string", "example": "test1" }, "email": { "description": "The email of this API key.", "type": "string", "example": "test@foo.com" }, "active": { "description": "Active status the API key.", "type": "boolean", "example": true }, "apikey": { "description": "Hash of API key.", "type": "object", "properties": { "hash": { "description": "Hash of API key.", "type": "string", "example": "1467ad2eed8e823f5a5db74aacd716d2f87dc3dde2bced8799e3c07dcf1c88ee" }, "parent": { "description": "Hash of API key.", "type": "string", "example": "root" } } }, "extra": { "description": "A JSON object with extra user information.", "type": "object", "example": {} } } }, "api_key_get_response_http_examples_rc_200_0": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "user": { "description": "The ID of the API key.", "type": "string", "example": "Ugr0xjYMS9y0eN5gBxSSmg" }, "displayName": { "description": "The username of the API key.", "type": "string", "example": "test1" }, "active": { "description": "Active status the API key.", "type": "boolean", "example": true }, "apikey": { "description": "API key and its parent.", "type": "object", "properties": { "key": { "description": "API key", "type": "string", "example": "tenant1_domain.com.test1.6umGXOk34BZDVVGraow0r7CaSy5XOXitaWPvquoX3Dilcyq8upF7RRKGGdPPpiDR741f65" }, "parent": { "description": "Parent of API key.", "type": "string", "example": "root" }, "isSystem": { "description": "Indicates whether the key is a system API key.", "type": "boolean", "example": "false" } } } } }, "api_key_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "items": { "properties": { "_system": { "description": "Access level of system is described.", "type": "string", "example": "rw" } } } } }, "required": [ "error" ], "type": "object" }, "api_key_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false } }, "required": [ "error" ], "type": "object" }, "authentication_examples_rc_200": { "properties": { "jwt": { "description": "JWT authentication token.", "type": "string", "example": "IsInR5cCI6IkpXVCJ9.pvaG4gRG9lIiwiaWF0IjoyfQ.SflKxwRJSMeV_adQssw5c" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "foo" }, "username": { "description": "Username of the tenant.", "type": "string", "example": "joe" } }, "type": "object" }, "kv_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "name": { "description": "It shows name of the collection.", "type": "string", "example": "testCollection" }, "count": { "description": "It gives kv count.", "type": "integer", "example": 5 } }, "required": [ "error" ], "type": "object" }, "kv_collection_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "name": { "description": "It shows name of the collection.", "type": "string", "example": "testCollection" } }, "required": [ "error" ], "type": "object" }, "kv_key_examples_rc_200": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" }, "expireAt": { "description": "Expiration details of collection.n", "type": "integer", "example": 1638291600 }, "value": { "description": "Value of the collection.", "type": "string", "example": "bar" } }, "type": "object" }, "examples_id_key_rev": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" } }, "type": "object" }, "examples_id_key_rev_array": { "type": "array", "items": { "$ref": "#/components/schemas/examples_id_key_rev" } }, "examples_id_key_rev_data": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" }, "data": { "description": "data in record.", "type": "string", "example": "data1" } }, "type": "object" }, "examples_id_key_rev_oldrev": { "properties": { "_id": { "description": "ID of the collection.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of collection.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of collection.", "type": "string", "example": "_dPRuHxe--_" }, "_oldRev": { "description": "previous revision of collection.", "type": "string", "example": "_dP34awxe--_" } }, "type": "object" }, "kv_get_values_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": "false" }, "result": { "description": "An array of key-value pairs from collection. If no keys are found and empty array is returned.", "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "foo" }, "value": { "type": "string", "example": "bar" }, "expireAt": { "type": "number", "example": 1637859600 } } } } }, "required": [ "error" ], "type": "object" }, "plan_201_billing": { "type": "object", "properties": { "active": { "description": "Active status of the billing plan.", "type": "boolean", "example": true }, "attribution": { "description": "Attribution name of the billing plan.", "type": "string", "example": null }, "demo": { "description": "Flag about demo status of the billing plan.", "type": "boolean", "example": true }, "description": { "description": "Information of the billing plan.", "type": "string", "example": "Information of the plan" }, "featureGates": { "description": "List of featureGates associated with billing plan.", "type": "array", "items": { "type": "string", "example": "KV" } }, "isBundle": { "type": "boolean", "example": false }, "label": { "description": "Label of the billing plan.", "type": "string", "example": "Free" }, "metadata": { "description": "Metadata about the billing plan.", "type": "object", "properties": {}, "example": { "key": "value" } }, "metrics": { "description": "Metric values displayed along with name.", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "kv-reads" }, "value": { "type": "string", "example": "c8db_service_kv_read_requests_count" }, "metricType": { "type": "string", "example": "counter" } } }, "type": "array" }, "name": { "description": "Name of the billing plan.", "type": "string", "example": "enterprise" }, "planID": { "description": "ID associated with the billing plan.", "type": "string", "example": "aa2da2sd3s2ed3ssd3sd" }, "pricing": { "description": "Pricing details of the billing plan.", "type": "string", "example": "Custom pricing" } } }, "api_plan_list_rc_200": { "type": "array", "description": "Array of billing plans details.", "items": { "$ref": "#/components/schemas/plan_201_billing" } }, "datacenter_rc_200_array": { "items": { "properties": { "tenant": { "description": "Tenant name", "type": "string" }, "dcInfo": { "type": "array", "items": { "$ref": "#/components/schemas/datacenter_rc_200" } } } }, "type": "array" }, "datacenter_rc_200": { "properties": { "_id": { "description": "ID of the data center.", "type": "string" }, "_key": { "description": "_key associated with data center.", "type": "string" }, "_rev": { "description": "_rev value of the data center.", "type": "string" }, "host": { "description": "Data center cluster IP.", "type": "string" }, "local": { "description": "Flag about data center is local or not.", "type": "boolean" }, "name": { "description": "Name of the data center.", "type": "string" }, "spot_region": { "type": "boolean" }, "status": { "type": "integer" }, "tags": { "description": "Tag values associated with data center such as URL.", "properties": { "api": { "type": "string" }, "role": { "type": "string" }, "url": { "type": "string" } } }, "locationInfo": { "description": "Complete information about the location of data center.", "properties": { "_id": { "type": "string" }, "_key": { "type": "string" }, "_rev": { "type": "string" }, "city": { "type": "string" }, "countrycode": { "type": "string" }, "countryname": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } } } } }, "datacenter_get_rc_200_array": { "items": { "properties": { "tenant": { "description": "Tenant name", "type": "string", "example": "_mm" }, "dcInfo": { "type": "array", "items": { "properties": { "_id": { "description": "ID of the data center.", "type": "string", "example": "_clusters/gdn-us-west" }, "_key": { "description": "key associated with data center.", "type": "string", "example": "gdn-us-west" }, "_rev": { "description": "_rev value of the data center.", "type": "string", "example": "_c9VHcYC--_" }, "host": { "description": "Data center cluster IP.", "type": "string", "example": "192.168.1.100" }, "local": { "description": " If *true*, the data center is a regional data center for the request else *false*.", "type": "boolean", "example": true }, "name": { "description": "Name of the data center.", "type": "string", "example": "gdn-us-west" }, "spot_region": { "description": "If true, the data center is on-spot capable.", "type": "boolean", "example": false }, "status": { "description": " If *0*, the data center is online else data center is having connectivity problem.", "type": "integer", "example": 0 }, "tags": { "$ref": "#/components/schemas/datacenter_response_tags" }, "locationInfo": { "description": "Complete information about the location of data center.", "properties": { "_id": { "description": "ID of the location info.", "type": "string", "example": "_members/gdn-us-west" }, "_key": { "description": "key for the location info.", "type": "string", "example": "gdn-us-west" }, "_rev": { "description": "The document revision.", "type": "string", "example": "_c9VHcYC--_" }, "city": { "description": "The city of the data center.", "type": "string", "example": "San Jose" }, "countrycode": { "description": "The country code of the data center.", "type": "string", "example": "US" }, "countryname": { "description": "The country name of the data center", "type": "string", "example": "United States" }, "latitude": { "description": "The latitude of the data center.", "type": "string", "example": 37.3388 }, "longitude": { "description": "The latitude of the data center", "type": "string", "example": -121.8916 }, "host": { "description": "Data center cluster IP.", "type": "string", "example": "92.236.111.184" }, "status": { "description": " If *0*, the data center is online else data center is having connectivity problem.", "type": "integer", "example": 0 }, "url": { "description": "URL for the data center.", "type": "string", "example": "gdn-us-west.paas.macrometa.io" } } } } } } } }, "type": "array" }, "datacenter_get_rc_200": { "properties": { "name": { "description": "Name of the data center.", "type": "string", "example": "gdn-us-west" }, "local": { "description": "If *true*, the data center is a regional data center for the request else *false*.", "type": "boolean", "example": true }, "status": { "description": "If *0*, the data center is online else data center is having connectivity problem.", "type": "integer", "example": 0 }, "tags": { "$ref": "#/components/schemas/datacenter_response_tags" }, "locationInfo": { "$ref": "#/components/schemas/datacenter_response_location_info" } } }, "datacenter_members_post_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "example": true } } }, "datacenter_members_get_rc_200": { "type": "array", "items": { "properties": { "_key": { "description": "key for the data center.", "type": "string", "example": "gdn-us-west" }, "host": { "description": "IP address of the data center.", "type": "string", "example": "192.168.1.100" }, "status": { "description": "If *0*, the data center is online else data center is having connectivity problem.", "type": "integer", "example": 0 }, "city": { "description": "The city of the data center.", "type": "string", "example": "San Jose" }, "countrycode": { "description": "The Country code of the data center.", "type": "string", "example": "US" }, "countryname": { "description": "The Country Name of the data center.", "type": "string", "example": "United States" }, "latitude": { "description": "The latitude of the data center.", "type": "string", "example": 37.3388 }, "longitude": { "description": "The longitude of the data center.", "type": "string", "example": -121.8916 }, "url": { "description": "URL for the data center.", "type": "string", "example": "gdn-us-west.paas.macrometa.io" } } } }, "get_datacenter_response_200": { "type": "array", "items": { "$ref": "#/components/schemas/datacenter_response_fields" } }, "get_regional_datacenter_response_200": { "$ref": "#/components/schemas/datacenter_response_fields" }, "datacenter_response_tags": { "description": "Tag values associated with data center.", "properties": { "api": { "description": "API URL for the data center.", "type": "string", "example": "api-gdn-us-west.paas.macrometa.io" }, "url": { "description": "URL for the data center", "type": "string", "example": "gdn-us-west.paas.macrometa.io" } } }, "datacenter_response_location_info": { "description": "Complete information about the location of data center.", "properties": { "city": { "description": "The city of the data center.", "type": "string", "example": "San Jose" }, "countrycode": { "description": "The country code of the data center.", "type": "string", "example": "US" }, "countryname": { "description": "The country name of the data center", "type": "string", "example": "United States" }, "latitude": { "description": "The latitude of the data center.", "type": "string", "example": 37.3388 }, "longitude": { "description": "The latitude of the data center", "type": "string", "example": -121.8916 }, "url": { "description": "URL for the data center.", "type": "string", "example": "gdn-us-west.paas.macrometa.io" } } }, "datacenter_response_fields": { "properties": { "_key": { "description": "key for the data center", "type": "string", "example": "gdn-us-west" }, "host": { "description": "IP address of the data center.", "type": "string", "example": "92.236.111.184" }, "local": { "description": "If *true*, the data center is a regional data center for the request else *false*.", "type": "boolean", "example": true }, "name": { "description": "Name of the data center.", "type": "string", "example": "gdn-us-west" }, "spot_region": { "description": "If *true*, the data center is on-spot capable", "type": "boolean", "example": false }, "status": { "description": "If *0*, the data center is online else data center is having connectivity problem.", "type": "integer", "example": 0 }, "tags": { "$ref": "#/components/schemas/datacenter_response_tags" }, "locationInfo": { "$ref": "#/components/schemas/datacenter_response_location_info" } } }, "tenant_limits_value": { "type": "object", "properties": { "apiServer": { "$ref": "#/components/schemas/api_server_limits_example" }, "cep": { "$ref": "#/components/schemas/cep_limits_example" }, "database": { "$ref": "#/components/schemas/database_limits_example" }, "eventhub": { "$ref": "#/components/schemas/eventhub_limits_example" }, "streamsGlobal": { "$ref": "#/components/schemas/streams_limits_example" }, "streamsLocal": { "$ref": "#/components/schemas/streams_limits_example" }, "dataMeshIntegration": { "$ref": "#/components/schemas/dmi_limits_example" } } }, "database_limits_example": { "type": "object", "properties": { "maxDocumentSize": { "description": "The maximum document size in bytes.", "type": "integer", "example": 524288 }, "maxDocumentsReturnedByQuery": { "description": "The maximum documents returned by a query, or 0 to disable this limit. The page size for the query is equal to this value (if set), preventing c8db from creating a persistent cursor for queries.", "format": "int64", "type": "integer", "example": 1000 }, "maxQueryExecutionTimeInMs": { "description": "The maximum time allowed for a query to complete processing.", "type": "integer", "example": 100000 }, "maxQueryMemoryBytes": { "description": "The maximum bytes of memory allowed to be used by a query during processing.", "type": "integer", "example": 527958016 }, "maxGeoFabricsPerTenant": { "description": "The maximum number of fabric a tenant can create. Use 0 to disable.", "type": "integer", "example": 2 }, "maxCollectionsPerFabric": { "description": "The maximum number of collections per fabric a tenant can create. Use 0 to disable.", "type": "integer", "example": 10 }, "maxGraphsPerFabric": { "description": "The maximum number of graph collections per fabric a tenant can create. Use 0 to disable.", "type": "integer", "example": 2 }, "maxIndexes": { "description": "The maximum number of indexes per fabric a tenant can create. Use 0 to disable.", "type": "integer", "example": 10 }, "maxViewsPerFabric": { "description": "The maximum number of views per fabric a tenant can create. Use 0 to disable.", "type": "integer", "example": 2 }, "maxRequestsPerDay": { "description": "The maximum number of API requests per day for a tenant, including UI requests to the APIs. Use 0 to disable. This only applies for tenants with the 'tenant.trial' property in _tenants set to *true*.", "type": "integer", "example": 20000 }, "maxStoragePerRegion": { "description": "The maximum storage (in bytes) allowed to be used by a tenant in a region. Use 0 to disable. This only applies for tenants with the 'FREE' billing plan. **Note**: As the metadata is also get counted in storage size calculation, the required storage size could be more than the total documents size stored in database.", "type": "integer", "example": 412467200 }, "maxRestQLUsagePerFabric": { "description": "The maximum number of RestQL queries per fabric a tenant can run in a day. Use 0 to disable.", "type": "integer", "example": 1000 }, "maxRestQLUsagePerDay": { "description": "The maximum number of RestQL requests can be ran by a tenant in a day. Use 0 to disable.", "type": "integer", "example": 1000 }, "maxDocumentsImportedPerAPICall": { "description": "The maximum number of documents a tenant can import in a single API call. Use 0 to disable.", "type": "integer", "example": 10000 } } }, "api_server_limits_example": { "type": "object", "properties": { "maxRequestPerMinute": { "description": "Rate limiting at the gateway proxy. This value indicates the maximum number of requests per minute for a tenant, including all http/https requests for any component coming from a regions LoadBalancer. If the value is 0, rate limiting is disabled.", "format": "int64", "type": "integer", "example": 60 } } }, "streams_limits_example": { "type": "object", "properties": { "maxStreamsCount": { "description": "Max streams count.", "type": "integer", "example": 25 }, "maxProducersCount": { "description": "Max streams producer count.", "type": "integer", "example": 14 }, "maxConsumersCount": { "description": "Max streams consumer count.", "type": "integer", "example": 14 }, "maxSubscriptionsCount": { "description": "Max streams subscriptions count.", "type": "integer", "example": 14 }, "maxBacklogMessageTTLMin": { "description": "Max streams backlog messagaes TTL in minute.", "type": "integer", "example": 240 }, "maxBacklogStorageSizeMB": { "description": "Max streams backlog storage size in MB.", "type": "integer", "example": 100 }, "maxDispatchThrottlingRateInByte": { "description": "Max streams byte dispatch rate per minute.", "type": "integer", "example": 4096 } } }, "eventhub_limits_example": { "description": "The limits values for eventhub feature", "type": "object", "format": "object", "properties": { "maxEventhubProducersCount": { "description": "Max eventhub producers count.", "type": "integer", "example": 0 }, "maxEventhubConsumersCount": { "description": "Max eventhub consumers count", "type": "integer", "example": 0 } } }, "cep_limits_example": { "description": "The limits values for CEP feature", "type": "object", "format": "object", "properties": { "maxPublishedWorkers": { "description": "Max number of published workers.", "type": "integer", "example": 30 }, "maxWorkersMemoryMB": { "description": "Max total memory size in MB of all the stream workers for the tenant.", "type": "integer", "example": 500 }, "maxMemoryMBPerWorker": { "description": "Max memory size in MB per stream worker for the tenant.", "type": "integer", "example": 100 }, "maxWorkersCpuSecondsPerMinute": { "description": "Max CPU seconds per minute for stream worker", "type": "integer", "example": 60 }, "maxWorkersThroughputInMBPerMinute": { "description": "Max IN throughput per minute in MB for stream workers.", "type": "integer", "example": 10 }, "maxWorkersThroughputOutMBPerMinute": { "description": "Max OUT throughput per minute in MB for stream workers.", "type": "integer", "example": 10 }, "maxLogsLengthKBPerMinutePerWorker": { "description": "Max logs length per minute in KB for each stream worker.", "type": "integer", "example": 10 }, "maxCpuSecondsPerMinutePerWorker": { "description": "Max CPU seconds per minute for each stream worker.54", "type": "integer", "example": 20 } } }, "dmi_limits_example": { "description": "The limits values for Data Mesh Integrations feature.", "type": "object", "properties": { "maxConnections": { "description": "Max number of connections.", "type": "integer", "example": 100 }, "maxWorkflows": { "description": "Max number of workflows.", "type": "integer", "example": 1000 } } }, "set_enable_limits_flag": { "type": "object", "properties": { "value": { "description": "The flag value for enable limits. This value is applicable for all tenants. This is a boolean field. Set this value to true, if limits need to be enabled, else set it to *false* to disable limits.", "type": "boolean", "example": true } } }, "rename_view": { "properties": { "name": { "description": "The new name of the search view.", "type": "string", "example": "new_view_name" } }, "type": "object" }, "post_api_view": { "properties": { "name": { "description": "The name of the search view.", "type": "string" }, "properties": { "$ref": "#/components/schemas/post_api_view_props" }, "type": { "description": "The type of the search view. It must be equal to one of the supported C8DB search view types.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "post_api_view_fields": { "description": "A list of link properties that are applied at each document level with each key specifying a document attribute.", "properties": { "[field-name]": { "description": "This is a recursive structure for the specific attribute path, potentially containing any of the following attributes: *analyzers*, *includeAllFields*, *trackListPositions*, *storeValues*. Any attributes not specified are inherited from the parent.", "items": { "type": "object" }, "type": "object" } }, "type": "object", "default": {} }, "post_api_view_semantic_field_def": { "description": "A list of link properties that are applied at each document level with each key specifying a document attribute", "properties": { "[field-name]": { "type": "object", "properties": { "size": { "description": "The size of the vector.", "type": "integer", "example": 4 }, "distanceType": { "description": "The measure of distance employed to assess the degree of similarity. Acceptable options include \"L2\" (Euclidean distance), \"IP\" (inner product), and \"COSINE\" (cosine similarity).", "type": "string", "enum": [ "L2", "IP", "COSINE" ], "example": "L2" }, "indexConfig": { "type": "object", "properties": { "type": { "description": "The type of the index.", "type": "string", "enum": [ "hnsw", "ivf", "flat" ], "example": "hnsw" }, "maxSize": { "description": "The maximum number of documents to add to this view. (Applies only to HNSW.)", "type": "integer", "example": 100000 }, "nLinks": { "description": "The links for an element. (Applies only to HNSW.)", "type": "integer", "example": 8 }, "efConstruction": { "description": "The expansion factor at construction time. (Applies only to HNSW.)", "type": "integer", "example": 8 }, "efSearch": { "description": "The expansion factor at search time. (Applies only to HNSW.)", "type": "integer", "example": 8 }, "nProbe": { "description": "The number of probes at query time. (Applies only to IVF.)", "type": "integer", "example": 8 }, "sample": { "description": "Sample percentage used for training the index (from 0 to 1). (Applies only to IVF.)", "type": "number", "format": "float", "example": 0.1 } }, "required": [ "type" ] }, "quantizationConfig": { "type": "object", "properties": { "type": { "description": "The type of the quantizer. Valid values are \"NONE\" (no quantization), \"PQ\" (Product Quantizer), and \"SQ\" (Scalar Quantizer).", "type": "string", "enum": [ "none", "pq", "sq" ], "example": "none" }, "bits": { "description": "The number of output bits after quantization. (Applies to only to PQ and SQ quantizers.)", "type": "integer", "example": 8 } }, "required": [ "type" ] } }, "required": [ "size", "distanceType", "indexConfig" ] } }, "required": [ "[field-name]" ], "type": "object" }, "post_api_view_semantic_fields": { "description": "The link properties. If specified, *properties* should be a JSON object containing the following attributes:", "properties": { "fields": { "$ref": "#/components/schemas/post_api_view_semantic_field_def" } }, "type": "object" }, "post_api_view_iresearch": { "properties": { "name": { "description": "The name of the search view. This field is immutable.", "type": "string", "example": "new_collection_view" }, "primarySort": { "description": "Specify default sorting order. This field is immutable.", "type": "array", "items": { "type": "object", "properties": { "field": { "description": "The name of the field.", "type": "string", "example": "attribute1" }, "direction": { "description": "The sorting direction.", "type": "string", "example": "asc" } }, "default": {} }, "default": [] }, "links": { "$ref": "#/components/schemas/post_api_view_links" }, "type": { "description": "The type of the search view. Must be equal to *search*.", "type": "string", "default": "search" } }, "required": [ "name", "type" ], "type": "object" }, "post_api_view_semantic": { "properties": { "name": { "description": "The name of the semantic search view. This field is immutable.", "type": "string", "example": "new_collection_view" }, "links": { "$ref": "#/components/schemas/post_api_view_link_semantic_props" }, "type": { "description": "The type of the search view. Must be equal to *semantic_search*.", "type": "string", "default": "semantic_search" } }, "required": [ "name", "type" ], "type": "object" }, "post_api_view_link_props": { "description": "The link properties. If specified, *properties* should be a JSON object containing the following attributes:", "properties": { "analyzers": { "description": "The list of analyzers to be used for indexing of string values.", "format": "string", "items": { "type": "string", "default": "identity" }, "type": "array" }, "fields": { "$ref": "#/components/schemas/post_api_view_fields" }, "includeAllFields": { "description": "The flag determines whether or not to index all fields on a particular level of depth.", "type": "boolean", "default": false }, "storeValues": { "description": "How should the search view track the attribute values, this setting allows for additional value retrieval optimizations, one of:\n- *none*: Do not store values by the search view\n- *id*: Store only information about value presence, to allow use of the EXISTS() function.", "type": "string", "default": "none" }, "trackListPositions": { "description": "The flag determines whether or not values in a lists should be treated separate.", "type": "boolean", "default": false } }, "type": "object" }, "post_api_view_link_semantic_props": { "description": "The link properties. If specified, *properties* should be a JSON object containing the following attributes:", "properties": { "[collection-name]": { "$ref": "#/components/schemas/post_api_view_semantic_fields" } }, "type": "object" }, "post_api_view_links": { "description": "The set of collection names associated with the properties.", "properties": { "[collection-name]": { "$ref": "#/components/schemas/post_api_view_link_props" } }, "type": "object" }, "post_api_view_props": { "description": "The search view properties. If specified, *properties* should be a JSON object containing the attributes supported by the specific search view type.\n\nThe search view properties. If specified, *properties* should be a JSON object containing the following attributes:\n\nThe search view properties. If specified, *properties* should be a JSON object containing the following attributes:\n\nThe search view properties. If specified, *properties* should be a JSON object containing the following attributes:", "properties": { "links": { "$ref": "#/components/schemas/post_api_view_links" } }, "type": "object" }, "auth_token": { "properties": { "email": { "description": "The email of the user for whom we want the auth token.", "type": "string", "example": "joe@foo.com" }, "password": { "description": "The user password.", "type": "string", "example": "xxxxx" }, "tenant": { "description": "The name of the tenant for whose user we want the auth token.", "type": "string", "example": "foo" }, "username": { "description": "The id of the user for whom we want the auth token.", "type": "string", "example": "joe" } }, "required": [ "password" ], "type": "object" }, "keys_array": { "items": { "type": "string", "format": "string", "example": "foo" }, "type": "array" }, "key_value": { "properties": { "_key": { "description": "Key", "type": "string", "example": "foo" }, "value": { "description": "Value", "type": "string", "example": "bar" }, "groupID": { "description": "Group ID", "type": "string", "example": "group-1" }, "expireAt": { "description": "Expiry time in UTC timestamp format.", "type": "integer", "default": -1 } }, "required": [ "_key", "value" ], "type": "object" }, "key_blob": { "properties": { "meta": { "properties": { "_key": { "description": "Key for the KV pair. If it is not set, then it is generated by the system", "type": "string", "example": "foo" }, "expireAt": { "description": "UNIX timestamp, indicating when the value expires (-1 means no expiration).", "type": "integer", "default": -1 } }, "type": "object" }, "value": { "description": "File to be uploaded as the value of the blob.", "type": "string", "format": "binary" } }, "required": [ "meta", "value" ], "type": "object" }, "key_value_array": { "items": { "$ref": "#/components/schemas/key_value" }, "type": "array" }, "key_blob_array": { "items": { "$ref": "#/components/schemas/key_blob" }, "type": "array" }, "kv_array_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of keys. If there are no results, the array is returned as empty.", "type": "array", "items": { "type": "string", "example": "data" } } } }, "keys_array_rc_200_1": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of keys. If there are no results, the array is returned as empty.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Name of the collection.", "type": "string", "example": "testCollection" }, "expiration": { "description": "Expiration details of a collection.", "type": "string", "example": true } } } } } }, "get_all_streams_examples_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "description": "An array of streams.", "type": "array", "items": { "properties": { "_key": { "type": "string", "example": "_attributes_TYPE4" }, "_id": { "type": "string", "example": "_collections/_attributes_TYPE4" }, "_rev": { "type": "string", "example": "dsH7Aem--J" }, "db": { "type": "string", "example": "_system" }, "local": { "type": "boolean", "example": true }, "tenant": { "type": "string", "example": "_mm" }, "topic": { "type": "string", "example": "_attributes" }, "type": { "type": "integer", "example": 4 } } } } } }, "create_stream_example_rc_202": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 202 }, "result": { "properties": { "stream-id": { "type": "string", "example": "c8locals.stream1" } } } } }, "delete_stream_example_rc_202": { "type": "object", "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 202 }, "result": { "type": "object" } } }, "publish_stream_example_rc_200": { "type": "object", "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "object" } } }, "publish_http_source_example_rc_202": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 202 }, "result": { "type": "object" } } }, "get_stream_backlog_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "string", "description": "Stringified JSON object with backlog details" } } }, "get_stream_stats_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "string", "description": "Stringified JSON object with statistics for the stream." } } }, "get_stream_subs_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "string", "description": "Stringified JSON object with a list of subscriptions for the stream." } } }, "get_stream_ttl_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "string", "example": "21600", "description": "TTL in seconds." } } }, "set_stream_ttl_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "string" } } }, "get_all_managedkeys_examples_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "total": { "description": "Total managed keys found.", "type": "integer", "example": 100 }, "offset": { "description": "Fetch managed keys from offset.", "type": "integer", "example": 0 }, "count": { "description": "Count managed keys to return.", "type": "integer", "example": 50 }, "items": { "description": "An array of managed keys.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "lPz8KjI2_yzYBgjkk2jlWA.IqXfBlY" }, "name": { "type": "string", "example": "managed_key_1" }, "keyOptions": { "type": "object", "properties": { "masterKeyIds": { "type": "array", "items": {} } } }, "managedKeyType": { "type": "string", "example": "CMK" }, "keyProvider": { "type": "string", "example": "AWS" }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 }, "status": { "type": "string", "example": "ENABLED" }, "description": { "type": "string", "example": "Customer's key." } } } } } } } }, "get_managedkey_examples_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "id": { "type": "string", "example": "lPz8KjI2_yzYBgjkk2jlWA.IqXfBlY" }, "name": { "type": "string", "example": "managed_key_1" }, "keyOptions": { "type": "object", "properties": { "masterKeyIds": { "type": "array" } } }, "managedKeyType": { "type": "string", "example": "CMK" }, "keyProvider": { "type": "string", "example": "AWS" }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 }, "status": { "type": "string", "example": "ENABLED" }, "description": { "type": "string", "example": "Customer's key." } } } } }, "create_managed_key_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "id": { "type": "string", "example": "lPz8KjI2_yzYBgjkk2jlWA.IqXfBlY" }, "name": { "type": "string", "example": "managed_key_1" }, "keyOptions": { "type": "object", "example": null }, "managedKeyType": { "type": "string", "example": "CMK" }, "keyProvider": { "type": "string", "example": "MACROMETA" }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 }, "status": { "type": "string", "example": "ENABLED" }, "description": { "type": "string", "example": "Customer's key." } } } } }, "create_managed_key_request": { "type": "object", "properties": { "name": { "type": "string", "example": "managed_key_1" }, "managedKeyType": { "type": "string", "example": "CMK" }, "keyProvider": { "type": "string", "example": "MACROMETA" }, "service": { "type": "string", "example": "SECRETS" }, "description": { "type": "string", "example": "Customer's managed key #1." }, "masterKeyIds": { "type": "object", "example": null } } }, "get_all_secrets_examples_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code. `value` property always returns as `null`.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "total": { "description": "Total secrets found.", "type": "integer", "example": 100 }, "offset": { "description": "Fetch secrets from offset.", "type": "integer", "example": 0 }, "count": { "description": "Count secrets to return.", "type": "integer", "example": 50 }, "items": { "description": "An array of secrets.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "secret_name_1" }, "value": { "type": "string", "example": null }, "fileName": { "type": "string", "example": null }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 } } } } } } } }, "get_secret_examples_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "name": { "type": "string", "example": "secret_name_1" }, "value": { "type": "string", "example": "my value" }, "fileName": { "type": "string", "example": null }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "keyName": { "type": "string", "example": "managed_key_1" }, "keyId": { "type": "string", "example": "I1tcRHpOqEtvOxw9z90WjQ.EmcLClY" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 } } } } }, "create_secret_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code. `value` property always returns as `null`.", "type": "integer", "example": 200 }, "result": { "type": "object", "properties": { "name": { "type": "string", "example": "secret_name_1" }, "value": { "type": "string", "example": null }, "fileName": { "type": "string", "example": null }, "tenant": { "type": "string", "example": "_mm" }, "fabric": { "type": "string", "example": "_system" }, "keyName": { "type": "string", "example": "managed_key_1" }, "keyId": { "type": "string", "example": "I1tcRHpOqEtvOxw9z90WjQ.EmcLClY" }, "createdAt": { "type": "number", "example": 1689020889736 }, "updatedAt": { "type": "number", "example": 1689020889736 } } } } }, "create_secret_request": { "type": "object", "properties": { "name": { "type": "string", "example": "secret_name_1" }, "value": { "type": "string", "example": "my value" }, "fileName": { "type": "string", "example": null }, "keyName": { "type": "string", "example": null } } }, "update_secret_request": { "type": "object", "properties": { "value": { "type": "string", "example": "my updated value" }, "fileName": { "type": "string", "example": null }, "keyName": { "type": "string", "example": null } } }, "delete_all_secret_example_rc_200": { "properties": { "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "code": { "description": "The generated response code. `value` property always returns as `null`.", "type": "integer", "example": 200 }, "result": { "type": "array", "items": { "type": "string" } } } }, "get_all_GeoFabrics_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of GeoFabric names", "type": "array", "items": { "type": "string" }, "example": [ "_system", "demo._system" ] } } }, "create_GeoFabric_examples_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the GeoFabric was created successfully", "type": "boolean", "example": true } } }, "get_GeoFabric_info_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there was an error. It is *false* in this response.", "type": "boolean", "example": false }, "result": { "type": "object", "properties": { "name": { "type": "string", "example": "_system" }, "options": { "$ref": "#/components/schemas/get_user_GeoFabrics_options_examples_rc_200" }, "isSystem": { "description": "Whether or not the current GeoFabric is the _system fabric", "type": "boolean", "example": true } } } } }, "get_user_GeoFabrics_examples_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "_system" }, "options": { "$ref": "#/components/schemas/get_user_GeoFabrics_options_examples_rc_200" }, "isSystem": { "description": "Whether or not the current GeoFabric is the _system fabric", "type": "boolean", "example": true } } } } } }, "get_user_GeoFabrics_options_examples_rc_200": { "type": "object", "properties": { "associated_regions": { "description": "List of data centers added.", "type": "array", "items": { "type": "string" }, "example": [ "datacenter1", "datacenter2" ] }, "clusters": { "description": "List of data centers added.", "type": "array", "items": { "type": "string" }, "example": [ "datacenter1", "datacenter2" ] }, "dcList": { "description": "List of data centers added.", "type": "string", "example": "datacenter1,datacenter2" }, "dynamo_local_tables": { "description": "Flag indicator for dynamo_local_tables", "type": "boolean", "example": false }, "metadata": { "description": "An optional JSON object with user defined key-value pairs", "type": "object", "example": { "key": "value" } }, "name": { "description": "Name of GeoFabric", "type": "string", "example": "_system" }, "realTime": { "description": "Whether the changes are published in real time streams", "type": "boolean" }, "spotDc": { "description": "The Edge Location (Datacenter) where on-spot operations for the GeoFabric is performed", "type": "string", "example": "datacenter1" }, "status": { "description": "Available or not", "type": "string", "example": "available" }, "tenant": { "description": "Tenant name", "type": "string", "example": "_mm" } } }, "dropped_GeoFabrics_example_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether GeoFabric was successfully removed.", "type": "boolean", "example": true } } }, "set_GeoFabric_example_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the GeoFabric metadata was successfully set", "type": "boolean", "example": true } } }, "patch_GeoFabric_example_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the GeoFabric metadata was modified successfully", "type": "boolean", "example": true } } }, "GeoFabric_add_locations": { "properties": { "dc": { "description": "The data center to be added to the GeoFabric.", "type": "string" } }, "required": [ "dc" ], "type": "object" }, "graph_traversal": { "properties": { "direction": { "description": "Direction for traversal\n- *if set*, must be either *\"outbound\"*, *\"inbound\"*, or *\"any\"*\n- *if not set*, the *expander* attribute must be specified.", "type": "string" }, "edgeCollection": { "description": "Name of the collection that contains the edges.", "type": "string" }, "expander": { "description": "Body (JavaScript) code of custom expander function *must* be set if *direction* attribute is **not** set function signature: *(config, vertex, path) -> array* expander must return an array of the connections for *vertex* each connection is an object with the attributes *edge* and *vertex*.", "type": "string" }, "filter": { "description": "Default is to include all nodes: body (JavaScript code) of custom filter function signature: *(config, vertex, path) -> mixed* can return four different string values:\n- *\"exclude\"* -> this vertex is not visited.\n- *\"prune\"* -> the edges of this vertex is not followed.\n- *\"\"* or *undefined* -> visit the vertex and follow its edges.\n- *Array* -> containing any combination of the above.", "type": "string" }, "graphName": { "description": "Name of the graph that contains the edges. Either *edgeCollection* or *graphName* has to be given. In case both values are set the *graphName* is preferred.", "type": "string" }, "init": { "description": "Body (JavaScript) code of custom result initialization function function signature: *(config, result) -> void* initialize any values in result with what is required.", "type": "string" }, "itemOrder": { "description": "Item iteration order can be *\"forward\"* or *\"backward\"*.", "type": "string" }, "maxDepth": { "description": "ANDed with any existing filters visits only nodes in at most the given depth.", "type": "string" }, "maxIterations": { "description": "Maximum number of iterations in each traversal. This number can be set to prevent endless loops in traversal of cyclic graphs. When a traversal performs as many iterations as the *maxIterations* value, the traversal aborts with an error. If *maxIterations* is not set, a server-defined value may be used.", "type": "string" }, "minDepth": { "description": "ANDed with any existing filters visits only nodes in at least the given depth.", "type": "string" }, "order": { "description": "Traversal order can be *\"preorder\"*, *\"postorder\"* or *\"preorder-expander\"*.", "type": "string" }, "sort": { "description": "Body (JavaScript) code of a custom comparison function for the edges. The signature of this function is *(l, r) -> integer* (where l and r are edges) and must return -1 if l is smaller than, +1 if l is greater than, and 0 if l and r are equal. The reason for this is the following: The order of edges returned for a certain vertex is undefined. This is because there is no natural order of edges for a vertex with multiple connected edges. To explicitly define the order in which edges on the vertex are followed, you can specify an edge comparator function with this attribute. Note that the value here has to be a string to conform to the JSON standard, which in turn is parsed as function body on the server side. Furthermore note that this attribute is only used for the standard expanders. If you use your custom expander you have to do the sorting yourself within the expander code.", "type": "string" }, "startVertex": { "description": "Id of the startVertex, e.g. *\"users/foo\"*.", "type": "string" }, "strategy": { "description": "Traversal strategy can be *\"depth-first\"* or *\"breadth-first\"*.", "type": "string" }, "uniqueness": { "description": "Specifies uniqueness for vertices and edges visited. If set, must be an object like this:\n`\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}`.", "type": "string" }, "visitor": { "description": "Body (JavaScript) code of custom visitor function function signature: *(config, result, vertex, path, connected) -> void* The visitor function can do anything, but its return value is ignored. To populate a result, use the *result* variable by reference. Note that the *connected* argument is only populated when the *order* attribute is set to *\"preorder-expander\"*.", "type": "string" } }, "required": [ "startVertex" ], "type": "object" }, "event_attributes": { "description": "Additional event attributes. If specified, *attributes* should be a JSON array containing key-value attributes", "type": "object", "example": { "CollectionType": "DOCUMENT", "HasStream": 1, "IsLocal": 0, "IsOrigin": 1 } }, "create_database": { "properties": { "name": { "description": "Has to contain a valid GeoFabric name.", "type": "string", "example": "_system" }, "tenant": { "description": "Name of the tenant to associate with GeoFabric. This option is applicable and optional when system tenant *_mm* invokes the API. Other tenants should not specify this option as the tenant invoking API shall be associated with GeoFabric.", "type": "string", "example": "_mm" }, "options": { "$ref": "#/components/schemas/create_database_options" }, "users": { "description": "Enter an array of user ids that has admin access to the new GeoFabric. If this field is left blank, the default user *root* has admin access.", "type": "array", "items": { "type": "string" }, "example": [ "root" ] } }, "required": [ "name" ], "type": "object" }, "create_environment_database": { "properties": { "name": { "description": "Has to contain a valid environment name.", "type": "string" }, "tenant": { "description": "Name of the tenant to associate with environment. This option is applicable and optional when system tenant *_mm* invokes the API. Other tenants should not specify this option as the tenant invoking API shall be associated with environment.", "type": "string" }, "options": { "$ref": "#/components/schemas/create_environment_database_options" }, "users": { "description": "Enter an array of user ids that has admin access to the new environment. If this field is left blank, the default user *root* has admin access.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "create_database_options": { "description": "Has to be a dictionary of GeoFabric options. If this is not specified or one of the dictionary members are not specified, defaults are used.\n\nThe members of the *options* dictionary are as follows:", "properties": { "dcList": { "description": "The list of Edge Locations (data centers) as a comma-separated string. The individual elements for this parameter are your Edge Location URL prefixes up to the first *.* character. For instance if one of your Edge Location URLs is *http://myfederation-us-east-1.dev.aws.macrometa.io*, the corresponding value of one the items for this parameter would be *myfederation-us-east-1*. You can use the */datacenter/all* REST API call to get a list of all available Edge Locations and pick and choose from this list. It is a mandatory field, but if not specified (due to user error), it defaults to the local Edge Location.", "type": "string", "example": "datacenter1,datacenter2" }, "spotDc": { "description": "The Edge Location (data center) where on-spot operations for the given GeoFabric is performed. By default, a random data center is chosen from those which are capable.", "type": "string", "example": "datacenter1" }, "metadata": { "description": "Object with user defined key-value pairs.", "type": "object", "example": { "key": "value" } } }, "type": "object" }, "create_environment_examples_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether the environment was created successfully.", "type": "boolean", "example": true } } }, "get_user_environments_examples_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "_system" }, "options": { "$ref": "#/components/schemas/get_user_GeoFabrics_options_examples_rc_200" }, "isSystem": { "type": "boolean", "example": true } } } } } }, "get_all_environment_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of environment names", "type": "array", "items": { "type": "string" }, "example": [ "_system", "demo._system" ] } } }, "dropped_environment_example_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Whether environment was successfully removed.", "type": "boolean", "example": true } } }, "get_environment_info_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Information about the current environment.", "type": "object", "properties": { "name": { "type": "string", "example": "_system" }, "options": { "$ref": "#/components/schemas/get_user_GeoFabrics_options_examples_rc_200" }, "isSystem": { "description": "Whether or not the current GeoFabric is the *_system* fabric", "type": "boolean", "example": true } } } } }, "set_environment_example_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Flag for if the environment was set successfully.", "type": "boolean", "example": true } } }, "patch_environment_example_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "boolean", "description": "Flag for if the environment was updated successfully.", "example": true } } }, "create_environment_database_options": { "description": "Has to be a dictionary of Database options used when creating the environment. If this is not specified, default options are used. If one of the dict members is not specified, defaults is used for that dict member.\nThe members of the *options* dictionary are as follows:", "properties": { "spotDc": { "description": "The Edge Location (data center) where on-spot operations for the given environment is performed. By default, a random data center is chosen from those which are capable.", "type": "string" }, "metadata": { "description": "Object with user defined key-value pairs.", "type": "object", "example": { "key": "value" } } }, "type": "object" }, "database_metadata": { "properties": { "metadata": { "description": "Object with user defined key-value pairs.", "type": "object", "example": { "key": "value" } } } }, "api_query_properties": { "properties": { "query": { "description": "To validate a query string without executing it, the query string can be passed to the server via an HTTP POST request.", "type": "string", "example": "for u in testCollection return u" } }, "required": [ "query" ], "type": "object" }, "track_query_properties": { "properties": { "enabled": { "description": "If set to *true*, queries is tracked. If set to *false*, neither queries nor slow queries is tracked.", "type": "boolean" }, "maxQueryStringLength": { "description": "The maximum query string length to keep in the list of queries. Query strings can have arbitrary lengths, and this property can be used to save memory in case very long query strings are used. The value is specified in bytes.", "format": "int64", "type": "integer" }, "maxSlowQueries": { "description": "The maximum number of slow queries to keep in the list of slow queries. If the list of slow queries is full, the oldest entry in it is discarded when additional slow queries occur.", "format": "int64", "type": "integer" }, "slowQueryThreshold": { "description": "The threshold value for treating a query as slow. A query with a runtime greater or equal to this threshold value is put into the list of slow queries when slow query tracking is enabled. The value for *slowQueryThreshold* is specified in seconds.", "format": "int64", "type": "integer" }, "trackBindVars": { "description": "If set to *true*, the bind variables used in queries is tracked along with queries.", "type": "boolean" }, "trackSlowQueries": { "description": "If set to *true*, slow queries is tracked in the list of slow queries if their runtime exceeds the value set in *slowQueryThreshold*. In order for slow queries to be tracked, the *enabled* property must also be set to *true*.", "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "tenant_create": { "properties": { "email": { "description": "Email address of tenant.", "type": "string", "example": "demo@macrometa.com" }, "displayName": { "description": "The name of the tenant.", "type": "string", "example": "Test" }, "passwd": { "description": "The user password.", "type": "string", "example": "XXXX" }, "plan": { "description": "The billing plan name.", "type": "string", "example": "ENTERPRISE" }, "attribution": { "description": "The attribution.", "type": "string", "example": "Macrometa" }, "dcList": { "description": "A comma-separated string containing the data center names on which this tenant is to be created. If an empty string is passed in, the tenant is assumed to be global to the federation and is created on all current data centers in the federation.", "type": "string", "example": "datacenter1, datacenter2" }, "metadata": { "$ref": "#/components/schemas/get_tenant_metadata_object_example" }, "contact": { "$ref": "#/components/schemas/create_tenant_contact_object_example" } }, "required": [ "email", "dcList" ], "type": "object" }, "get_tenant_example_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/get_tenant_result_value" } } }, "get_tenant_result_value": { "properties": { "limits": { "$ref": "#/components/schemas/tenant_limits_value" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "Test" }, "status": { "description": "Availability of tenant.", "format": "string", "type": "string", "example": "available" }, "spotDc": { "description": "The Edge Location (data center) where on-spot operations for the given GeoFabric is performed. By default, a random data center is chosen from those which are capable.", "format": "string", "type": "string" }, "realTime": { "description": "For this tenant, whether the changes are published in a real time streams.", "format": "boolean", "type": "boolean", "example": true }, "name": { "description": "Name of the tenant with fabric name as a suffix.", "format": "string", "type": "string", "example": "demo._system" }, "clusters": { "description": "List of data centers in tenant.", "items": { "type": "string" }, "example": [ "dc-region1", "dc-region2" ] }, "dynamo_local_tables": { "description": "Flag indicator for dynamo_local_tables.", "format": "boolean", "type": "boolean", "example": false }, "attribution": { "description": "Attribution of the tenant.", "format": "string", "type": "string", "example": null }, "features": { "description": "List of features with boolean value indicating that those features are enabled or not.", "items": { "$ref": "#/components/schemas/features_list_with_availability_flag_example" } }, "plan": { "description": "Name of the billing plan.", "format": "string", "type": "string", "example": "enterprise" }, "metadata": { "description": "Object with metadata key-value pairs.", "type": "object", "example": { "key": "value" } }, "dnsInfo": { "$ref": "#/components/schemas/dns_info_response" } } }, "tenant_update_plan_example_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "The information about what are the new attribution, billing plan and features attributes for tenant after billing plan is updated.", "type": "object", "properties": { "attribution": { "description": "Attribution of the tenant.", "type": "string", "example": "Macrometa" }, "plan": { "description": "Name of the billing plan.", "format": "string", "type": "string", "example": "Enterprise" }, "features": { "description": "List of features with boolean value indicating that those features are enabled or not.", "type": "array", "items": { "$ref": "#/components/schemas/features_list_with_availability_flag_example" } } } } }, "required": [ "error" ], "type": "object" }, "features_list_with_availability_flag_example": { "type": "object", "properties": { "CEP": { "description": "Name of the CEP feature.", "type": "boolean", "example": false }, "DOCS": { "description": "Name of the Docs feature.", "type": "boolean", "example": false }, "DYNAMO": { "description": "Name of the Dynamo feature.", "type": "boolean", "example": false }, "REDIS": { "description": "Name of the Redis feature.", "type": "boolean", "example": false }, "GEO_FABRICS": { "description": "Name of the Geo Fabrics feature.", "type": "boolean", "example": false }, "GRAPHS": { "description": "Name of the Graphs feature.", "type": "boolean", "example": false }, "KV": { "description": "Name of the KV feature.", "type": "boolean", "example": true }, "LOCAL_COLLECTIONS": { "description": "Name of the Local Collections feature.", "type": "boolean", "example": false }, "STREAMS": { "description": "Name of the streams feature.", "type": "boolean", "example": false }, "USERS": { "description": "Name of the Users feature.", "type": "boolean", "example": false }, "EVENT_HUB": { "description": "Name of the EventHub feature.", "type": "boolean", "example": false } } }, "get_tenant_metadata_object_example": { "properties": { "key1": { "description": "Name of metadata key 1.", "format": "string", "type": "string", "example": "value1" }, "key2": { "description": "Name of metadata key 2.", "format": "string", "type": "string", "example": "value2" } }, "default": {} }, "create_tenant_contact_object_example": { "properties": { "firstname": { "description": "First name of user.", "type": "string", "example": "demo" }, "lastname": { "description": "Last name of user.", "type": "string", "example": "marometa" }, "email": { "description": "Email address of user.", "type": "string", "example": "demo@macrometa.com" }, "phone": { "description": "Phone number of user.", "type": "string", "example": "+1 (650) 555-9144" }, "line1": { "description": "First line of address of user.", "type": "string", "example": "646 Waverley Street" }, "line2": { "description": "Second line of address of user.", "type": "string", "example": "Palo Alto, California 94301" }, "city": { "description": "Name of the city.", "type": "string", "example": "Palo Alto" }, "state": { "description": "Name of state.", "type": "string", "example": "California " }, "country": { "description": "Name of country.", "type": "string", "example": "United States of America" }, "zipcode": { "description": "Zip code of user.", "type": "string", "example": "94301" } } }, "tenant_modify": { "properties": { "active": { "description": "*True* if the tenant is active.", "type": "boolean", "example": true }, "status": { "description": "Status of the tenant. Possible values: **active | expired | delinquent | inactive**", "type": "string", "example": "active" }, "displayName": { "description": "Name of the tenant.", "type": "string" }, "metadata": { "description": "Object with metadata key-value pairs.", "type": "object", "example": { "key": "value" } } } }, "tenant_modify_example_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Attributes of tenant after patch operation.", "type": "array", "items": { "$ref": "#/components/schemas/tenant_modify_result_value" } } }, "type": "object" }, "tenant_modify_result_value": { "properties": { "tenant": { "description": "Name of the tenant.", "type": "string", "example": "Test" }, "active": { "description": "Active state of tenant.", "format": "boolean", "type": "boolean", "example": true }, "status": { "description": "Availability of tenant.", "format": "string", "type": "string", "example": "available" }, "metadata": { "description": "Object with metadata key-value pairs.", "type": "object", "example": { "key": "value" } } }, "type": "object" }, "plan_create": { "properties": { "name": { "description": "Name and unique identifier of the of the billing plan.", "type": "string", "example": "Test" }, "planId": { "description": "ID of the billing plan.", "type": "string", "example": "1" }, "description": { "description": "Description of the billing plan.", "type": "string", "example": "New billing plan." }, "featureGates": { "description": "List of the billing plan feature gates.", "type": "array", "items": { "type": "string", "example": "KV" } }, "attribution": { "description": "Attribution of the billing plan. Combination of attribution and label must be unique for the plan.", "type": "string", "example": "Macrometa" }, "label": { "description": "Display label of the billing plan. Combination of attribution and label must be unique for the plan.", "type": "string", "example": "Enterprise" }, "pricing": { "description": "Pricing details of the billing plan.", "type": "string", "example": "Custom pricing" }, "isBundle": { "description": "Bundle.", "type": "boolean", "example": true }, "metadata": { "description": "Metadata of the plan, having set of key-value pairs.", "type": "object", "example": { "key": "value" } }, "metrics": { "description": "List of metrics applicable for billing plan.", "type": "array", "items": { "$ref": "#/components/schemas/plan_metrics_example" } }, "active": { "description": "A mandatory flag that specifies whether the billing plan is active.", "type": "boolean", "example": true }, "demo": { "description": "An flag that specifies whether the billing plan is demo or not.", "type": "boolean", "default": false } }, "required": [ "name", "featureGates", "attribution", "label", "active" ], "type": "object" }, "plan_modify": { "properties": { "name": { "description": "Name and unique identifier of the of the billing plan.", "type": "string", "example": "Test" }, "planId": { "description": "ID of the billing plan.", "type": "string", "example": "1" }, "description": { "description": "Description of the billing plan.", "type": "string", "example": "New billing plan." }, "featureGates": { "description": "List of the billing plan feature gates.", "type": "array", "items": { "type": "string", "example": "KV" } }, "attribution": { "description": "Attribution of the billing plan. Combination of attribution and label must be unique for the plan.", "type": "string", "example": "Macrometa" }, "label": { "description": "Display label of the billing plan. Combination of attribution and label must be unique for the plan.", "type": "string", "example": "Enterprise" }, "pricing": { "description": "Pricing details of the billing plan.", "type": "string", "example": "Custom pricing" }, "isBundle": { "description": "Bundle.", "type": "boolean", "example": true }, "metadata": { "description": "Metadata of the plan, having set of key-value pairs.", "type": "object", "example": { "key": "value" } }, "metrics": { "description": "List of metrics applicable for billing plan.", "type": "array", "items": { "$ref": "#/components/schemas/plan_metrics_example" } }, "active": { "description": "A mandatory flag that specifies whether the billing plan is active.", "type": "boolean", "example": true }, "demo": { "description": "An flag that specifies whether the billing plan is demo or not.", "type": "boolean", "default": false } }, "type": "object" }, "plan_metrics_example": { "properties": { "name": { "description": "Name of the metrics. e.g. reads, writes etc.", "type": "string", "example": "kv-reads" }, "value": { "description": "Value of the metrics. e.g. c8db_service_read_requests_count, c8db_service_write_requests_count etc.", "type": "string", "example": "c8db_service_kv_read_requests_count" }, "metricType": { "description": "Name of the metrics. e.g. counter, gauge, histogram.", "type": "string", "example": "counter" } } }, "update_tenant_plan": { "properties": { "attribution": { "description": "Attribution of the billing plan.", "type": "string", "example": "Macrometa" }, "plan": { "description": "Name of the billing plan.", "type": "string", "example": "Enterprise" }, "tenant": { "description": "Name of the tenant.", "type": "string", "example": "joe" }, "payment_method_id": { "description": "ID of Stripe payment method.", "type": "string", "example": "pm_1KRHKj2eZvKYlo2CHkt3rab6" } }, "required": [ "attribution", "plan" ], "type": "object" }, "apikey_create": { "properties": { "keyid": { "description": "The id of the API key.", "type": "string", "example": "test1" }, "user": { "description": "The user that owns the API key. The 'user' option should be used only when creating an API key that belongs to another user, and can be used only by service or _mm.root.", "type": "string", "example": "tenant1.user1" }, "isSystem": { "description": "Indicates whether the key is a system API key.", "type": "boolean", "example": "false" } }, "required": [ "keyid" ], "type": "object" }, "apikey_validate": { "properties": { "apikey": { "description": "The id of the API key.", "type": "string", "example": "test1" } }, "required": [ "apikey" ], "type": "object" }, "user_create": { "properties": { "active": { "description": "If set to *true*, the user is active.", "format": "boolean", "type": "boolean", "default": true }, "email": { "description": "The email of the user.", "type": "string", "example": "test@bar.com" }, "passwd": { "description": "The user password. The password must have at least 8 characters, one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*).", "type": "string", "example": "P@55w0rd" }, "displayName": { "description": "The display name of the user.", "type": "string", "example": "Jhon Doe" } }, "required": [ "email", "passwd" ], "type": "object" }, "user_grant_collection": { "properties": { "grant": { "description": "- Use \"rw\" to set the collection level access to *Read/Write*.\n- Use \"ro\" to set the collection level access to *Read Only*.\n- Use \"none\" to set the collection level access to *No access*.", "type": "string", "example": "rw" } }, "required": [ "grant" ], "type": "object" }, "user_grant_database": { "properties": { "grant": { "description": "- Use \"rw\" to set the GeoFabric access level to *Administrate*.\n- Use \"ro\" to set the GeoFabric access level to *Access*.\n- Use \"none\" to set the database access level to *No access*.", "type": "string", "example": "rw" } }, "required": [ "grant" ], "type": "object" }, "user_grant_queryworker": { "properties": { "grant": { "description": "- Use \"rw\" to set the query worker level access to *Read/Write*.\n- Use \"ro\" to set the query worker level access to *Read Only*.\n- Use \"none\" to set the query worker level access to *No access*.", "type": "string", "example": "rw" } }, "required": [ "grant" ], "type": "object" }, "user_grant_managedkey": { "properties": { "grant": { "description": "- Use \"rw\" to set the managed key level access to *Read/Write*.\n- Use \"ro\" to set the managed key level access to *Read Only*.\n- Use \"none\" to set the managed key level access to *No access*.", "type": "string", "example": "rw" } }, "required": [ "grant" ], "type": "object" }, "key_attributes": { "properties": { "attributes": { "description": "Use \"rw\" to set the database access level to *Administrate*.\n\nUse \"ro\" to set the database access level to *Access*.\n\nUse \"none\" to set the database access level to *No access*.", "type": "string" } }, "required": [ "attributes" ], "type": "object" }, "user_modify": { "properties": { "active": { "description": "If set to _true_, then the user is active.", "type": "boolean", "default": true }, "passwd": { "description": "The user password. The password must have at least 8 characters, one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*).", "type": "string", "example": "P@55w0rd" }, "displayName": { "description": "The user name.", "type": "string", "example": "joe" }, "newEmail": { "description": "User's email. Requires *administrator* permissions.", "properties": { "email": { "description": "The user email.", "type": "string", "example": "example@xxx.com" }, "isVerified": { "description": "If *true*, new email has been verified and can be updated in database.", "type": "boolean", "example": false } }, "required": [ "email", "isVerified" ], "type": "object" } }, "type": "object" }, "user_queries_data_format_type": { "description": "Query language.", "type": "string", "enum": [ "c8ql", "sql" ], "default": "c8ql", "example": "c8ql" }, "user_queries_import_custom_queries": { "properties": { "queries": { "description": "JSON documents embedded into a list.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Name for the query.", "type": "string", "example": "testQueryName" }, "value": { "description": "Value of the query.", "type": "string", "example": "for u in testCollection return u" }, "parameter": { "additionalProperties": {}, "description": "Query bind parameters as JSON Object.", "type": "object", "example": {} }, "type": { "$ref": "#/components/schemas/user_queries_data_format_type" } }, "required": [ "name", "value" ] } }, "details": { "description": "If *true* extra information for errors will be returned in the result.", "format": "boolean", "type": "boolean", "default": false } }, "type": "object" }, "import_query_error_details": { "properties": { "query": { "description": "The failed query object", "type": "object" }, "errorNumber": { "description": "The error code", "type": "integer", "example": 102022 }, "errorMessage": { "description": "The error message", "type": "string", "example": "The error message" } } }, "example_import_custom_query_200": { "properties": { "error": { "description": "Flag if there was an error (true) or not (false).\nIt is always true in this response.", "type": "boolean", "example": false }, "code": { "description": "The response code.", "type": "integer", "example": 200 }, "result": { "properties": { "created": { "description": "Number of queries which were successfully imported.", "type": "integer", "example": 10 }, "errors": { "description": "Number of queries which were failed to get imported.", "type": "integer", "example": 0 }, "details": { "properties": { "errors": { "description": "Array of failed queries along with the respective errors", "type": "array", "items": { "$ref": "#/components/schemas/import_query_error_details" } } } } } } } }, "user_queries_create_data_format": { "description": "Specify the query parameters.", "properties": { "name": { "description": "Name for the query.", "type": "string", "example": "workerName" }, "parameter": { "additionalProperties": {}, "description": "bindVars for the query.", "type": "object", "example": {} }, "value": { "description": "Value of the query.", "type": "string", "example": "for u in testCollection return u" }, "type": { "$ref": "#/components/schemas/user_queries_data_format_type" } }, "required": [ "name" ], "type": "object" }, "user_queries_create_user_queries": { "properties": { "query": { "$ref": "#/components/schemas/user_queries_create_data_format" } }, "type": "object" }, "user_queries_execute_saved_queries": { "properties": { "bindVars": { "additionalProperties": {}, "description": "Specify the bindVars of the query.", "type": "object", "example": {} }, "batchSize": { "description": "The maximum number of documents returned when fetching data from the query.", "format": "int64", "type": "integer", "default": 100, "maximum": 1000 } }, "type": "object" }, "user_queries_execute_user_query": { "properties": { "bindVars": { "additionalProperties": {}, "description": "Specify the bindVars of the query.", "type": "object" } }, "type": "object" }, "user_queries_update_data_format": { "description": "Specify the query parameters.", "properties": { "parameter": { "additionalProperties": {}, "description": "bindVars for the query.", "type": "object", "example": {} }, "value": { "description": "Value for the query.", "type": "string", "example": "for u in testCollection return u" }, "type": { "$ref": "#/components/schemas/user_queries_data_format_type" } }, "required": [ "value" ], "type": "object" }, "user_queries_update_user_queries": { "properties": { "query": { "$ref": "#/components/schemas/user_queries_update_data_format" } }, "type": "object" }, "edge_representation": { "description": "The edge document.", "properties": { "_id": { "description": "The _id value of the stored data.", "type": "string", "example": "edgeColltest020905135194uxprm/7050517" }, "_key": { "description": "The _key-value of the stored data.", "type": "string", "example": "7050517" }, "_rev": { "description": "The _rev value of the stored data.", "type": "string", "example": "_dsRmNZG--" }, "_from": { "description": "The _from value of the stored data.", "type": "string", "example": "colltest020905135195vdbps/bbbb" }, "_to": { "description": "The _to value of the stored data.", "type": "string", "example": "colltest020905135195vdbps/cccc" } }, "type": "object" }, "edge_representation_new": { "description": "The edge document.", "properties": { "_id": { "description": "The _id value of the stored data.", "type": "string", "example": "edgeColltest020905135194uxprm/7050517" }, "_key": { "description": "The _key-value of the stored data.", "type": "string", "example": "7050517" }, "_rev": { "description": "The _rev value of the stored data.", "type": "string", "example": "_dsRmNZG--" }, "_from": { "description": "The _from value of the stored data.", "type": "string", "example": "colltest020905135195vdbps/bbbb" }, "_to": { "description": "The _to value of the stored data.", "type": "string", "example": "colltest020905135195vdbps/eeee" } }, "type": "object" }, "event_create": { "properties": { "action": { "description": "The activity of the event (CREATE/UPDATE/DELETE/EXECUTE/LOGIN).", "type": "string", "example": "CREATE" }, "attributes": { "$ref": "#/components/schemas/event_attributes" }, "description": { "description": "Event description.", "type": "string", "example": "Test event" }, "details": { "description": "Additional activity info.", "type": "string", "example": "Error message" }, "entityName": { "description": "The entity name of the event.", "type": "string", "example": "Test" }, "entityType": { "description": "The entity type of the event (COLLECTION/GRAPH/CEP/AUTH/STREAM/GEOFABRIC).", "type": "string", "example": "COLLECTION" }, "status": { "description": "The activity status (OK/WARN/ERROR).", "type": "string", "example": "OK" } }, "required": [ "entityName" ], "type": "object" }, "explain_options": { "description": "Options for the query.", "properties": { "allPlans": { "description": "If set to *true*, all possible execution are returned. The default is *false*, meaning only the optimal plan is be returned.", "type": "boolean" }, "maxNumberOfPlans": { "description": "An optional maximum number of plans that the optimizer is allowed to generate. Setting this attribute to a low value allows to put a cap on the amount of work the optimizer does.", "format": "int64", "type": "integer" }, "optimizer.rules": { "description": "An array of to-be-included or to-be-excluded optimizer rules can be put into this attribute, telling the optimizer to include or exclude specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it with a `+`. There is also a pseudo-rule `all`, which matches all optimizer rules.", "format": "string", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "graph_create_http_examples": { "properties": { "edgeDefinitions": { "description": "An array of definitions for the relations of the graph. Each has the following type:", "items": { "$ref": "#/components/schemas/graph_edge_definition" }, "type": "array" }, "name": { "description": "Name of the graph.", "type": "string", "example": "exampleGraph" }, "options": { "$ref": "#/components/schemas/api_gharial_create_opts" } }, "required": [ "name" ], "type": "object" }, "graph_create_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_create_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_create_http_examples": { "properties": { "_from": { "description": "The source vertex of this edge. Has to be valid within the used edge definition.", "type": "string", "example": "sourceVertex" }, "_to": { "description": "The target vertex of this edge. Has to be valid within the used edge definition.", "type": "string", "example": "destinationVertex" } }, "required": [ "_from" ], "type": "object" }, "graph_edge_create_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean" }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" } }, "required": [ "error" ], "type": "object" }, "graph_edge_create_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_add_http_examples": { "properties": { "collection": { "description": "The name of the edge collection to be used.", "type": "string", "example": "edgeCollectionTest" }, "from": { "description": "One or many vertex collections that can contain source vertices.", "items": { "type": "string", "example": "sourceVertex" }, "type": "array" }, "to": { "description": "One or many vertex collections that can contain target vertices.", "items": { "type": "string", "example": "destinationVertex" }, "type": "array" } }, "required": [ "collection" ], "type": "object" }, "graph_edge_definition_add_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_add_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_modify_http_examples": { "properties": { "collection": { "description": "The name of the edge collection to be used.", "type": "string", "example": "edgeCollectionTest" }, "from": { "description": "One or many vertex collections that can contain source vertices.", "items": { "type": "string", "example": "sourceVertex" }, "type": "array" }, "to": { "description": "One or many vertex collections that can contain target vertices.", "items": { "type": "string", "example": "destinationVertex" }, "type": "array" } }, "required": [ "collection" ], "type": "object" }, "graph_edge_definition_modify_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_modify_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_remove_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_definition_remove_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_delete_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "old": { "$ref": "#/components/schemas/edge_representation" }, "removed": { "description": "Is set to *true* if the remove was successful.", "type": "boolean", "example": true } }, "required": [ "error" ], "type": "object" }, "graph_edge_delete_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "old": { "$ref": "#/components/schemas/edge_representation" }, "removed": { "description": "Is set to *true* if the remove was successful.", "type": "boolean", "example": true } }, "required": [ "error" ], "type": "object" }, "graph_edge_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_modify_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" }, "old": { "$ref": "#/components/schemas/edge_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_modify_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" }, "old": { "$ref": "#/components/schemas/edge_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_replace_http_examples": { "properties": { "_from": { "description": "The source vertex of this edge. Has to be valid within the used edge definition.", "type": "string", "example": "sourceVertex" }, "_to": { "description": "The target vertex of this edge. Has to be valid within the used edge definition.", "type": "string", "example": "destinationVertex" } }, "required": [ "_from" ], "type": "object" }, "graph_edge_replace_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" }, "old": { "$ref": "#/components/schemas/edge_representation" } }, "required": [ "error" ], "type": "object" }, "graph_edge_replace_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "edge": { "$ref": "#/components/schemas/edge_representation" }, "new": { "$ref": "#/components/schemas/edge_representation_new" }, "old": { "$ref": "#/components/schemas/edge_representation" } }, "required": [ "error" ], "type": "object" }, "graph_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_list_edge_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean" }, "collections": { "description": "The list of all vertex collections within this graph. Includes collections in edge definitions as well as orphans.", "items": { "type": "string", "example": "edgeCollectionTest" }, "type": "array" } }, "required": [ "error" ], "type": "object" }, "graph_list_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graphs": { "items": { "$ref": "#/components/schemas/graph_list" }, "type": "array" } }, "required": [ "error" ], "type": "object" }, "graph_list_vertex_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "collections": { "description": "The list of all vertex collections within this graph. Includes collections in edge definitions as well as orphans.", "items": { "type": "string", "example": "vertex1" }, "type": "array" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_collection_add_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_collection_add_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_collection_remove_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_collection_remove_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "graph": { "$ref": "#/components/schemas/graph_representation" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_create_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_create_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_delete_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "old": { "$ref": "#/components/schemas/example_id_key_rev" }, "removed": { "description": "*True* if the remove was successful.", "type": "boolean", "example": true } }, "required": [ "error" ], "type": "object" }, "graph_vertex_delete_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "old": { "$ref": "#/components/schemas/example_id_key_rev" }, "removed": { "description": "*True* if the remove was successful.", "type": "boolean", "example": true } }, "required": [ "error" ], "type": "object" }, "graph_vertex_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_get_http_examples_rc_304": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 304 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A message created for this error.", "type": "string", "example": "Error message" }, "errorNum": { "description": "Database error number for the error that occurred.", "type": "integer", "example": 581 } }, "required": [ "error" ], "type": "object" }, "graph_vertex_modify_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "old": { "$ref": "#/components/schemas/example_old_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_modify_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "old": { "$ref": "#/components/schemas/example_old_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_replace_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "old": { "$ref": "#/components/schemas/example_old_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "graph_vertex_replace_http_examples_rc_202": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "new": { "$ref": "#/components/schemas/example_id_key_rev" }, "old": { "$ref": "#/components/schemas/example_old_id_key_rev" }, "vertex": { "$ref": "#/components/schemas/example_id_key_rev" } }, "required": [ "error" ], "type": "object" }, "get_api_return_rc_200": { "properties": { "server": { "description": "Server type", "type": "string", "example": "C8DB" }, "license": { "description": "Licene", "type": "string", "example": "Macrometa" }, "version": { "description": "The server version string. The string has the format \"*major*.*minor*.*sub*\". *major* and *minor* are numeric, and *sub* may contain a number or a textual version.", "type": "string", "example": "99.15.0-release" } }, "required": [ "server" ], "type": "object" }, "graph_edge_definition": { "description": "An array of definitions for the relations of the graph.", "properties": { "collection": { "description": "Name of the edge collection, where the edge are stored in.", "type": "string", "example": "edgeName" }, "from": { "description": "List of vertex collection names.\nEdges in collection can only be inserted if their _from is in any of the collections here.", "format": "string", "items": { "type": "string", "example": "sourceNode" }, "type": "array" }, "to": { "description": "List of vertex collection names.\nEdges in collection can only be inserted if their _to is in any of the collections here.", "format": "string", "items": { "type": "string", "example": "destinationNode" }, "type": "array" } }, "type": "object" }, "graph_list": { "properties": { "graph": { "$ref": "#/components/schemas/graph_representation" } }, "type": "object" }, "graph_representation": { "description": "The information about the newly created graph.", "properties": { "_id": { "description": "The internal id value of this graph.", "type": "string", "example": "_graphs/graph1" }, "_key": { "description": "The key of this graph.", "type": "string", "example": "graph1" }, "_rev": { "description": "The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.", "type": "string", "example": "_drxzsai--_" }, "edgedefinitions": { "description": "An array of definitions for the relations of the graph.", "format": "graph_edge_definition", "items": { "$ref": "#/components/schemas/graph_edge_definition" }, "type": "array" }, "name": { "description": "The name of the graph.", "type": "string", "example": "graph1" }, "orphanCollections": { "description": "An array of additional vertex collections. Documents within these collections do not have edges within this graph.", "format": "string", "items": { "type": "string", "example": "emptyNode" }, "type": "array" } }, "type": "object" }, "key_generator_type": { "description": "A object which contains key generation options.", "properties": { "allowUserKeys": { "description": "If set to *true*, it is allowed to supply it's own key-values in the *_key* attribute of a document. If set to *false*, the key generator is solely responsible for generating keys and supplying own key-values in the *_key* attribute of documents is considered an error.", "type": "boolean" }, "lastValue": { "type": "integer" }, "type": { "description": "Specifies the type of the key generator. The currently available generators are *traditional*, *autoincrement*, *uuid* and *padded*.", "type": "string" } }, "type": "object" }, "api_analyzer": { "properties": { "features": { "description": "The set of features to set on the analyzer generated fields.\nThe default value is an empty array.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The analyzer name.", "type": "string" }, "properties": { "description": "The properties used to configure the specified type.\nValue may be a string, an object or null.\nThe default value is *null*.", "type": "string" }, "type": { "description": "The analyzer type.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "collection_stream": { "properties": { "hasStream": { "description": "If *true*, create a local stream associated with collection.\nLocal stream associated with collection cannot be deleted.", "type": "boolean" }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean" } }, "required": [ "hasStream" ], "type": "object" }, "api_cursor": { "properties": { "batchSize": { "description": "Sets the batch size of queries. This batch size decides how many results are returned as part of query output. If this option is not specified, default value is used. Maximum allowed for this parameter is *1000*.", "format": "int64", "type": "integer", "default": 100 }, "bindVars": { "additionalProperties": {}, "description": "Key/value pairs representing the bind parameters.", "type": "object" }, "count": { "description": "Indicates whether the number of documents in the result set should be returned in the \"count\" attribute of the result. Calculating the \"count\" attribute might have a performance impact for some queries in the future so this option is turned off by default, and \"count\" is only returned when requested.", "type": "boolean", "example": false }, "options": { "$ref": "#/components/schemas/api_cursor_opts" }, "query": { "description": "Contains the query string to be run.", "type": "string", "example": "for u in testCollection return u" }, "ttl": { "description": "The amount of time for which the cursor is valid. The maximum value which can be specified, can be determined using *GET /_api/limits/default* API", "format": "int64", "type": "integer", "default": 30 } }, "required": [ "query" ], "type": "object" }, "api_cursor_opts": { "description": "Key/value object with extra options for the query.", "properties": { "failOnWarning": { "description": "When set to *true*, the query throws an exception and abort instead of producing a warning. This option should be used during development to catch potential issues early. When the attribute is set to *false*, warnings are not propagated to exceptions and are returned with the query result.", "type": "boolean" }, "fullCount": { "description": "If set to *true* and the query contains a *LIMIT* clause, the result has an *extra* attribute with the sub-attributes *stats* and *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`. The *fullCount* attribute contains the number of documents in the result before the last top-level LIMIT in the query is applied. It can be used to count the number of documents that match certain filter criteria, but only return a subset of them, in one go. It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option disables a few LIMIT optimizations and may lead to more documents being processed and thus make queries run longer. Note that the *fullCount* attribute may only be present in the result if the query has a top-level LIMIT clause and the LIMIT clause is actually used in the query.", "type": "boolean" }, "intermediateCommitCount": { "description": "Maximum number of operations after which an intermediate commit is performed automatically. **Note:** Use this option cautiously. The transactions are commited after every specific record count. In case of error, already commited records are not rolled back.", "format": "int64", "type": "integer" }, "intermediateCommitSize": { "description": "Maximum total size of operations after which an intermediate commit is performed automatically. **Note:** Use this option cautiously. The transactions are commited after every specific query memory size. In case of error, already commited records are not rolled back.", "format": "int64", "type": "integer" }, "maxTransactionSize": { "description": "Transaction size limit in bytes.", "format": "int64", "type": "integer" }, "maxWarningCount": { "description": "Limits the maximum number of warnings returned by a query.", "format": "int64", "type": "integer", "default": 10 }, "profile": { "description": "If set to *true* or *1*, the additional query profiling information is returned in the sub-attribute *profile* of the *extra* return attribute, if the query result is not served from the query cache. If set to *2* the query includes execution stats per query plan node in sub-attribute *stats.nodes* of the *extra* return attribute. Additionally the query plan is returned in the sub-attribute *extra.plan*.", "type": "integer" }, "skipInaccessibleCollections": { "description": "C8QL queries (especially graph traversals) treat collections to which a user has no access rights as if these collections were empty. Instead of returning a forbidden access error, your query runs normally.", "type": "boolean" }, "stream": { "description": "Specify *true* and the query runs as a **stream**. The query result is not stored on the server, but calculated on the fly. *Warnnig*: long-running queries need to hold the collection locks for as long as the query cursor exists. When set to *false* a query is run right away in its entirety. In that case query results are either returned right away (if the result set is small enough), or stored on the database instance and accessible via the cursor API (with respect to the `ttl`).\n\nIt is advisable to *only* use this option on short-running queries or without exclusive locks. Query statistics, warnings and profiling data is only available after the query is finished.", "type": "boolean", "default": false }, "optimizer.rules": { "description": "An array of to-be-included or to-be-excluded optimizer rules can be put into this attribute, telling the optimizer to include or exclude specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it with a `+`. There is also a pseudo-rule `all`, which matches all optimizer rules.", "format": "string", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "api_cursor_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "format": "integer", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "count": { "description": "Total number of result documents available if the *count* attribute was used.", "format": "int64", "type": "integer", "example": 1 }, "extra": { "description": "(Optional) A JSON object with extra information about the query result contained in the *stats* sub-attribute. For data-modification queries, the *extra.stats* sub-attribute contains the number of modified documents. If the *ignoreErrors* query option was specified, *extra.stats* also includes the number of documents that could not be modified due to an error.", "type": "object", "example": { "stats": { "writesExecuted": 0, "writesIgnored": 0, "scannedFull": 7, "scannedIndex": 0, "filtered": 0, "httpRequests": 0, "executionTime": 0.0006868839263916016, "peakMemoryUsage": 18396 }, "warnings": [] } }, "hasMore": { "description": "*True* indicates there are more results available for the cursor on the server. *False* indicates there are no more results available.", "type": "boolean", "example": false }, "id": { "description": "(Optional) ID of temporary cursor created on the server.", "type": "string", "example": "11176313" }, "cached": { "description": "*True* indicates results are cached. *False* indicates results are not cached.", "type": "boolean", "example": false }, "result": { "description": "An array of result documents (might be empty if query has no results).", "type": "array", "example": [ { "_id": "xxx/8753330", "_key": "8753330", "_rev": "_dpDmoaa--_", "item1": "data2" } ], "items": {} } }, "required": [ "error" ] }, "api_cursor_rc_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "format": "integer", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "count": { "description": "The total number of result documents available (only available if the query is run with the *count* attribute set)", "format": "int64", "type": "integer", "example": 1 }, "extra": { "description": "(Optional) A JSON object with extra information about the query result contained in the *stats* sub-attribute. For data-modification queries, the *extra.stats* sub-attribute contains the number of modified documents. If the *ignoreErrors* query option is specified, *extra.stats* also includes the number of documents that could not be modified due to an error.", "type": "object", "example": { "stats": { "writesExecuted": 0, "writesIgnored": 0, "scannedFull": 7, "scannedIndex": 0, "filtered": 0, "httpRequests": 0, "executionTime": 0.0006868839263916016, "peakMemoryUsage": 18396 }, "warnings": [] } }, "hasMore": { "description": "*True* indicates there are more results available for the cursor on the server. *False* indicates there are no more results available.", "type": "boolean", "example": false }, "id": { "description": "(Optional) ID of temporary cursor created on the server.", "type": "string", "example": "11176313" }, "cached": { "description": "A boolean flag indicating whether the query result is served from the query cache or not. If the query result is served from the query cache, the extra return attribute does not contain any stats sub-attribute and no profile sub-attribute.", "type": "boolean", "example": false }, "result": { "description": "An array of result documents (might be empty if query has no results).", "type": "array", "example": [ { "_id": "xxx/8753330", "_key": "8753330", "_rev": "_dpDmoaa--_", "item1": "data2" } ], "items": {} } }, "required": [ "error" ] }, "api_cursor_rc_400": { "description": "The JSON representation is malformed.", "properties": { "code": { "description": "HTTP response code.", "format": "int64", "type": "integer", "example": 400 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A descriptive error message. If the query specification is complete, the server processes the query. If an error occurs during query processing, the server returns a *HTTP 400* error with details in the response body.", "type": "string", "example": "error message" }, "errorNum": { "description": "The server error number.", "format": "int64", "type": "integer", "example": 58322 } }, "required": [ "error" ], "type": "object" }, "api_cursor_rc_404": { "properties": { "code": { "description": "HTTP response code.", "format": "int64", "type": "integer", "example": 404 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "errorMessage": { "description": "A descriptive error message", "type": "string", "example": "error message" }, "errorNum": { "description": "The server error number.", "format": "int64", "type": "integer", "example": 58322 } }, "required": [ "error" ], "type": "object" }, "sql_api_cursor": { "properties": { "batchSize": { "description": "Sets the batch size of queries. This batch size decides how many results are returned as part of query output.", "format": "int64", "type": "integer", "default": 100, "maximum": 1000 }, "bindVars": { "description": "Key/value pairs representing the bind parameters.", "type": "object" }, "count": { "description": "Indicates whether the number of documents in the result set should be returned in the \"count\" attribute of the result. Calculating the \"count\" attribute might have a performance impact for some queries in the future, so this option is turned off by default, and \"count\" is only returned when requested.", "type": "boolean", "example": false, "default": false }, "query": { "description": "Query to run.", "type": "string", "example": "SELECT name FROM users" }, "ttl": { "description": "The cursor is automatically removed from the server after the specified amount of time. This is useful to ensure garbage collection of cursors that are not fully fetched by clients.", "format": "int64", "type": "integer", "default": 30 } }, "required": [ "query" ], "type": "object" }, "api_explain": { "properties": { "bindVars": { "description": "Key/value pairs representing the bind parameters.", "items": { "type": "object" }, "type": "array" }, "options": { "$ref": "#/components/schemas/explain_options" }, "query": { "description": "The query which you want explained. If the query references any bind variables, these must also be passed in the attribute *bindVars*. Additional options for the query can be passed in the *options* attribute.", "type": "string" } }, "required": [ "query" ], "type": "object", "example": "for u in testCollection return u" }, "api_export": { "properties": { "bindVars": { "additionalProperties": {}, "description": "Key-value pairs representing the bind parameters. Optional if bind parameters are not used in query.", "type": "object", "example": {} }, "query": { "description": "C8QL query. Default: returns all documents.", "format": "string", "type": "string", "default": "for u in testCollection return u" } }, "type": "object" }, "api_import": { "properties": { "data": { "description": "An array of JSON documents. Each document is interpreted separately. If the `primaryKey` property (see below) is not set or equals `auto`, then the `_key` attribute values of the documents must be strings. The maximum number of documents that can be imported is limited by the `Max Documents Imported Per API Call` limit.", "type": "array", "items": { "type": "object", "example": { "_key": "1634556", "name": "test1" } } }, "details": { "description": "If *true* extra information for errors and unprocessed documents are returned in the result.", "format": "boolean", "type": "boolean", "default": false }, "primaryKey": { "description": "If used, this attribute becomes the *_key* for the new document. If the values in the attribute are not strings, they are convert to strings before import. Any existing *_key* value is renamed to *old_key*. Use the following naming convention: https://macrometa.dev/documents/naming-conventions/#document-keys", "format": "string", "type": "string", "default": "name" }, "replace": { "description": "If *true*, existing document having same *_key* in the colletion, shall be replaced.", "format": "boolean", "type": "boolean", "default": false } }, "type": "object" }, "api_gharial_create_opts": { "description": "A JSON object to define options for creating collections within this graph.\nIt can contain the following attributes:", "type": "object" }, "api_index_fulltext": { "properties": { "fields": { "description": "An array of attribute names. Currently, the array is limited to exactly one attribute.", "items": { "type": "string" }, "type": "array" }, "minLength": { "description": "Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.", "format": "int64", "type": "integer" }, "type": { "description": "Must be equal to *\"fulltext\"*.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "api_index_geo": { "properties": { "fields": { "description": "An array with one or two attribute paths.\n\nIf it is an array with one attribute path *location*, a geo-spatial index on all documents is created using *location* as path to the coordinates. The value of the attribute must be an array with at least two double values. The array must contain the latitude (first value) and the longitude (second value). All documents, that do not have the attribute path or with value that are not suitable, are ignored.\n\nIf it is an array with two attribute paths *latitude* and *longitude*, a geo-spatial index on all documents is created using *latitude* and *longitude* as paths the latitude and the longitude. The value of the attribute *latitude* and of the attribute *longitude* must a double.\n\nNote: All documents, that do not have the attribute paths or which values are not suitable, are ignored. If it is an array with two attribute paths *latitude* and *longitude*, a geo-spatial index on all documents is created using *latitude* and *longitude* as paths the latitude and the longitude. The value of the attribute *latitude* and *longitude* must be a double. All documents that do not have the attribute paths or which values are not suitable are ignored.", "items": { "type": "string" }, "type": "array" }, "geoJson": { "description": "If a geo-spatial index on a *location* is constructed and *geoJson* is *true*, the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions.", "type": "string" }, "type": { "description": "Must be equal to *\"geo\"*.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "api_index_hash": { "properties": { "deduplicate": { "description": "If *false*, the deduplication of array values is turned off.", "format": "boolean", "type": "boolean" }, "fields": { "description": "An array of attribute paths.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "sparse": { "description": "*True* to create a sparse index.", "type": "boolean", "example": true }, "type": { "description": "Must be equal to *\"hash\"*.", "type": "string", "example": "hash" }, "unique": { "description": "*True* to create a unique index.", "type": "boolean", "example": true } }, "required": [ "type" ], "type": "object" }, "api_index_persistent": { "properties": { "fields": { "description": "An array of attribute paths.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "sparse": { "description": "*True* to create a sparse index.", "type": "boolean", "example": true }, "type": { "description": "Must be equal to *\"persistent\"*.", "type": "string", "example": "persistent" }, "unique": { "description": "*True* to create a unique index.", "type": "boolean", "example": true }, "deduplicate": { "description": "Controls whether inserting duplicate index values from the same document into a unique array index leads to a unique constraint error or not.", "type": "boolean", "default": true } }, "required": [ "type" ], "type": "object" }, "api_index_skiplist": { "properties": { "deduplicate": { "description": "If *false*, the deduplication of array values is turned off.", "type": "boolean", "example": false }, "fields": { "description": "An array of attribute paths.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "sparse": { "description": "*True* to create a sparse index.", "type": "boolean", "example": true }, "type": { "description": "Must be equal to *\"skiplist\"*.", "type": "string", "example": "skiplist" }, "unique": { "description": "*True* to create a unique index.", "type": "boolean", "example": true } }, "required": [ "type" ], "type": "object" }, "api_index_ttl": { "properties": { "expireAfter": { "description": "The time (in seconds) after a document's creation after which the documents count as \"expired\".", "type": "number", "example": 3600 }, "fields": { "description": "An array with exactly one attribute path.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "type": { "description": "Must be equal to *\"ttl\"*.", "type": "string", "example": "ttl" } }, "required": [ "type" ], "type": "object" }, "post_metrics_query": { "properties": { "GeoFabric": { "description": "GeoFabric name", "type": "string", "example": "_system" }, "limit": { "description": "Number of results we want to receive.", "type": "integer", "example": 10 }, "metrics": { "description": "Array of strings containing the metric names we want to receive.", "items": { "type": "string", "example": "c8cep_app_cpu_tenant_total" }, "type": "array" }, "querytype": { "description": "- *list*: Returns a list of all available metrics\n- *get*: Returns all the requested metrics\n- *sum*: Returns sum of all records for each of the requested metrics.", "type": "string", "example": "list" }, "since": { "description": "Unix timestamp in milliseconds of oldest entry we want to receive.", "type": "integer", "example": 1646157317 } }, "required": [ "querytype" ], "type": "object" }, "setof_statistics_struct": { "description": "Total connection times the system time the request times the time requests were queued waiting for processing\n\nIO Time\n\nnumber of bytes sent to the clients\n\nnumber of bytes received from the clients.", "properties": { "count": { "description": "Number of values summarized.", "type": "integer" }, "counts": { "description": "Array containing the values.", "format": "integer", "items": { "type": "integer" }, "type": "array" }, "sum": { "description": "Summarized value of all counts.", "type": "number" } }, "type": "object" }, "system_statistics_struct": { "description": "Metrics gathered from the system about this process; may depend on the host OS.", "properties": { "majorPageFaults": { "description": "Page faults", "type": "integer" }, "minorPageFaults": { "description": "Page faults", "type": "integer" }, "numberOfThreads": { "description": "The number of threads in the server.", "type": "integer" }, "residentSize": { "description": "RSS of process", "type": "integer" }, "residentSizePercent": { "description": "RSS of process as a percentage", "format": "float", "type": "number" }, "systemTime": { "description": "The system CPU time used by the server process.", "format": "float", "type": "number" }, "userTime": { "description": "The user CPU time used by the server process.", "format": "float", "type": "number" }, "virtualSize": { "description": "VSS of the process.", "type": "integer" } }, "type": "object" }, "v8_context_struct": { "description": "Statistics about the V8 javascript contexts.", "properties": { "available": { "description": "The number of currently spawned V8 contexts.", "type": "integer" }, "busy": { "description": "The number of currently active V8 contexts.", "type": "integer" }, "dirty": { "description": "The number of contexts that were previously used, and should now be garbage collected before being re-used.", "type": "integer" }, "free": { "description": "The number of V8 contexts that are free to use.", "type": "integer" }, "max": { "description": "The total number of V8 contexts we may spawn as configured by --javascript.v8-contexts.", "type": "integer" }, "memory": { "description": "A list of V8 memory / garbage collection watermarks; Refreshed on every garbage collection run;\nPreserves min/max memory used at that time for 10 seconds.", "format": "v8_isolate_memory", "items": { "$ref": "#/components/schemas/v8_isolate_memory" }, "type": "array" } }, "type": "object" }, "v8_isolate_memory": { "properties": { "contextId": { "description": "ID of the context this set of memory statistics is from.", "type": "integer" }, "countOfTimes": { "description": "How many times was the garbage collection run in these 10 seconds.", "type": "integer" }, "heapMax": { "description": "High watermark of all garbage collection runs in 10 seconds.", "type": "integer" }, "heapMin": { "description": "Low watermark of all garbage collection runs in these 10 seconds.", "type": "integer" }, "tMax": { "description": "The timestamp where the 10 seconds interval started.", "type": "number" } }, "type": "object" }, "error_response": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "stream_app_validate_request": { "type": "object", "properties": { "definition": { "type": "string" } } }, "stream_app_response": { "type": "object", "properties": { "name": { "type": "string", "example": "stream_app1" }, "definition": { "type": "string" }, "regions": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "example": "region1" }, "isActive": { "type": "boolean", "example": false } } }, "stream_app_response_container": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "streamApps": { "type": "array", "items": { "$ref": "#/components/schemas/stream_app_response" } } } }, "stream_app_response_container_201": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "streamApps": { "type": "array", "items": { "$ref": "#/components/schemas/stream_app_response" } } } }, "get_all_sample_stream_apps_response": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "streamAppSamples": { "type": "array", "items": { "$ref": "#/components/schemas/sample_stream_app_information" } } } }, "sample_stream_app_information": { "type": "object", "properties": { "name": { "type": "string", "example": "stream_app1" }, "definition": { "type": "string" }, "description": { "type": "string" } } }, "get_all_stream_apps_response": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "streamApps": { "type": "array", "items": { "$ref": "#/components/schemas/stream_app_information" } } } }, "stream_app_information": { "type": "object", "properties": { "name": { "type": "string", "example": "stream_app1" }, "definition": { "type": "string" }, "regions": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "example": "region1" }, "isActive": { "type": "boolean", "example": false } } }, "stream_app_request": { "type": "object", "properties": { "definition": { "type": "string" }, "regions": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } } }, "stream_app_query_response": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } } } }, "stream_app_query_request": { "type": "object", "properties": { "query": { "type": "string", "example": "for d in testCollection return d" } } }, "stream_app_http_source_request": { "type": "object", "properties": { "param1": { "type": "string", "example": "string" } } }, "Account_Create": { "properties": { "tenant": { "description": "Tenant", "format": "string", "type": "string" }, "plan": { "description": "Plan types.", "format": "string", "type": "object", "properties": { "name": { "description": "Plan name.", "format": "string", "type": "string" }, "demo": { "description": "If billing plan is demo, set `true`. Else set `false`.", "format": "boolean", "type": "boolean" } } }, "contact": { "properties": { "firstname": { "description": "First Name", "format": "string", "type": "string" }, "lastname": { "description": "Last Name", "format": "string", "type": "string" }, "email": { "description": "Email id", "format": "string", "type": "string" }, "phone": { "description": "Phone number", "format": "string", "type": "string" }, "line1": { "description": "Address line 1", "format": "string", "type": "string" }, "line2": { "description": "Address line 2", "format": "string", "type": "string" }, "city": { "description": "City", "format": "string", "type": "string" }, "state": { "description": "State", "format": "string", "type": "string" }, "country": { "description": "Two-letter country code (ISO 3166-1 alpha-2).", "format": "string", "type": "string" }, "zipcode": { "description": "Zip code", "format": "string", "type": "string" } } } }, "required": [ "tenant" ], "type": "object" }, "Contact_Update": { "properties": { "firstname": { "description": "First Name", "type": "string", "example": "John" }, "lastname": { "description": "Last Name", "type": "string", "example": "Doe" }, "email": { "description": "Email address", "type": "string", "example": "john@acme.com" }, "phone": { "description": "Phone number", "type": "string", "example": "404-555-8726" }, "line1": { "description": "Address line 1", "type": "string", "example": "1388 Villa Drive" }, "line2": { "description": "Address line 2", "type": "string", "example": "Suite 240C" }, "city": { "description": "City", "type": "string", "example": "South Bend" }, "state": { "description": "State", "type": "string", "example": "IN" }, "country": { "description": "Two-letter country code (ISO 3166-1 alpha-2).", "type": "string", "example": "US" }, "zipcode": { "description": "Zip code", "type": "string", "example": "46601" } }, "type": "object" }, "Payment_Update": { "properties": { "payment_method_id": { "description": "Payment Method ID", "format": "string", "type": "string" } } }, "stripe_200_invoice_month_year": { "properties": { "id": { "type": "string", "example": "ID" }, "object": { "type": "string", "example": "invoice" }, "account_country": { "type": "string", "example": "US" }, "account_name": { "type": "string", "example": "Stripe.com" }, "account_tax_ids": { "type": "object", "example": null }, "amount_due": { "type": "integer", "example": 40298 }, "amount_paid": { "type": "integer", "example": 0 }, "amount_remaining": { "type": "integer", "example": 40298 } } }, "stripe_200_invoice_upcoming": { "properties": { "object": { "type": "string", "example": "invoice" }, "account_country": { "type": "string", "example": "US" }, "account_name": { "type": "string", "example": "Stripe.com" }, "account_tax_ids": { "type": "object", "example": null }, "amount_due": { "type": "integer", "example": 40298 }, "amount_paid": { "type": "integer", "example": 0 }, "amount_remaining": { "type": "integer", "example": 40298 } } }, "stripe_200_invoice_list": { "properties": { "object": { "type": "string", "example": "list" }, "url": { "type": "string", "example": "/v1/payment_intents" }, "has_more": { "type": "boolean", "example": false }, "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "pi_1DpxME2eZvKYlo2CdLPnXZPO" }, "object": { "type": "string", "example": "invoice" }, "account_country": { "type": "string", "example": "US" }, "account_name": { "type": "string", "example": "Stripe.com" }, "account_tax_ids": { "type": "object", "example": null }, "amount_due": { "type": "integer", "example": 498 }, "amount_paid": { "type": "integer", "example": 0 }, "amount_remaining": { "type": "integer", "example": 498 } } } } } }, "stripe_200_intent_list": { "properties": { "object": { "type": "string", "example": "list" }, "url": { "type": "string", "example": "/v1/payment_intents" }, "has_more": { "type": "boolean", "example": false }, "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "pi_1DpxME2eZvKYlo2CdLPnXZPO" }, "object": { "type": "string", "example": "payment_intent" }, "amount": { "type": "integer", "example": 1099 } } } } } }, "Response_Billing_Code_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "message": { "description": "Message from server", "type": "string" } } }, "Response_Billing_Code_400": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 400 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean" }, "message": { "description": "Message from server", "type": "string" } } }, "Response_Billing_Account_Get": { "properties": { "code": { "type": "number", "example": "200" }, "error": { "type": "boolean", "example": false }, "data": { "type": "object", "properties": { "created_at": { "type": "string", "example": "Timestamp when account was created." }, "plan": { "type": "object", "properties": { "attribution": { "description": "Attribution of the plan", "type": "string", "example": "Macrometa" }, "name": { "description": "Name of the plan", "type": "string", "example": "PlanName" }, "subscription": { "description": "List of the subscription ID of the plan", "type": "object" }, "target": { "description": "Target where billing data is uploaded. E.g. Stripe, AWS S3.", "type": "string", "example": "Macrometa" } } }, "subscription_id": { "description": "If target is Stripe, subscription ID is returned by Stripe. If not, it's empty", "type": "string", "example": "sub_" }, "customer_id": { "description": "If target is Stripe, customer ID is returned by Stripe. If not, it's empty", "type": "string", "example": "cus_" }, "contact": { "type": "object", "properties": { "firstname": { "type": "string", "example": "First name of the user." }, "lastname": { "type": "string", "example": "Last name of the user." }, "email": { "type": "string", "example": "Email address of the user." }, "phone": { "type": "string", "example": "Phone number of the user." }, "line1": { "type": "string", "example": "Address line 1." }, "line2": { "type": "string", "example": "Address line 2." }, "city": { "type": "string", "example": "Address city." }, "state": { "type": "string", "example": "Address state." }, "country": { "type": "string", "example": "Address country." }, "zipcode": { "type": "string", "example": "Address zip code." } } } } } } }, "Response_Usage_Get": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "data": { "description": "Message from server", "type": "array", "items": { "type": "object", "properties": { "_key": { "type": "string", "example": "key" }, "tenant": { "type": "string", "example": "tenant1" }, "from": { "description": "The date from where usage is tracked", "type": "integer", "example": "2022-12-01" }, "to": { "description": "The date to which usage is tracked", "type": "integer", "example": "2022-12-31" }, "region": { "type": "string", "example": "region1" }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "integer" }, "value": { "type": "string" } } } } } } } } }, "response_missing_usage_record_get": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. _False_ for this response.", "type": "boolean", "example": false }, "data": { "description": "List of missing billing usage records for all tenants.", "type": "array", "items": { "type": "object", "properties": { "tenantxyz": { "type": "object", "properties": { "_usageDaily": { "type": "object", "properties": { "missingRecords": { "type": "array", "items": { "type": "string", "example": "services-ap-west_tenantxyz-22062022T2359" } } } }, "_usageDailyAggregated": { "type": "object", "properties": { "missingRecords": { "type": "array", "items": { "type": "string", "example": "tenantxyz-22062022T2359" } } } } } } } } } } }, "billing_hourly_usage_create": { "properties": { "tenant": { "description": "(Optional) The ID of the tenant.", "format": "string", "type": "string", "example": "Test" }, "overwrite": { "description": "(Optional) Overwrite existing hourly usage data.", "default": false, "type": "boolean" } }, "type": "object" }, "billing_usage_create": { "properties": { "tenant": { "description": "(Optional) The ID of the tenant.", "format": "string", "type": "string", "example": "Test" }, "start": { "description": "Start date-time in 'YYYY-MM-DD HH:MM:SS' format.", "format": "string", "type": "string", "example": "2022-05-01 00:00:00" }, "end": { "description": "End date-time in 'YYYY-MM-DD HH:MM:SS' format.", "format": "string", "type": "string", "example": "2022-05-03 00:00:00" }, "overwrite": { "description": "(Optional) Overwrite existing usage data.", "default": false, "type": "boolean" } }, "type": "object" }, "federation_member_peerip": { "properties": { "peer": { "description": "Hostname of the peer cluster that needs to be added to the federation.", "type": "string", "example": "192.168.251.192" } } }, "search_get_view_rc_200_example": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Search view information", "type": "object", "properties": { "globallyUniqueId": { "description": "Unique identifier of the collection", "type": "string", "example": "h83A7584E8AA9/81730851" }, "id": { "description": "Unique identifier of the search view", "type": "string", "example": "81730851" }, "name": { "description": "Name of the search view", "type": "string", "example": "c8search_view_server_list" }, "type": { "description": "*search* as type of search view", "type": "string", "example": "search" } } } } }, "search_get_view_properties_rc_200_example": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Search view information", "type": "object", "properties": { "globallyUniqueId": { "description": "Global unique identifier (GUID) of the semantic search view.", "type": "string", "example": "h83A7584E8AA9/81730851" }, "id": { "description": "Unique identifier of the search view.", "type": "string", "example": "81730851" }, "name": { "description": "The name of the search view. This field is immutable.", "type": "string", "example": "new_collection_view" }, "primarySort": { "description": "Specify default sorting order. This field is immutable.", "type": "array", "items": { "type": "object", "properties": { "field": { "description": "The name of the field.", "type": "string", "example": "attribute1" }, "direction": { "description": "The sorting direction.", "type": "string", "example": "asc" } }, "default": {} }, "default": [] }, "links": { "$ref": "#/components/schemas/post_api_view_links" }, "type": { "description": "The type of the search view. Must be equal to *search*.", "type": "string", "default": "search" } } } } }, "search_get_semantic_view_properties_rc_200_example": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Semantic search view information", "type": "object", "properties": { "globallyUniqueId": { "description": "Global Unique identifier of the semantic search view.", "type": "string", "example": "h83A7584E8AA9/81730851" }, "id": { "description": "Unique identifier of the semantic search view.", "type": "string", "example": "81730851" }, "name": { "description": "The name of the semantic search view. This field is immutable.", "type": "string", "example": "new_collection_view" }, "links": { "$ref": "#/components/schemas/post_api_view_link_semantic_props" }, "type": { "description": "The type of the search view. Must be equal to *semantic_search*.", "type": "string", "default": "semantic_search" } } } } }, "Concurrency": { "properties": { "limit": { "minimum": 0, "type": "number" }, "target": { "minimum": 0, "type": "number" }, "utilization": { "minimum": 0, "type": "number" } }, "required": [ "limit", "target", "utilization" ], "type": "object" }, "CreateConfigmapDto": { "properties": { "fromEnvFile": { "items": { "type": "string" }, "type": "array" }, "fromFile": { "items": { "type": "string" }, "type": "array" }, "fromLiteral": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "regions" ], "type": "object" }, "CreateNamespaceDto": { "properties": { "annotations": { "type": "object" }, "labels": { "type": "object" }, "limits": { "$ref": "#/components/schemas/Limits" }, "regions": { "items": { "type": "string" }, "type": "array" }, "requests": { "$ref": "#/components/schemas/Limits" }, "tenant": { "type": "string" } }, "required": [ "tenant", "regions", "annotations", "labels", "limits", "requests" ], "type": "object" }, "CreateRegistrySecretDto": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "regions": { "items": { "type": "string" }, "type": "array" }, "server": { "type": "string" }, "username": { "type": "string" } }, "required": [ "regions", "name", "server", "email", "username", "password" ], "type": "object" }, "CreateServiceDto": { "properties": { "annotationRevision": { "items": { "type": "string" }, "type": "array" }, "annotationService": { "items": { "type": "string" }, "type": "array" }, "annotations": { "items": { "type": "string" }, "type": "array" }, "args": { "items": { "type": "string", "example": "location" }, "type": "array" }, "autoscaleWindow": { "type": "string" }, "cmd": { "type": "string" }, "concurrency": { "$ref": "#/components/schemas/Concurrency" }, "env": { "items": { "type": "string", "example": "_key" }, "type": "array" }, "envFrom": { "items": { "type": "string" }, "type": "array" }, "force": { "type": "boolean" }, "image": { "type": "string" }, "labelRevision": { "items": { "type": "string", "example": "hashKey" }, "type": "array" }, "labelService": { "items": { "type": "string" }, "type": "array" }, "labels": { "items": { "type": "string" }, "type": "array" }, "limits": { "$ref": "#/components/schemas/Limits" }, "lockToDigest": { "type": "boolean" }, "mount": { "items": { "type": "string", "example": "id" }, "type": "array" }, "port": { "maximum": 65535, "type": "number" }, "pullSecret": { "type": "string" }, "regions": { "items": { "type": "string", "example": "_key" }, "type": "array" }, "requests": { "$ref": "#/components/schemas/Limits" }, "revision": { "type": "string" }, "scale": { "$ref": "#/components/schemas/Scale" }, "service": { "type": "string" } }, "required": [ "service", "image" ], "type": "object" }, "Limits": { "properties": { "cpu": { "type": "number" }, "memory": { "type": "number" } }, "required": [ "cpu", "memory" ], "type": "object" }, "Scale": { "properties": { "init": { "minimum": 0, "type": "number" }, "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" } }, "required": [ "init", "min", "max" ], "type": "object" }, "UpdateConfigmapDto": { "properties": { "fromEnvFile": { "items": { "type": "string" }, "type": "array" }, "fromFile": { "items": { "type": "string" }, "type": "array" }, "fromLiteral": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "regions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "UpdateNamespaceDto": { "properties": { "annotations": { "type": "object" }, "labels": { "type": "object" }, "limits": { "$ref": "#/components/schemas/Limits" }, "regions": { "items": { "type": "string" }, "type": "array" }, "requests": { "$ref": "#/components/schemas/Limits" } }, "type": "object" }, "UpdateServiceDto": { "properties": { "annotationRevision": { "items": { "type": "string" }, "type": "array" }, "annotationService": { "items": { "type": "string" }, "type": "array" }, "annotations": { "items": { "type": "string" }, "type": "array" }, "args": { "items": { "type": "string" }, "type": "array" }, "autoscaleWindow": { "type": "string" }, "cmd": { "type": "string" }, "concurrency": { "$ref": "#/components/schemas/Concurrency" }, "env": { "items": { "type": "string" }, "type": "array" }, "envFrom": { "items": { "type": "string", "example": "c8cep_app_cpu_tenant_total" }, "type": "array" }, "force": { "type": "boolean" }, "image": { "type": "string" }, "labelRevision": { "items": { "type": "string" }, "type": "array" }, "labelService": { "items": { "type": "string" }, "type": "array" }, "labels": { "items": { "type": "string" }, "type": "array" }, "limits": { "$ref": "#/components/schemas/Limits" }, "lockToDigest": { "type": "boolean" }, "mount": { "items": { "type": "string" }, "type": "array" }, "port": { "maximum": 65535, "type": "number" }, "pullSecret": { "type": "string" }, "regions": { "items": { "type": "string" }, "type": "array" }, "requests": { "$ref": "#/components/schemas/Limits" }, "revision": { "type": "string" }, "scale": { "$ref": "#/components/schemas/Scale" }, "tag": { "items": { "type": "string" }, "type": "array" }, "traffic": { "items": { "type": "string" }, "type": "array" }, "untag": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "stream_error_response": { "type": "object", "description": "Stream error response", "properties": { "reason": { "example": "error message" } } }, "dns_info_response": { "properties": { "global_url": { "type": "string", "description": "The global URL for the tenant and fabric pair.", "example": "global-url.mydomain.io" }, "regional_urls": { "type": "object", "description": "Populates the regional URLs.", "properties": { "region-name-1": { "type": "string", "description": "The regional URL for the tenant and fabric pair for data center 1.", "example": "regional-url-1.mydomain.io" }, "region-name-2": { "type": "string", "description": "The regional URL for the tenant and fabric pair for data center 2.", "example": "regional-url-2.mydomain.io" } } }, "status": { "type": "object", "description": "Status of the regional URLs.", "properties": { "region-name-1": { "type": "string", "description": "Status of the regional URL for data center 1. Available status - enabled, disabled, pending, error", "example": "enabled" }, "region-name-2": { "type": "string", "description": "Status of the regional URL for data center 2. Available status - enabled, disabled, pending, error", "example": "enabled" } } }, "err_msg": { "type": "string", "description": "The error message for the failure during the DNS record CRUD operations.", "example": "Error message string" } } }, "post_zendesk_api": { "properties": { "operation": { "type": "string", "description": "The type of support ticket to be created.\nThe following values for *operation* are valid (The default is *Generic*):\n - **Generic**: Generic support request.\n - **AddRegionToTenant**: Add a new region to the existing tenant.\n - **RemoveRegionFromTenant**: Remove a region from the existing tenant.\n - **AddRegionToFabric**: Add a new region to the specified fabric.\n - **RemoveRegionFromFabric**: Remove a region from the specified fabric.", "example": "Generic" }, "subject": { "type": "string", "description": "The subject of the support ticket.", "example": "Enable Stream worker" }, "body": { "type": "string", "description": "Add body to describe request/problem you are facing.", "example": "Can you please enable Stream worker feature for my tenant?" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tenant.", "example": "Demo" }, "email": { "type": "string", "description": "The email of the tenant.", "example": "demo@gmail.com" }, "datacenter": { "type": "string", "description": "The name of the data center.", "example": "gdn-us-west" }, "fabric": { "type": "string", "description": "The name of the fabric.", "example": "_system" } } } } }, "api_index_http_200_help": { "properties": { "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if the index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "fulltext" }, "unique": { "description": "*True* if the index is unique.", "type": "boolean", "example": true } } }, "api_index_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "indexes": { "description": "The array of indexes.", "type": "array", "items": { "$ref": "#/components/schemas/api_index_http_200_help" } }, "identifiers": { "description": "The object of indexes with index id as key.", "type": "object", "properties": { "global_demo/0": { "$ref": "#/components/schemas/api_index_http_200_help" } } } }, "type": "object" }, "api_index_fulltext_body": { "properties": { "fields": { "description": "An array of attribute names. Currently, the array is limited to exactly one attribute.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "minLength": { "description": "Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.", "type": "integer" }, "type": { "description": "Must be equal to *\"fulltext\"*.", "type": "string", "example": "fulltext" } }, "required": [ "fields", "type" ], "type": "object" }, "api_index_general_body": { "properties": { "fields": { "description": "An array of attribute names. Currently, the array is limited to exactly one attribute.", "items": { "type": "string", "example": "_key" }, "type": "array" }, "name": { "description": "Name of index.", "type": "string", "example": "idx_1723573111790501888" }, "type": { "description": "Must be equal to *\"fulltext\"*.", "type": "string", "example": "fulltext" }, "sparse": { "description": "*True* if index is sparse type.\n\n**Note**: Hash, skiplist and persistent indexes can optionally be created in a sparse variant. Sparse indexes do not index documents for which any of the index attributes is either not set or is null.", "example": false, "type": "boolean" }, "unique": { "description": "*True* if index is unique.\n\n**Note**: Unique indexes on non-shard keys are not supported in a cluster. The following index types do not support uniqueness and using the *unique* attribute with these types may lead to an error:\n- geo indexes\n- fulltext indexes", "example": false, "type": "boolean" }, "deduplicate": { "description": "*True* it controls whether inserting duplicate index values from the same document into a unique array index leads to a unique constraint error or not.", "type": "boolean", "default": true } }, "required": [ "fields", "type" ], "type": "object" }, "api_index_post_fulltext_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "Array of fields on which index is created.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "fulltext" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true }, "expireAfter": { "description": "Index expiry time.", "type": "number", "example": 3600 } } }, "api_index_post_fulltext_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "fulltext" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true }, "isNewlyCreated": { "description": "*True* if index is newly created.", "type": "boolean", "example": true } } }, "api_index_post_geo_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "geoJson": { "description": "If a geo-spatial index on a *location* is constructed and *geoJson* is *true*, the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions.", "type": "boolean", "example": true }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "maxNumCoverCells": { "description": "The maximum number of cover cells.", "type": "integer", "example": 8 }, "worstIndexedLevel": { "description": "The worst indexed level.", "type": "integer", "example": 4 }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": true }, "type": { "description": "Index type.", "type": "string", "example": "fulltext" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_geo_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "geoJson": { "description": "If a geo-spatial index on a *location* is constructed and *geoJson* is *true*, the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions.", "type": "boolean", "example": true }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "maxNumCoverCells": { "description": "The maximum number of cover cells.", "type": "integer", "example": 8 }, "worstIndexedLevel": { "description": "The worst indexed level.", "type": "integer", "example": 4 }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": true }, "type": { "description": "Index type.", "type": "string", "example": "fulltext" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_ttl_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "ttl" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true }, "expireAfter": { "description": "Index expiry time", "type": "number", "example": 600 } } }, "api_index_post_ttl_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "ttl" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true }, "expireAfter": { "description": "Index expiry time", "type": "number", "example": 600 } } }, "api_index_post_hash_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "hash" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_persistent_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "geoJson": { "description": "If a geo-spatial index on a *location* is constructed and *geoJson* is *true*, the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions.", "type": "boolean", "example": true }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "maxNumCoverCells": { "description": "The maximum number of cover cells.", "type": "integer", "example": 8 }, "worstIndexedLevel": { "description": "The worst indexed level.", "type": "integer", "example": 4 }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": true }, "type": { "description": "Index type.", "type": "string", "example": "persistent" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_persistent_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "geoJson": { "description": "If a geo-spatial index on a *location* is constructed and *geoJson* is *true*, the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions.", "type": "boolean", "example": true }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "maxNumCoverCells": { "description": "The maximum number of cover cells.", "type": "integer", "example": 8 }, "worstIndexedLevel": { "description": "The worst indexed level.", "type": "integer", "example": 4 }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": true }, "type": { "description": "Index type.", "type": "string", "example": "persistent" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_hash_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "hash" }, "unique": { "description": "*True* If the index is unique.", "type": "boolean", "example": true } } }, "api_index_post_skiplist_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "skiplist" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_index_post_skiplist_http_examples_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "fields": { "description": "HTTP response code.", "type": "array", "items": { "type": "string", "example": "_key" } }, "id": { "description": "Index identifier.", "type": "string", "example": "61862387" }, "name": { "description": "Name of the index.", "type": "string", "example": "idx_1723573111790501888" }, "selectivityEstimate": { "description": "The selectivity estimate of index.", "type": "number", "example": 1 }, "sparse": { "description": "*True* if index is sparse type.", "type": "boolean", "example": false }, "type": { "description": "Index type.", "type": "string", "example": "skiplist" }, "unique": { "description": "*True* if index is unique.", "type": "boolean", "example": true } } }, "api_collection_ttl_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Removed collection identifier.", "type": "string", "example": "61862387" } } }, "fabric_sync_get_status_example": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Fabric sync information", "type": "object", "properties": { "collections": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Collection name" }, "status": { "type": "string", "description": "Collection sync status", "example": "50%" } } } }, "fabric": { "type": "string", "description": "The fabric name.", "example": "_system" }, "status": { "type": "string", "description": "The fabric sync status.", "example": "50%" } } } } }, "administration_tenants_helper": { "properties": { "tenant": { "type": "string", "description": "The tenant name.", "example": "__system" }, "dcList": { "description": "The array of data center names on which this tenant is created.", "example": [ "sol1-ap-west" ] }, "status": { "type": "string", "description": "The tenant status.", "example": "available" } }, "type": "object" }, "administration_tenants_get_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/administration_tenants_helper" } } }, "administration_tenant_create_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "type": "object", "properties": { "displayName": { "description": "The name of the tenant.", "type": "string", "example": "Test" }, "email": { "description": "Email address of tenant.", "type": "string", "example": "demo@macrometa.com" }, "attribution": { "description": "The attribution.", "type": "string", "example": "Macrometa" }, "plan": { "description": "The billing plan name.", "type": "string", "example": "ENTERPRISE" }, "dcList": { "description": "A comma-separated string containing the data center names on which this tenant is to be created. If an empty string is passed in, the tenant is assumed to be global to the federation and is created on all current data centers in the federation.", "type": "string" }, "tenant": { "description": "The tenant name.", "type": "string", "example": "Test" }, "metadata": { "$ref": "#/components/schemas/get_tenant_metadata_object_example" } } } } }, "administration_tenant_delete_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "*True* if tenant removed successfully.", "type": "boolean", "example": true } } }, "administration_get_event_rc_201": { "type": "array", "description": "Array of delted events information.", "items": { "properties": { "_id": { "description": "ID of the event.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of event.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of event.", "type": "string", "example": "_dPRuHxe--_" } } } }, "administration_create_event_rc_201": { "properties": { "_id": { "description": "ID of the event.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of event.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of event.", "type": "string", "example": "_dPRuHxe--_" } } }, "administration_get_events_rc_200": { "type": "array", "description": "Array of event details", "items": { "properties": { "_id": { "description": "ID of the event.", "type": "string", "example": "test/foo" }, "_key": { "description": "_key details of event.", "type": "string", "example": "foo" }, "_rev": { "description": "_rev details of event.", "type": "string", "example": "_dPRuHxe--_" }, "action": { "description": "The activity of the event (CREATE/UPDATE/DELETE/EXECUTE/LOGIN).", "type": "string", "example": "CREATE" }, "attributes": { "$ref": "#/components/schemas/event_attributes" }, "clusterID": { "description": "Cluster id", "type": "string", "example": "sol1-ap-west" }, "email": { "description": "The email id.", "type": "string", "example": "test@foo.com" }, "entityName": { "description": "The entity name of the event.", "type": "string", "example": "Test" }, "entityType": { "description": "The entity type of the event (COLLECTION/GRAPH/CEP/AUTH/STREAM/GEOFABRIC).", "type": "string", "example": "COLLECTION" }, "fabric": { "type": "string", "description": "Fabric the event runs on.", "example": "_system" }, "status": { "description": "The activity status (OK/WARN/ERROR).", "type": "string", "example": "OK" }, "tenant": { "type": "string", "description": "The tenant name.", "example": "__system" }, "timestamp": { "type": "number", "description": "Timestamp of event creted at.", "example": 1643991111 }, "user": { "description": "The Id of the user.", "type": "string", "example": "root" }, "version": { "description": "The version string.", "type": "string", "example": "0.1" } } } }, "administration_api_get_metrics_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response.*False*for this response.", "type": "boolean", "example": false }, "result": { "description": "Returns array of metrics details.", "type": "string", "example": "{\"result\":[{\"name\":\"c8cep_app_cpu_tenant_total\",\"type\":\"counter\",\"help\":\"\"}]}" } } }, "administration_api_query_metrics_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Returns metrics details.", "type": "string", "example": "{\"c8cep_app_cpu_tenant_total\":[]}" } } }, "api_collection_http_200_help": { "properties": { "id": { "description": "Id of the the collection.", "type": "string", "example": "89218" }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "status": { "description": "Status of the collection.", "type": "number", "example": 3 }, "type": { "description": "Type of the collection.\n- *2*: document collection\n- *3*: edge collection", "type": "number", "example": 2 }, "collectionModel": { "description": "Type of collection model.\n- *DOC*: document model\n- *KV*: key/value model\n- *DYNAMO*: dynamo model", "type": "string", "example": "DOC" }, "isSpot": { "description": "*True* if collection is a spot collection.", "type": "boolean", "example": false }, "isLocal": { "description": "*True* if collection is a local collection, *False* if collection is a global collection", "type": "boolean", "example": false }, "hasStream": { "description": "*True* if collection has a stream.", "type": "boolean", "example": true }, "waitForSync": { "description": "**True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": false }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "globallyUniqueId": { "description": "Collection's global unique Id.", "type": "string", "example": "h2C627F3DCC8E/89218" }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false } } }, "api_collection_get_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "An array of API keys with details as", "type": "array", "items": { "$ref": "#/components/schemas/api_collection_http_200_help" } } } }, "api_collection_post_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Removed collection identifier.", "type": "string", "example": "61862387" } } }, "api_collection_get_collection_name_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Id of the collection.", "type": "string", "example": "89218" }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "status": { "description": "Status of the collection.\n- 1: new born collection\n- 2: unloaded\n- 3: loaded\n- 4: in the process of being unloaded\n- 5: deleted\n- 6: loading\n- Every other status indicates a corrupted collection.", "type": "number", "example": 3 }, "type": { "description": "Type of the collection.\n- 2: document collection (normal case)\n- 3: edges collection", "type": "number", "example": 2 }, "collectionModel": { "description": "Type of collection model.\n- *DOC*: document model\n- *KV*: key/value model\n- *DYNAMO*: dynamo model", "type": "string", "example": "DOC" }, "isSpot": { "description": "*True* if collection is a spot collection.", "type": "boolean", "example": false }, "isLocal": { "description": "*True* if collection is a local collection.", "type": "boolean", "example": false }, "hasStream": { "description": "*True* if collection has a stream.", "type": "boolean", "example": true }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": false }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "globallyUniqueId": { "description": "Collection's global unique Id.", "type": "string", "example": "h2C627F3DCC8E/89218" }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false }, "blobs": { "description": "*True* if collection is a blob-only collection.", "type": "boolean", "example": false } } }, "api_collection_put_collection_compact_http_example_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Id of the the collection.", "type": "string", "example": "89218" }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "status": { "description": "Status of the collection.\n- *0*: corrupted\n- *2*: unloaded\n- *3*: loaded\n- *4*: unloading\n- *5*: deleted\n- *6*: loading", "type": "number", "enum": [ 0, 2, 3, 4, 5, 6 ] }, "type": { "description": "Type of the collection.\n- *0*: invalid collection\n- *2*: document collection\n- *3*: edge collection", "type": "number", "enum": [ 2, 3 ] }, "collectionModel": { "description": "Type of collection model.\n- *DOC*: document model\n- *KV*: key/value model\n- *DYNAMO*: dynamo model", "type": "string", "enum": [ "DOC", "KV", "DYNAMO" ] }, "isSpot": { "description": "*True* if collection is a spot collection.", "type": "boolean", "example": false }, "isLocal": { "description": "*True* if collection is a local collection.", "type": "boolean", "example": false }, "hasStream": { "description": "*True* if collection has a stream.", "type": "boolean", "example": true }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": false }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "globallyUniqueId": { "description": "Collection's global unique Id.", "type": "string", "example": "h2C627F3DCC8E/89218" }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false } } }, "api_collection_put_collection_property_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "Id of the the collection.", "type": "string", "example": "89218" }, "objectId": { "description": "Object id of the the collection.", "type": "string", "example": "6966663" }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "statusString": { "description": "Status of the collection.", "type": "string", "enum": [ "unloaded", "loading", "loaded", "unloading", "deleted", "unknown" ] }, "type": { "description": "Type of the collection.", "type": "number", "example": 2 }, "collectionModel": { "description": "Type of collection model.\n- *DOC*: document model\n- *KV*: key/value model\n- *DYNAMO*: dynamo model", "type": "string", "example": "DOC" }, "isSpot": { "description": "*True* if collection is a spot collection.", "type": "boolean", "example": false }, "isLocal": { "description": "*True* if collection is a local collection.", "type": "boolean", "example": false }, "cacheEnabled": { "description": "*True* if collection has cache enabled", "type": "boolean", "example": false }, "hasStream": { "description": "*True* if collection has a stream.", "type": "boolean", "example": true }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": false }, "keyOptions": { "$ref": "#/components/schemas/fabric_collection_validate_keyoption" }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "globallyUniqueId": { "description": "Collection's global unique Id.", "type": "string", "example": "h2C627F3DCC8E/89218" }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false }, "status": { "description": "Status of the collection.\n- *0*: corrupted\n- *2*: unloaded\n- *3*: loaded\n- *4*: unloading\n- *5*: deleted\n- *6*: loading", "type": "number", "enum": [ 0, 2, 3, 4, 5, 6 ] } } }, "api_collection_get_count_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false }, "count": { "description": "Number of document in the collection.", "type": "string", "example": "89218" }, "id": { "description": "Id of the the collection.", "type": "string", "example": "89218" }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "globallyUniqueId": { "description": "Global unique identifier.", "type": "string", "example": "h83A7584E8AA9" } } }, "get_api_collection_figures_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "id": { "description": "ID of the the collection.", "type": "string", "example": "89218" }, "objectId": { "description": "Object ID of the the collection.", "type": "string", "example": "6966663" }, "name": { "description": "Name of the collection.", "type": "string", "example": "colltest0127133421258ogefv" }, "statusString": { "description": "Status of the collection.", "type": "string", "enum": [ "unloaded", "loading", "loaded", "unloading", "deleted", "unknown" ] }, "collectionModel": { "description": "Type of collection model.\n- *0*: document model\n- *1*: key/value model\n- *2*: dynamo model", "type": "number", "example": 0 }, "isSpot": { "description": "*True* if the collection is a spot collection.", "type": "boolean", "example": false }, "isLocal": { "description": "*True* if the collection is a local collection.", "type": "boolean", "example": false }, "cacheEnabled": { "description": "*True* if the collection has cache enabled.", "type": "boolean", "example": false }, "hasStream": { "description": "*True* if the collection has a stream.", "type": "boolean", "example": true }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "example": false }, "keyOptions": { "$ref": "#/components/schemas/fabric_collection_validate_keyoption" }, "isSystem": { "description": "*True* if collection is a system collection.", "type": "boolean", "example": false }, "globallyUniqueId": { "description": "Collection's global unique ID.", "type": "string", "example": "h2C627F3DCC8E/89218" }, "searchEnabled": { "description": "*True* if collection is searchable.", "type": "boolean", "example": false }, "figures": { "$ref": "#/components/schemas/collection_figures" } }, "type": "object" }, "collection_figures": { "properties": { "indexes": { "$ref": "#/components/schemas/collection_figures_indexes" }, "viewIndexes": { "$ref": "#/components/schemas/collection_figures_view_indexes" }, "documentsSize": { "format": "int64", "type": "integer" }, "cacheInUse": { "type": "boolean" }, "cacheSize": { "format": "int64", "type": "integer" }, "cacheUsage": { "format": "int64", "type": "integer" } }, "type": "object" }, "collection_figures_indexes": { "properties": { "count": { "description": "The total number of indexes defined for the collection, including the pre-defined\nindexes (e.g. primary index).\n\n", "format": "int64", "type": "integer", "example": 1 }, "size": { "description": "The total memory allocated for indexes in bytes.", "format": "int64", "type": "integer", "example": 2070 } }, "type": "object" }, "collection_figures_view_indexes": { "properties": { "count": { "description": "The total number of views defined for the collection.", "format": "int64", "type": "integer", "example": 0 }, "size": { "description": "The total memory allocated for views in bytes.", "format": "int64", "type": "integer", "example": 0 } }, "type": "object" }, "api_collection_put_properties_http_examples_rc_200": { "properties": { "hasStream": { "description": "*True* if a local stream is associated with the collection.", "type": "boolean" }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean" }, "cacheEnabled": { "description": "*True* if collection has cache enabled", "type": "boolean", "default": false } }, "required": [ "hasStream" ], "type": "object" }, "fabric_collection_validate": { "properties": { "isLocal": { "description": "If *true*, create a local collection. For a local collection data is not replicated across regions.", "type": "boolean", "default": false }, "keyOptions": { "$ref": "#/components/schemas/fabric_collection_validate_keyoption" }, "name": { "description": "The name of the collection.", "type": "string", "example": "Test" }, "cacheEnabled": { "description": "*True* if collection has cache enabled", "type": "boolean", "default": false }, "waitForSync": { "description": "*True* if all data must be synced to storage before operation returns.", "type": "boolean", "default": false }, "enableShards": { "description": "If *true*, enable sharding for the collection.", "type": "boolean", "default": false }, "type": { "description": "The type of the collection to create.\n- *2*: document collection\n- *3*: edge collection.", "type": "integer", "default": 2 }, "stream": { "description": "If *true*, create a local stream for collection.", "type": "boolean", "default": false } }, "required": [ "name" ], "type": "object" }, "fabric_collection_validate_keyoption": { "description": "Additional options for key generation. If specified, *keyOptions* should be a JSON array containing the following attributes:", "properties": { "allowUserKeys": { "description": "If set to *true*, you can supply a key value in the *_key* attribute of a document. If set to *false*, the key generator creates keys and an error occurs if you add a *_key* value", "type": "boolean", "example": false }, "increment": { "description": "Increment value for *autoincrement* key generator. Not used for other key generator types.", "type": "integer", "example": 1 }, "offset": { "description": "Initial offset value for *autoincrement* key generator. Not used for other key generator types.", "type": "integer", "example": 1 }, "type": { "description": "Specifies the type of the key generator.\n- *traditional*: generates numerical keys in ascending order.\n- *autoincrement:* generates numerical keys in ascending order with configurable initial offset and spacing.\n- *padded:* generates keys of a fixed length (16 bytes) in ascending lexicographical sort order.\n- *uuid64*: generates universally unique keys.", "type": "string", "example": "autoincrement" } } }, "support_trigger_zendesk_post_rc_400": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 400 }, "error": { "description": "Flag if there is an error in response. *True* for this response.", "type": "boolean", "example": true }, "message": { "description": "A message created for this error.", "type": "string", "example": "Invalid input API request paramaters" }, "requestId": { "description": "The requestId generated for the support ticket request.", "type": "string", "example": "b0d08ea6-efa3-472c-a5f3-5b91558113e8/2" }, "serverId": { "description": "The serverId generated for the support ticket request.", "type": "string", "example": "C8Apid 0.1.39" } } }, "StreamSinkInfo": { "type": "object", "description": "Sink information.", "properties": { "tenant": { "type": "string", "example": "_mm" }, "namespace": { "type": "string", "example": "c8local._system" }, "name": { "type": "string", "example": "c8locals.testsink" }, "inputs": { "example": [ "_mm/c8local._system/c8locals.testsink-topic" ] }, "inputSpecs": { "properties": { "_mm/c8local._system/c8locals.testsink-topic": { "properties": { "schemaProperties": { "example": {} }, "consumerProperties": { "example": {} }, "regexPattern": { "type": "boolean", "example": false } } } } }, "configs": { "properties": { "password": { "type": "string", "example": "xxxxxx" }, "jdbcUrl": { "type": "string", "example": "jdbc:postgresql://www.mydomain.com:5432/postgres" }, "userName": { "type": "string", "example": "postgres" }, "tableName": { "type": "string", "example": "person" } } }, "parallelism": { "type": "number", "example": 2 }, "processingGuarantees": { "type": "string", "example": "ATLEAST_ONCE" }, "retainOrdering": { "type": "boolean", "example": false }, "autoAck": { "type": "boolean", "example": true } } }, "StreamSinkInstanceStatus": { "type": "object", "description": "Sink Instance status.", "properties": { "running": { "type": "boolean", "example": false }, "error": { "example": "" }, "numRestarts": { "type": "number", "example": 34 }, "numReadFromPulsar": { "type": "number", "example": 0 }, "numSystemExceptions": { "type": "number", "example": 0 }, "latestSystemExceptions": { "example": [] }, "numSinkExceptions": { "type": "number", "example": 0 }, "latestSinkExceptions": { "type": "number", "example": [] }, "numWrittenToSink": { "type": "number", "example": 0 }, "lastReceivedTime": { "type": "number", "example": 0 }, "workerId": { "type": "string", "example": "c-east-c8streams-broker-0.c8streams-broker.c8.svc.cluster.local-8080" } } }, "StreamSinkStatus": { "type": "object", "description": "Sink status.", "properties": { "numInstances": { "type": "number", "example": 1 }, "numRunning": { "type": "number", "example": 0 }, "instances": { "type": "array", "items": { "type": "object", "properties": { "instanceId": { "type": "number", "example": 0 }, "status": { "$ref": "#/components/schemas/StreamSinkInstanceStatus" } } } } } }, "api_search_post_view_http_examples_rc_201": { "properties": { "globallyUniqueId": { "description": "Gloable Unique identifier of the search view.", "type": "string", "example": "h83A7584E8AA9/81730851" }, "id": { "description": "Unique identifier of the search view.", "type": "string", "example": "81730851" }, "name": { "description": "The name of the search view. This field is immutable.", "type": "string", "example": "new_collection_view" }, "primarySort": { "description": "Specify default sorting order. This field is immutable.", "type": "array", "items": { "type": "object", "properties": { "field": { "description": "The name of the field.", "type": "string", "example": "attribute1" }, "direction": { "description": "The sorting direction.", "type": "string", "example": "asc" } }, "default": {} }, "default": [] }, "links": { "$ref": "#/components/schemas/post_api_view_links" }, "type": { "description": "The type of the search view. must be equal to *search*.", "type": "string", "default": "search" } } }, "api_search_get_view_http_examples_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "hasMore": { "description": "*True* if more results available for the cursor on the server", "type": "boolean", "example": false }, "count": { "description": "Number of matching documents.", "type": "number", "example": 1 }, "cached": { "description": "*True* if indicating whether the query result was served from the query cache or not", "type": "boolean", "example": false }, "result": { "description": "The array of matching documents.", "type": "array", "example": [ { "URL": "https://www.macrometa.com/", "_id": "server_list/62487646", "_key": "62487646", "_rev": "_dcf-QQO--_" } ], "items": {} } } }, "api_search_get_views_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "$ref": "#/components/schemas/api_search_post_view_http_examples_rc_201" } } }, "api_search_view_search": { "properties": { "collection": { "type": "string", "example": "my_collection", "description": "Collection in which to search." }, "search": { "type": "string", "example": "filter doc.URL== @URL Return doc", "description": "C8QL search query, specifying search criteria for the documents in the collection." }, "bindVars": { "type": "object", "example": { "URL": "https://www.macrometa.com/" }, "description": "Bind variables for the search query." }, "ttl": { "type": "integer", "example": 60, "description": "How long search results should be preserved by the server (in seconds)." } }, "required": [ "collection", "search" ], "type": "object" }, "api_search_get_analyzer_det_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "name": { "description": "The name of analyzer.", "type": "string", "example": "text_pt" }, "type": { "description": "The type of analyzer.", "type": "string", "example": "text" }, "properties": { "description": "The properties of analyzer.", "properties": { "locale": { "description": "The locale for analyzer.", "type": "string", "example": "pt.utf-8" }, "case": { "description": "The character casing for analyzer.", "type": "string", "example": "upper" }, "stopwords": { "description": "The array of specified words to omit from the result.", "example": [] }, "accent": { "description": "*True* to preserve accented characters", "type": "boolean", "default": true }, "stemming": { "description": "*True* to stem returned words", "type": "boolean", "default": true } }, "type": "object" }, "features": { "description": "The array of properties of analyzer.", "example": [ "position", "norm" ] } }, "type": "object" }, "api_search_get_analyzer_http_examples_rc_200": { "properties": { "name": { "description": "The name of analyzer.", "type": "string", "example": "text_pt" }, "type": { "description": "The type of analyzer.", "type": "string", "example": "text" }, "properties": { "description": "The properties of analyzer.", "properties": { "locale": { "description": "The locale for analyzer.", "type": "string", "example": "pt.utf-8" }, "case": { "description": "The character casing for analyzer.", "type": "string", "example": "upper" }, "stopwords": { "description": "The array of specified words to omit from the result.", "example": [] }, "accent": { "description": "*True* to preserve accented characters", "type": "boolean", "default": true }, "stemming": { "description": "*True* to stem returned words", "type": "boolean", "default": true } }, "type": "object" }, "features": { "description": "The array of properties of analyzer.", "type": "array", "example": [ "position", "norm" ], "items": {} } }, "type": "object" }, "api_search_get_analyzer_http_examples_rc_201": { "properties": { "name": { "description": "The name of analyzer.", "type": "string", "example": "text_pt" }, "type": { "description": "The type of analyzer.", "type": "string", "example": "text" }, "properties": { "description": "The properties of analyzer.", "properties": { "locale": { "description": "The locale for analyzer.", "type": "string", "example": "pt.utf-8" }, "case": { "description": "The character casing for analyzer.", "type": "string", "example": "upper" }, "stopwords": { "description": "The array of specified words to omit from the result.", "example": [] }, "accent": { "description": "*True* to preserve accented characters", "type": "boolean", "default": true }, "stemming": { "description": "*True* to stem returned words", "type": "boolean", "default": true } }, "type": "object" }, "features": { "description": "The array of properties of analyzer.", "example": [ "position", "norm" ] } }, "type": "object" }, "api_search_get_analyzers_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "items": { "$ref": "#/components/schemas/api_search_get_analyzer_http_examples_rc_200" }, "type": "array" } }, "type": "object" }, "api_search_post_analyzer_http_examples_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "name": { "description": "Name of the removed analyzer.", "type": "string", "example": "my_custom_analyzer" } }, "type": "object" }, "generate_edge_worker_from_query_worker_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 202 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "items": { "properties": { "message": { "type": "string", "example": "The edge worker will be generated and activated shortly.", "description": "Success message." } }, "type": "object" }, "type": "array" } } }, "akamai_credentials": { "description": "Only available when type is akamai.", "properties": { "accessToken": { "type": "object", "properties": { "hash": { "type": "string", "example": "66c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai access token." } } }, "baseUri": { "type": "string", "example": "something.akamai.com", "description": "Host name of the Akamai edge worker." }, "clientSecret": { "type": "object", "properties": { "hash": { "type": "string", "example": "86c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client secret." } } }, "clientToken": { "type": "object", "properties": { "hash": { "type": "string", "example": "96c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client token." } } } }, "type": "object" }, "generate_edge_worker_from_query_worker": { "properties": {}, "type": "object" }, "edge_worker_rc_200": { "type": "object", "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "items": { "type": "object", "properties": { "activationStatus": { "type": "string", "example": "ACTIVE", "description": "Edge function activation status." }, "description": { "type": "string", "example": "Get animal details edge function.", "description": "Description about edge function." }, "edgeWorkerId": { "type": "number", "example": 59283, "description": "Edge function identifier." }, "name": { "type": "string", "example": "mmFnworker", "description": "Name of the edge function." }, "type": { "type": "string", "example": "akamai", "description": "Type of the edge function.", "enum": [ "akamai", "macrometa" ] }, "environment": { "type": "string", "example": "PRODUCTION", "description": "Edge function activation environment." }, "url": { "type": "string", "example": "mmfnworker.macrometa.io/", "description": "URL to access the edge function." }, "fabric": { "type": "string", "example": "_system", "description": "Name of the fabric." }, "createdAt": { "format": "date-time", "type": "string", "example": "2022-08-16T06:46:02Z", "description": "ISO 8601 timestamp indicating when the edge function was created." }, "lastModified": { "format": "date-time", "type": "string", "example": "2022-08-10T01:29:39Z", "description": "ISO 8601 timestamp indicating when the edge worker was most recently modified." }, "queryWorkerName": { "type": "string", "example": "animal_details_ew", "description": "Name of the Macrometa query worker." }, "queue": { "type": "string", "example": "No", "description": "If yes, then pending activation." } } }, "type": "array" } } }, "list_edge_worker_rc_200": { "$ref": "#/components/schemas/edge_worker_rc_200" }, "invoke_function_worker_rc_200": { "description": "Array of key value pairs.", "example": [ { "key": "value" } ], "type": "object" }, "function_worker_metadata": { "properties": { "type": { "type": "string", "example": "akamai", "description": "Type of the edge function.", "enum": [ "akamai", "macrometa" ] }, "accessToken": { "type": "string", "example": "66c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai access token." }, "baseUri": { "type": "string", "example": "something.akamai.com", "description": "Host name of the Akamai edge worker." }, "clientSecret": { "type": "string", "example": "86c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client secret." }, "clientToken": { "type": "string", "example": "96c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client token." }, "resourceTierId": { "type": "string", "description": "Resource tier identifier.", "example": "201" }, "groupId": { "type": "string", "description": "Group identifier.", "example": "221222" }, "hostName": { "type": "string", "description": "Edge function hostname.", "example": "macrometa-akamai-ew.macrometa.io" } }, "required": [ "type", "accessToken", "clientSecret", "baseUri", "clientToken", "resourceTierId", "groupId", "hostName" ], "type": "object" }, "modify_function_worker_metadata": { "properties": { "type": { "type": "string", "example": "akamai", "description": "Type of the edge function.", "enum": [ "akamai", "macrometa" ] }, "accessToken": { "type": "string", "example": "66c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai access token." }, "baseUri": { "type": "string", "example": "something.akamai.com", "description": "Host name of the Akamai edge worker." }, "clientSecret": { "type": "string", "example": "86c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client secret." }, "clientToken": { "type": "string", "example": "96c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client token." }, "resourceTierId": { "type": "string", "description": "Resource tier identifier.", "example": "201" }, "groupId": { "type": "string", "description": "Group identifier.", "example": "221222" }, "hostName": { "type": "string", "description": "Edge function hostname.", "example": "macrometa-akamai-ew.macrometa.io" } }, "type": "object" }, "function_worker_metadata_rc_200": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 200 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "items": { "properties": { "type": { "type": "string", "example": "akamai", "description": "Type of the edge function.", "enum": [ "akamai", "macrometa" ] }, "accessToken": { "type": "string", "example": "66c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai access token." }, "baseUri": { "type": "string", "example": "something.akamai.com", "description": "Host name of the Akamai edge worker." }, "clientSecret": { "type": "string", "example": "86c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client secret." }, "clientToken": { "type": "string", "example": "96c6c8a1d7112066cbd1905cb909bbe1e29ae730f7873b4ff35afe286", "description": "Akamai client token." }, "resourceTierId": { "type": "string", "description": "Resource tier identifier.", "example": "201" }, "groupId": { "type": "string", "description": "Group identifier.", "example": "221222" }, "propertyId": { "type": "string", "description": "Akamai property identifier.", "example": "46" }, "contractId": { "type": "string", "description": "Akamai contract identifier.", "example": "ctr_V-49QB5O7" }, "hostName": { "type": "string", "description": "Edge function hostname.", "example": "macrometa-akamai-ew.macrometa.io" } }, "type": "object" }, "type": "array" } } }, "set_function_metadata_example_rc_201": { "properties": { "code": { "description": "HTTP response code.", "type": "integer", "example": 201 }, "error": { "description": "Flag if there is an error in response. *False* for this response.", "type": "boolean", "example": false }, "result": { "description": "Flag for if the metadata for edge function is set successfully.", "type": "boolean", "example": true } } }, "ConnectorEntity": { "allOf": [ { "$ref": "#/components/schemas/ConnectorBase" } ], "type": "object", "properties": { "logo": { "type": "string", "description": "The mime type and base64 logo image associated with the connector.", "example": "data:image/png;base64,iVBORw0KGgoAAAA..." }, "reservedKeys": { "type": "array", "items": { "type": "string" }, "description": "The reserved keys of the connector.", "example": [ "_key", "_id", "_rev" ] }, "config": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorConfig" } } } }, "ConnectorConfig": { "type": "object", "description": "A config of a connector.", "properties": { "name": { "title": "Name", "type": "string", "description": "The name of the config." }, "displayName": { "title": "Display Name", "type": "string", "description": "Name that can be used by GUI clients to display the config." }, "type": { "title": "Type", "type": "string", "description": "The data type of the config.\nsupported types:\n * string\n * integer\n * boolean\n * date_iso8601\n * email\n * password\n * oauth\n * options\n * file\n * array\n * object\n * hidden" }, "isMandatory": { "title": "Is Mandatory", "type": "boolean", "description": "Indicates whether the configuration is mandatory for the connector.", "default": true }, "isDynamic": { "title": "Is Dynamic", "type": "boolean", "description": "Specifies whether the configuration is dynamic.\nDynamic configurations can be modified after the initial configuration has been set up.", "default": false }, "description": { "title": "Description", "type": "string", "description": "Provides a description of the configuration, explaining its purpose and functionality." }, "defaultValue": { "title": "Default Value", "type": "string", "description": "Default value for the configuration." }, "placeholderValue": { "title": "Placeholder Value", "type": "string", "description": "Serves as a placeholder for the configuration value. In GUI clients, this value can be displayed as a placeholder within input fields." } } }, "Connection": { "allOf": [ { "$ref": "#/components/schemas/ConnectionBase" }, { "type": "object", "properties": { "metadata": { "description": "Contains the metadata of the connection. Configurations for the connector, which are set up through this connection, must be provided as key-value pairs.", "example": { "host": "127.0.0.1", "port": "5432", "user": "postgres", "password": "abcdef" }, "type": "object", "additionalProperties": { "type": "object" } } } } ] }, "ConnectionBase": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection.", "example": "ToPostgres" }, "type": { "type": "string", "description": "Connection type.", "example": "dataConnector" }, "connector": { "type": "object", "description": "Connector configured by this connection definition.", "$ref": "#/components/schemas/ConnectorBase" }, "isEditable": { "type": "boolean", "description": "Indicates whether this connection is editable or not.", "default": false, "example": false }, "isInternal": { "type": "boolean", "description": "Specifies whether this connection is internal or not.", "default": false, "example": false } } }, "ConnectorBase": { "type": "object", "description": "Lightweight connector definition.", "properties": { "name": { "type": "string", "example": "macrometa-source-oracle", "description": "Name of the connector. This is used as the ID of the connector." }, "displayName": { "type": "string", "example": "OracleDB", "description": "Name that can be used by GUI clients to display the connector." }, "description": { "type": "string", "example": "Source for loading data from a GDN collection." }, "type": { "type": "string", "example": "source", "description": "Specifies whether the connector serves as a source or a target." }, "version": { "type": "string", "description": "Version of the connector.", "example": "1.0.0" } } }, "WorkflowEntity": { "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the workflow.", "example": "connectorse83a79c296f748b18fd9" }, "name": { "type": "string", "description": "Name of the workflow.", "example": "ToPostgres" }, "connector": { "type": "object", "description": "Connector used in this workflow.", "$ref": "#/components/schemas/ConnectorBase" }, "isEditable": { "type": "boolean", "description": "Indicates whether the connection used in this workflow is editable or not.", "default": false, "example": false }, "isInternal": { "type": "boolean", "description": "Specifies whether the connection used in this workflow is internal or not.", "default": false, "example": false }, "status": { "type": "string", "description": "Status of the workflow.", "example": "Succeeded" } } }, "CollectionMetadataEntity": { "type": "object", "properties": { "_key": { "type": "string", "description": "Key of the entity.", "example": "1", "x-field-extra-annotation": "@com.c8db.entity.DocumentField(com.c8db.entity.DocumentField.Type.KEY)" }, "tenant": { "type": "string", "description": "Tenant that owns the collection of this metadata.", "example": "demo" }, "fabric": { "type": "string", "description": "Fabric of the collection.", "example": "_system" }, "name": { "type": "string", "description": "Name of the collection linked with this metadata entity.", "example": "MyCollection" }, "workflows": { "type": "array", "description": "Details of workflows assigned to the collection.", "items": { "$ref": "#/components/schemas/WorkflowMetadataEntity" } } } }, "WorkflowMetadataEntity": { "type": "object", "title": "WorkflowMetadataEntity", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the workflow. This is represented as a UUID.", "example": "connectorse83a79c296f748b18fd9" }, "sourceConnection": { "$ref": "#/components/schemas/WorkflowConnectionEntity" }, "targetConnection": { "$ref": "#/components/schemas/WorkflowConnectionEntity" }, "transformation": { "type": "string", "description": "Complete stream worker for the transformation.", "example": "@App:name(connectorse83a79c296f748b18fd9..." } } }, "WorkflowConnectionEntity": { "type": "object", "title": "WorkflowConnectionEntity", "properties": { "name": { "type": "string", "description": "Connection name for the workflow.", "example": "FromPostgres" }, "dynamicConfigs": { "type": "object", "description": "Dynamic configurations of the connection.", "additionalProperties": true }, "connector": { "type": "object", "description": "Connector configured by this connection definition.", "$ref": "#/components/schemas/ConnectorBase" }, "isEditable": { "type": "boolean", "description": "Whether this connection is editable or not.", "default": false, "example": false }, "isInternal": { "type": "boolean", "description": "Whether this connection is internal or not.", "default": false, "example": false } } }, "ResponseBase": { "type": "object", "properties": { "error": { "type": "boolean", "default": false }, "code": { "type": "integer", "default": 200 } }, "required": [ "error" ] }, "ErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "errorMessage": { "type": "string", "example": "Resource with id uiut-123-sdfi234-123n not found." }, "errorNum": { "type": "integer", "example": "581" } } } ] }, "DeletedResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "id": { "type": "string", "example": "123" } } } ] }, "ValidationResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "reason": { "type": "string", "description": "If invalid, reason for marking resource as invalid.", "example": "Incorrect username/password" } } } ] }, "TransformationValidationResponse": { "allOf": [ { "$ref": "#/components/schemas/ValidationResponse" }, { "type": "object", "properties": { "outputSchema": { "$ref": "#/components/schemas/ConnectorSchema", "description": "Schema of the data, after the transformatio." }, "transformation": { "type": "string", "description": "Funtional stream worker created to execute the query provided in the input." }, "transformationName": { "type": "string", "description": "Name of the stream worker for the transformation.\nThis stream worker is created as a system stream worker." }, "temporaryCollection": { "type": "string", "description": "Name of the temporary collection to be used with the transformation.\nThis collection is created as a system collection." } } } ] }, "ConnectionResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "object", "$ref": "#/components/schemas/Connection" } } } ] }, "ConnectionsResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionBase" } } } } ] }, "ConnectorEntityResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorEntity" } } } } ] }, "ConnectorEntitiesResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorBase" } } } } ] }, "CollectionMetadataResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "result": { "type": "object", "$ref": "#/components/schemas/CollectionMetadataEntity" } } } ] }, "MetricsResponse": { "allOf": [ { "$ref": "#/components/schemas/ResponseBase" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "Result for the metrics query.", "title": "MetricSeries", "properties": { "metric": { "type": "string", "description": "Metric name." }, "data": { "type": "array", "items": { "type": "object", "description": "Metric values.", "title": "Metric", "properties": { "timestamp": { "type": "integer" }, "value": { "type": "string" } } } } } } } } } ] }, "SchemaAttribute": { "type": "object", "description": "Model to encapsulate properties of a schema attribute from a connector.", "properties": { "name": { "type": "string", "description": "Name of the attribute.", "example": "Name" }, "type": { "type": "string", "description": "Type of the attribute.", "example": "string" } } }, "ConnectorSchema": { "type": "object", "description": "Model to encapsulate properties of a schema from a connector.", "properties": { "name": { "type": "string", "description": "Name of the schema." }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaAttribute" }, "description": "Attributes of the schema." } } }, "ConnectorSample": { "type": "object", "description": "Model to encapsulate properties of a sample from a connector.", "properties": { "schema": { "$ref": "#/components/schemas/ConnectorSchema", "description": "Schema of the stream." }, "data": { "description": "Sample records for the connector.", "type": "array", "items": { "type": "object" } } } }, "ConnectorSampleRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "Connector type. source or target.", "example": "source" }, "config": { "type": "object", "description": "Contains the connector configurations. Key-value pairs should be provided to configure the connection to the respective data source or target.", "example": { "host": "db.postgres.com", "port": 5432, "username": "postgres", "password": "password" }, "additionalProperties": true } } } }, "parameters": { "Fabric": { "name": "fabric", "in": "path", "required": true, "description": "Fabric name of the resource.", "schema": { "type": "string" } }, "Collection": { "name": "collection-name", "in": "path", "required": true, "description": "Collection name.", "schema": { "type": "string" } }, "Connector": { "name": "connector-name", "in": "path", "required": true, "description": "Name of the connector.", "example": "postgres", "schema": { "type": "string" } }, "Connection": { "name": "connection-name", "in": "path", "required": true, "description": "Name of the connection.", "schema": { "type": "string" } }, "Workflow": { "name": "workflow-name", "in": "path", "required": true, "description": "Name of the workflow.", "schema": { "type": "string" } }, "ConnectionType": { "name": "type", "description": "Connection type.", "in": "query", "schema": { "type": "string" } } } } }