Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/_docs/concepts/cueweb-rest-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,18 +180,36 @@ graph TD

The REST Gateway exposes all OpenCue gRPC interfaces:

#### Core Interfaces

| Interface | Description | Example Endpoints |
|-----------|-------------|-------------------|
| **ShowInterface** | Project management | `GetShows`, `FindShow`, `CreateShow` |
| **JobInterface** | Job lifecycle | `GetJobs`, `Kill`, `Pause`, `Resume` |
| **FrameInterface** | Frame operations | `GetFrame`, `Retry`, `Kill`, `Eat` |
| **LayerInterface** | Layer management | `GetLayer`, `GetFrames`, `Kill` |
| **GroupInterface** | Resource groups | `GetGroup`, `SetMinCores`, `SetMaxCores` |
| **HostInterface** | Host management | `GetHosts`, `Lock`, `Unlock` |
| **HostInterface** | Host management | `GetHosts`, `Lock`, `Unlock`, `AddTags` |
| **OwnerInterface** | Resource ownership | `GetOwner`, `TakeOwnership` |
| **ProcInterface** | Process control | `GetProc`, `Kill`, `Unbook` |
| **DeedInterface** | Resource deeds | `GetOwner`, `GetHost` |

#### Management Interfaces

| Interface | Description | Example Endpoints |
|-----------|-------------|-------------------|
| **AllocationInterface** | Resource allocation | `GetAll`, `Find`, `SetBillable` |
| **FacilityInterface** | Multi-site facilities | `Get`, `Create`, `GetAllocations` |
| **FilterInterface** | Job filtering | `FindFilter`, `GetActions`, `SetEnabled` |
| **ActionInterface** | Filter actions | `Delete`, `Commit` |
| **MatcherInterface** | Filter matchers | `Delete`, `Commit` |
| **DependInterface** | Dependencies | `GetDepend`, `Satisfy`, `Unsatisfy` |
| **SubscriptionInterface** | Show subscriptions | `Get`, `Find`, `SetSize`, `SetBurst` |
| **LimitInterface** | Resource limits | `GetAll`, `Create`, `SetMaxValue` |
| **ServiceInterface** | Service definitions | `GetService`, `CreateService`, `Update` |
| **ServiceOverrideInterface** | Service overrides | `Update`, `Delete` |
| **TaskInterface** | Task management | `Delete`, `SetMinCores` |

### Real-time Updates

CueWeb implements automatic updates through:
Expand Down
22 changes: 18 additions & 4 deletions docs/_docs/developer-guide/rest-gateway-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,19 +272,33 @@ go tool cover -html=coverage.out -o coverage.html

### Integration Tests

The gateway includes comprehensive integration tests:
The gateway includes comprehensive integration tests that verify all OpenCue interfaces:

```bash
# Run integration tests (requires running Cuebot)
go test -tags=integration .
# Automated Docker-based integration tests (recommended)
cd rest_gateway/opencue_gateway
./run_docker_integration_tests.sh

# Manual: Run integration tests (requires running Cuebot and REST Gateway)
go test -tags=integration -v

# Run specific test function
go test -run TestRegisteredEndpoints
go test -tags=integration -run TestIntegration_ShowInterface

# Run tests with race detection
go test -race .

# Run benchmarks
go test -bench=. -tags=integration
```

The automated script (`run_docker_integration_tests.sh`) handles:
- Starting the OpenCue stack
- Generating JWT secrets
- Building and starting the REST Gateway
- Running all integration tests
- Cleanup

### Load Testing

Test gateway performance:
Expand Down
4 changes: 2 additions & 2 deletions docs/_docs/getting-started/deploying-rest-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ cd rest_gateway

This script will:
- Automatically generate JWT tokens
- Test all OpenCue interfaces (Show, Job, Frame, Layer, Group, Host, Owner, Proc, Deed)
- Test all OpenCue interfaces (Show, Job, Frame, Layer, Group, Host, Owner, Proc, Deed, Comment, Allocation, Facility, Filter, Action, Matcher, Depend, Subscription, Limit, Service, ServiceOverride, Task)
- Verify different endpoints
- Display results for each test

Expand Down Expand Up @@ -377,7 +377,7 @@ cd rest_gateway
./test_rest_gateway_docker_compose.sh
```

This script tests all available endpoints across 9 OpenCue interfaces and provides detailed results.
This script tests all available endpoints across the OpenCue interfaces and provides detailed results.

### Basic Functionality Test

Expand Down
Loading