Skip to content

Commit d772738

Browse files
committed
add iris docs
1 parent cd99aa7 commit d772738

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

.github/workflows/zeusfyi_docs.yml

-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,3 @@ jobs:
4040
--token ${{ secrets.DEPOT_TOKEN }} \
4141
--provenance=false \
4242
-f docker/docusaurus/Dockerfile . --push
43-

.openapi/iris.yaml

+21-3
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ paths:
191191
operationId: proxyGetRequest
192192
parameters:
193193
- $ref: '#/components/parameters/RouteGroupHeader'
194+
- $ref: '#/components/parameters/LoadBalancingStrategyHeader'
195+
- $ref: '#/components/parameters/ServerlessAnvilHeader'
196+
- $ref: '#/components/parameters/AdaptiveMetricsHeader'
194197
responses:
195198
'200':
196199
description: Successfully proxied GET request.
@@ -216,6 +219,11 @@ paths:
216219
servers:
217220
- url: https://iris.zeus.fyi/v1
218221
operationId: proxyPostRequest
222+
parameters:
223+
- $ref: '#/components/parameters/RouteGroupHeader'
224+
- $ref: '#/components/parameters/LoadBalancingStrategyHeader'
225+
- $ref: '#/components/parameters/ServerlessAnvilHeader'
226+
- $ref: '#/components/parameters/AdaptiveMetricsHeader'
219227
requestBody:
220228
required: true
221229
content:
@@ -248,6 +256,11 @@ paths:
248256
- Adaptive Load Balancer
249257
description: Proxies a PUT request to the configured backend service based on the X-Route-Group header and request body.
250258
operationId: proxyPutRequest
259+
parameters:
260+
- $ref: '#/components/parameters/RouteGroupHeader'
261+
- $ref: '#/components/parameters/LoadBalancingStrategyHeader'
262+
- $ref: '#/components/parameters/ServerlessAnvilHeader'
263+
- $ref: '#/components/parameters/AdaptiveMetricsHeader'
251264
requestBody:
252265
required: true
253266
content:
@@ -280,6 +293,11 @@ paths:
280293
servers:
281294
- url: https://iris.zeus.fyi/v1
282295
operationId: proxyDeleteRequest
296+
parameters:
297+
- $ref: '#/components/parameters/RouteGroupHeader'
298+
- $ref: '#/components/parameters/LoadBalancingStrategyHeader'
299+
- $ref: '#/components/parameters/ServerlessAnvilHeader'
300+
- $ref: '#/components/parameters/AdaptiveMetricsHeader'
283301
responses:
284302
'200':
285303
description: Successfully proxied DELETE request.
@@ -490,14 +508,14 @@ components:
490508
RouteGroupHeader:
491509
name: X-Route-Group
492510
in: header
493-
required: true
494-
description: Header specifying the route group for the request.
511+
required: false # Updated to reflect optional status when ServerlessAnvilHeader is used.
512+
description: Header specifying the route group for the request. It becomes optional when the ServerlessAnvilHeader is used.
495513
schema:
496514
type: string
497515
LoadBalancingStrategyHeader:
498516
name: X-Load-Balancing-Strategy
499517
in: header
500-
required: true
518+
required: false
501519
description: Header specifying the load balancing option for the request, else it will default to Adaptive.
502520
schema:
503521
type: string

0 commit comments

Comments
 (0)