Skip to content

Commit c895c53

Browse files
github-actions[bot]github-actions[bot]
authored
Update ToolHive reference docs for toolhive-operator-crds-0.0.30
1 parent 3235215 commit c895c53

File tree

1 file changed

+86
-7
lines changed

1 file changed

+86
-7
lines changed

‎static/api-specs/toolhive-crd-api.md‎

Lines changed: 86 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,46 @@ Package v1alpha1 contains API Schema definitions for the toolhive v1alpha1 API g
1717

1818

1919

20+
#### APIPhase
21+
22+
_Underlying type:_ _string_
23+
24+
APIPhase represents the API service state
25+
26+
_Validation:_
27+
- Enum: [NotStarted Deploying Ready Unhealthy Error]
28+
29+
_Appears in:_
30+
- [APIStatus](#apistatus)
31+
32+
| Field | Description |
33+
| --- | --- |
34+
| `NotStarted` | APIPhaseNotStarted means API deployment has not been created<br /> |
35+
| `Deploying` | APIPhaseDeploying means API is being deployed<br /> |
36+
| `Ready` | APIPhaseReady means API is ready to serve requests<br /> |
37+
| `Unhealthy` | APIPhaseUnhealthy means API is deployed but not healthy<br /> |
38+
| `Error` | APIPhaseError means API deployment failed<br /> |
39+
40+
41+
#### APIStatus
42+
43+
44+
45+
APIStatus provides detailed information about the API service
46+
47+
48+
49+
_Appears in:_
50+
- [MCPRegistryStatus](#mcpregistrystatus)
51+
52+
| Field | Description | Default | Validation |
53+
| --- | --- | --- | --- |
54+
| `phase` _[APIPhase](#apiphase)_ | Phase represents the current API service phase | | Enum: [NotStarted Deploying Ready Unhealthy Error] <br /> |
55+
| `message` _string_ | Message provides additional information about the API status | | |
56+
| `endpoint` _string_ | Endpoint is the URL where the API is accessible | | |
57+
| `readySince` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | ReadySince is the timestamp when the API became ready | | |
58+
59+
2060
#### AuditConfig
2161

2262

@@ -303,6 +343,7 @@ _Appears in:_
303343
| `source` _[MCPRegistrySource](#mcpregistrysource)_ | Source defines the configuration for the registry data source | | Required: \{\} <br /> |
304344
| `syncPolicy` _[SyncPolicy](#syncpolicy)_ | SyncPolicy defines the automatic synchronization behavior for the registry.<br />If specified, enables automatic synchronization at the given interval.<br />Manual synchronization is always supported via annotation-based triggers<br />regardless of this setting. | | |
305345
| `filter` _[RegistryFilter](#registryfilter)_ | Filter defines include/exclude patterns for registry content | | |
346+
| `enforceServers` _boolean_ | EnforceServers indicates whether MCPServers in this namespace must have their images<br />present in at least one registry in the namespace. When any registry in the namespace<br />has this field set to true, enforcement is enabled for the entire namespace.<br />MCPServers with images not found in any registry will be rejected.<br />When false (default), MCPServers can be deployed regardless of registry presence. | false | |
306347

307348

308349
#### MCPRegistryStatus
@@ -318,14 +359,10 @@ _Appears in:_
318359

319360
| Field | Description | Default | Validation |
320361
| --- | --- | --- | --- |
321-
| `phase` _[MCPRegistryPhase](#mcpregistryphase)_ | Phase represents the current phase of the MCPRegistry | | Enum: [Pending Ready Failed Syncing Terminating] <br /> |
362+
| `phase` _[MCPRegistryPhase](#mcpregistryphase)_ | Phase represents the current overall phase of the MCPRegistry<br />Derived from sync and API status | | Enum: [Pending Ready Failed Syncing Terminating] <br /> |
322363
| `message` _string_ | Message provides additional information about the current phase | | |
323-
| `lastSyncTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | LastSyncTime is the timestamp of the last successful sync | | |
324-
| `lastSyncHash` _string_ | LastSyncHash is the hash of the last successfully synced data<br />Used to detect changes in source data | | |
325-
| `serverCount` _integer_ | ServerCount is the total number of servers in the registry | | Minimum: 0 <br /> |
326-
| `deployedServerCount` _integer_ | DeployedServerCount is the number of deployed servers with matching labels | | Minimum: 0 <br /> |
327-
| `syncAttempts` _integer_ | SyncAttempts is the number of sync attempts since last success | | Minimum: 0 <br /> |
328-
| `apiEndpoint` _string_ | APIEndpoint is the URL of the registry API service | | |
364+
| `syncStatus` _[SyncStatus](#syncstatus)_ | SyncStatus provides detailed information about data synchronization | | |
365+
| `apiStatus` _[APIStatus](#apistatus)_ | APIStatus provides detailed information about the API service | | |
329366
| `storageRef` _[StorageReference](#storagereference)_ | StorageRef is a reference to the internal storage location | | |
330367
| `lastManualSyncTrigger` _string_ | LastManualSyncTrigger tracks the last processed manual sync annotation value<br />Used to detect new manual sync requests via toolhive.stacklok.dev/sync-trigger annotation | | |
331368
| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#condition-v1-meta) array_ | Conditions represent the latest available observations of the MCPRegistry's state | | |
@@ -832,6 +869,26 @@ _Appears in:_
832869
| `configMapRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#localobjectreference-v1-core)_ | ConfigMapRef is a reference to a ConfigMap storage<br />Only used when Type is "configmap" | | |
833870

834871

872+
#### SyncPhase
873+
874+
_Underlying type:_ _string_
875+
876+
SyncPhase represents the data synchronization state
877+
878+
_Validation:_
879+
- Enum: [Idle Syncing Complete Failed]
880+
881+
_Appears in:_
882+
- [SyncStatus](#syncstatus)
883+
884+
| Field | Description |
885+
| --- | --- |
886+
| `Idle` | SyncPhaseIdle means no sync is needed or scheduled<br /> |
887+
| `Syncing` | SyncPhaseSyncing means sync is currently in progress<br /> |
888+
| `Complete` | SyncPhaseComplete means sync completed successfully<br /> |
889+
| `Failed` | SyncPhaseFailed means sync failed<br /> |
890+
891+
835892
#### SyncPolicy
836893

837894

@@ -851,6 +908,28 @@ _Appears in:_
851908
| `interval` _string_ | Interval is the sync interval for automatic synchronization (Go duration format)<br />Examples: "1h", "30m", "24h" | | Pattern: `^([0-9]+(\.[0-9]+)?(ns\|us\|µs\|ms\|s\|m\|h))+$` <br />Required: \{\} <br /> |
852909

853910

911+
#### SyncStatus
912+
913+
914+
915+
SyncStatus provides detailed information about data synchronization
916+
917+
918+
919+
_Appears in:_
920+
- [MCPRegistryStatus](#mcpregistrystatus)
921+
922+
| Field | Description | Default | Validation |
923+
| --- | --- | --- | --- |
924+
| `phase` _[SyncPhase](#syncphase)_ | Phase represents the current synchronization phase | | Enum: [Idle Syncing Complete Failed] <br /> |
925+
| `message` _string_ | Message provides additional information about the sync status | | |
926+
| `lastAttempt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | LastAttempt is the timestamp of the last sync attempt | | |
927+
| `attemptCount` _integer_ | AttemptCount is the number of sync attempts since last success | | Minimum: 0 <br /> |
928+
| `lastSyncTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | LastSyncTime is the timestamp of the last successful sync | | |
929+
| `lastSyncHash` _string_ | LastSyncHash is the hash of the last successfully synced data<br />Used to detect changes in source data | | |
930+
| `serverCount` _integer_ | ServerCount is the total number of servers in the registry | | Minimum: 0 <br /> |
931+
932+
854933
#### TagFilter
855934

856935

0 commit comments

Comments
 (0)