Skip to content

Commit 4785f19

Browse files
authored
Add registry API reference (#372)
* Add registry API reference * Update registry API URL and add sorting options * Add links into registry reference --------- Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
1 parent 4cdf295 commit 4785f19

File tree

6 files changed

+33
-3
lines changed

6 files changed

+33
-3
lines changed

docs/toolhive/guides-registry/authentication.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,9 @@ regardless of the auth mode:
281281
- `/.well-known/*` - OAuth discovery endpoints (RFC 9728)
282282

283283
You can configure additional public paths using the `publicPaths` field in your
284-
OAuth configuration.
284+
OAuth configuration. See the
285+
[Registry API reference](../reference/registry-api.mdx) for complete endpoint
286+
documentation.
285287

286288
## RFC 9728 OAuth discovery
287289

docs/toolhive/guides-registry/configuration.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ registries:
190190
versions
191191
- `GET` operations for listing and retrieving servers
192192

193+
See the [Registry API reference](../reference/registry-api.mdx) for complete
194+
endpoint documentation and request/response examples.
195+
193196
### Kubernetes registry
194197

195198
Discovers MCP servers from running Kubernetes deployments. Automatically creates

docs/toolhive/guides-registry/intro.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,5 @@ The server supports five registry source types:
101101

102102
- [Configure registry sources](./configuration.mdx) to set up your registry
103103
- [Deploy the server](./deployment.mdx) in your environment
104+
- [View the API reference](../reference/registry-api.mdx) for endpoint
105+
documentation
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry API reference
3+
description: Reference documentation for the ToolHive Registry Server REST API
4+
hide_table_of_contents: true
5+
---
6+
7+
import ApiDocMdx from '@theme/ApiDocMdx';
8+
9+
<ApiDocMdx id='toolhive-registry-api' />

docusaurus.config.ts

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,19 @@ const config: Config = {
114114
normalizeUrl: false,
115115
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
116116
},
117+
{
118+
id: 'toolhive-registry-api',
119+
spec: 'https://cdn.jsdelivr.net/gh/stacklok/toolhive-registry-server@latest/docs/thv-registry-api/swagger.yaml',
120+
config: path.join(__dirname, 'src/redocly/redocly-toolhive.yaml'),
121+
},
117122
],
118123
theme: {
119124
primaryColor: '#2809a5',
120125
primaryColorDark: '#7ab7ff',
126+
options: {
127+
sortTagsAlphabetically: true,
128+
sortOperationsAlphabetically: true,
129+
},
121130
},
122131
},
123132
],
@@ -202,13 +211,17 @@ const config: Config = {
202211
label: 'ToolHive API',
203212
to: 'toolhive/reference/api',
204213
},
214+
{
215+
label: 'ToolHive Operator CRD',
216+
to: 'toolhive/reference/crd-spec',
217+
},
205218
{
206219
label: 'ToolHive Registry schema',
207220
to: 'toolhive/reference/registry-schema',
208221
},
209222
{
210-
label: 'ToolHive Operator CRD',
211-
to: 'toolhive/reference/crd-spec',
223+
label: 'ToolHive Registry API',
224+
to: 'toolhive/reference/registry-api',
212225
},
213226
],
214227
},

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ const sidebars: SidebarsConfig = {
198198
'toolhive/guides-registry/authentication',
199199
'toolhive/guides-registry/database',
200200
'toolhive/guides-registry/deployment',
201+
'toolhive/reference/registry-api',
201202
],
202203
},
203204

0 commit comments

Comments
 (0)