Skip to main content
PATCH
/
providers
/
{org}
/
{name}
Update Provider
curl --request PATCH \
  --url https://api.example.com/providers/{org}/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "readme": "<string>",
  "tags": [
    "<string>"
  ],
  "icon_url": "<string>"
}
'
{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "author": {
    "organization_id": "<string>",
    "org_name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "scope": "public",
  "trust_tier": "community",
  "icon_url": "<string>",
  "readme": "<string>",
  "tags": [
    "<string>"
  ],
  "latest_version": "<string>",
  "install_count": 0
}

Path Parameters

​
org
string
required
​
name
string
required

Body

application/json

Request model for updating provider metadata.

Only provided (non-None) fields are updated. Trust tier is intentionally excluded -- it is admin-only and managed separately.

Attributes: display_name: Human-readable name for UI display. description: Short description of what the provider does. readme: Long-form documentation in markdown. tags: Searchable tags for categorization. icon_url: URL to provider icon image.

​
display_name
string | null
Maximum string length: 100
​
description
string | null
Maximum string length: 500
​
readme
string | null
Maximum string length: 50000
​
tags
string[] | null
Maximum array length: 20
​
icon_url
string | null
Maximum string length: 500

Response

Successful Response

Provider listing in the catalog.

Identity fields (frozen): name: Globally unique provider name (used as SurrealDB record ID).

Metadata: display_name: Human-readable name for UI display. description: Short description of what the provider does. author: Publishing organization metadata. scope: Visibility scope (public or tenant-only). trust_tier: Trust level (Official/Verified/Community). icon_url: URL to provider icon image. readme: Long-form documentation in markdown. tags: Searchable tags for categorization.

State (system-managed): latest_version: Semver of the most recent published version. install_count: Total number of tenant installations.

​
name
string
required
​
display_name
string
required
​
description
string
required
​
author
ProviderAuthor · object
required

Author metadata for a provider.

Attributes: organization_id: Organization ID of the publishing tenant. org_name: Display name of the publishing organization.

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
scope
enum<string>
default:public

Scope of a provider in the catalog.

Available options:
public,
tenant
​
trust_tier
enum<string>
default:community

Trust level assigned to providers.

Available options:
official,
verified,
community
​
icon_url
string | null
​
readme
string | null
​
tags
string[]
​
latest_version
string | null
​
install_count
integer
default:0