URSY.DEVPART OF THE URSY NETWORKSign inBuild with URSY

Every contract sourcedEvery check datedGaps shown, never filledBuild with URSY

Endpoints

list_capabilities

Read typed operations, scopes, risks and input schemas.

GET/v1/capabilitiesv1.8.3

Request

This operation declares public access.

CURL
curl 'https://api.ursy.cloud/v1/capabilities' \
  -H 'Accept: application/json'
Scopes
None declared
Execution
At the owning service
Risk classification
not declared

Parameters

This operation declares no parameters.

This operation is documented here. Use the owning service with the appropriate credentials and permissions to execute it.

Response schemas and request body
CONTRACT JSON
{
    "requestBody": null,
    "responses": {
        "200": {
            "description": "Typed operation result; request_id correlates the request.",
            "content": {
                "application/json": {
                    "schema": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "schema": {
                                "type": "string",
                                "enum": [
                                    "ursy.cloud/capabilities/v1"
                                ]
                            },
                            "capabilities": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "properties": {
                                        "name": {
                                            "type": "string"
                                        },
                                        "method": {
                                            "type": "string",
                                            "enum": [
                                                "GET",
                                                "POST",
                                                "PATCH",
                                                "DELETE"
                                            ]
                                        },
                                        "path": {
                                            "type": "string"
                                        },
                                        "description": {
                                            "type": "string"
                                        },
                                        "scope": {
                                            "oneOf": [
                                                {
                                                    "type": "string"
                                                },
                                                {
                                                    "type": "null"
                                                }
                                            ]
                                        },
                                        "write": {
                                            "type": "boolean"
                                        },
                                        "risk": {
                                            "type": "string",
                                            "enum": [
                                                "R0",
                                                "R1",
                                                "R2",
                                                "R3",
                                                "R4"
                                            ]
                                        },
                                        "inputSchema": {
                                            "type": "object",
                                            "additionalProperties": true,
                                            "description": "A JSON Schema 2020-12 document; vocabulary keywords are extensible."
                                        },
                                        "outputSchema": {
                                            "type": "object",
                                            "additionalProperties": true,
                                            "description": "A JSON Schema 2020-12 document; vocabulary keywords are extensible."
                                        },
                                        "family": {
                                            "type": "string"
                                        },
                                        "kind": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "name",
                                        "method",
                                        "path",
                                        "description",
                                        "scope",
                                        "write",
                                        "risk",
                                        "inputSchema",
                                        "outputSchema"
                                    ]
                                }
                            },
                            "request_id": {
                                "type": "string"
                            }
                        },
                        "required": [
                            "schema",
                            "capabilities"
                        ]
                    }
                }
            }
        },
        "default": {
            "description": "Stable error envelope. 401 invalid/expired/revoked grant; 403 missing scope; 404 unavailable resource; 409 plan/idempotency conflict; 412 stale ETag; 413 size/quota; 429 rate limit.",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Error"
                    }
                }
            }
        }
    }
}