lexicon
com.fedfork.exec.ops.getBidder
query HTTP GET /xrpc/com.fedfork.exec.ops.getBidder
A bidder answers its readiness: its MarketIdentity (status phase, pendingAction kind and reason only, conditions type, status and reason), its Bidder component (spec.policy) and its MarketBidder root (status phase and did); each null when absent. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.
definitions: #meta #identity #identityStatus #pendingAction #condition #bidder #bidderSpec #marketBidder #marketBidderStatus
output
encoding application/json
errors
| error | description |
|---|
AuthenticationRequired | 401: the ops read secret is missing or wrong. |
Unavailable | 503: the bidder's objects are not readable yet. |
ReadFailed | 502: the read failed; the host's log has the detail. |
| field | type | description |
|---|
name * | string | |
deletionTimestamp | string datetime | |
| field | type | description |
|---|
kind * | string | |
reason | string | |
| field | type | description |
|---|
type * | string | |
status * | string | |
reason | string | |
| field | type | description |
|---|
policy | string | |
| field | type | description |
|---|
phase | string | |
did | string did | |
used in
no page of these docs names it yet.
raw schema: lexicons/com/fedfork/exec/ops/getBidder.json
{
"lexicon": 1,
"id": "com.fedfork.exec.ops.getBidder",
"defs": {
"main": {
"type": "query",
"description": "A bidder answers its readiness: its MarketIdentity (status phase, pendingAction kind and reason only, conditions type, status and reason), its Bidder component (spec.policy) and its MarketBidder root (status phase and did); each null when absent. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.",
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"identity",
"bidder",
"marketBidder"
],
"nullable": [
"identity",
"bidder",
"marketBidder"
],
"properties": {
"identity": {
"type": "ref",
"ref": "#identity"
},
"bidder": {
"type": "ref",
"ref": "#bidder"
},
"marketBidder": {
"type": "ref",
"ref": "#marketBidder"
}
}
}
},
"errors": [
{
"name": "AuthenticationRequired",
"description": "401: the ops read secret is missing or wrong."
},
{
"name": "Unavailable",
"description": "503: the bidder's objects are not readable yet."
},
{
"name": "ReadFailed",
"description": "502: the read failed; the host's log has the detail."
}
]
},
"meta": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"deletionTimestamp": {
"type": "string",
"format": "datetime"
}
}
},
"identity": {
"type": "object",
"required": [
"metadata",
"status"
],
"properties": {
"metadata": {
"type": "ref",
"ref": "#meta"
},
"status": {
"type": "ref",
"ref": "#identityStatus"
}
}
},
"identityStatus": {
"type": "object",
"properties": {
"phase": {
"type": "string"
},
"pendingAction": {
"type": "ref",
"ref": "#pendingAction"
},
"conditions": {
"type": "array",
"items": {
"type": "ref",
"ref": "#condition"
}
}
}
},
"pendingAction": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"condition": {
"type": "object",
"required": [
"type",
"status"
],
"properties": {
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"bidder": {
"type": "object",
"required": [
"metadata",
"spec"
],
"properties": {
"metadata": {
"type": "ref",
"ref": "#meta"
},
"spec": {
"type": "ref",
"ref": "#bidderSpec"
}
}
},
"bidderSpec": {
"type": "object",
"properties": {
"policy": {
"type": "string"
}
}
},
"marketBidder": {
"type": "object",
"required": [
"metadata",
"status"
],
"properties": {
"metadata": {
"type": "ref",
"ref": "#meta"
},
"status": {
"type": "ref",
"ref": "#marketBidderStatus"
}
}
},
"marketBidderStatus": {
"type": "object",
"properties": {
"phase": {
"type": "string"
},
"did": {
"type": "string",
"format": "did"
}
}
}
}
}