Endpoints

Category contract guide

GET/categories/{id}v0.3.0

Request

This operation declares public access.

CURL

curl 'https://ursy.org/wp-json/ursy-trust/v1/categories/{id}?environment=production' \
  -H 'Accept: application/json'

Scopes: None declared
Execution: At the owning service
Risk classification: not declared

Parameters

id path · string required

See the accepted schema for constraints.

environment query · string

See the accepted schema for constraints.

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": "Versioned successful result. Fields under data are owned by this operation.",
            "content": {
                "application/json": {
                    "schema": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/SuccessEnvelope"
                            },
                            {
                                "type": "object",
                                "properties": {
                                    "data": {
                                        "type": [
                                            "object",
                                            "array"
                                        ]
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        },
        "400": {
            "description": "Malformed request",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "401": {
            "description": "Signature missing or invalid",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "403": {
            "description": "Scope, Origin or activation policy denied",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "409": {
            "description": "Replay, revision or state conflict",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "503": {
            "description": "Source, provider or required configuration unavailable",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "404": {
            "description": "Resource not found",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "413": {
            "description": "Body too large",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "415": {
            "description": "Unsupported content type",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "422": {
            "description": "Invalid field, enum or query bounds",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "429": {
            "description": "Rate limit; use Retry-After",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "500": {
            "description": "Internal failure with safe trace identifier",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        }
    }
}