Skip to content

Commit 9ef9d68

Browse files
committed
coretime docs updated
1 parent 87c6575 commit 9ef9d68

File tree

1 file changed

+219
-10
lines changed

1 file changed

+219
-10
lines changed

docs/src/openapi-v1.yaml

Lines changed: 219 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,21 +1088,16 @@ paths:
10881088
schema:
10891089
pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}'
10901090
type: string
1091-
- name: core
1092-
in: query
1093-
description: Core identifier.
1094-
required: false
1095-
schema:
1096-
pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}'
1097-
type: string
10981091
operationId: getCoretimeInfo
10991092
responses:
11001093
"200":
11011094
description: successful operation
11021095
content:
11031096
application/json:
11041097
schema:
1105-
$ref: '#/components/schemas/BlockRaw'
1098+
oneOf:
1099+
- $ref: '#/components/schemas/CoretimeChainInfoResponse'
1100+
- $ref: '#/components/schemas/CoretimeRelayInfoResponse'
11061101
/coretime/cores:
11071102
get:
11081103
tags:
@@ -1118,13 +1113,22 @@ paths:
11181113
schema:
11191114
pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}'
11201115
type: string
1116+
- name: coreId
1117+
in: query
1118+
description: Core identifier.
1119+
required: false
1120+
schema:
1121+
pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}'
1122+
type: string
11211123
responses:
11221124
"200":
11231125
description: successful operation
11241126
content:
11251127
application/json:
11261128
schema:
1127-
$ref: '#/components/schemas/BlockRaw'
1129+
oneOf:
1130+
- $ref: '#/components/schemas/CoretimeChainCoresResponse'
1131+
- $ref: '#/components/schemas/CoretimeRelayCoresResponse'
11281132
/node/network:
11291133
get:
11301134
tags:
@@ -3212,7 +3216,212 @@ components:
32123216
type: array
32133217
items:
32143218
$ref: '#/components/schemas/CoretimeRenewal'
3215-
# TODO: info, cores
3219+
CoretimeChainInfoResponse:
3220+
type: object
3221+
properties:
3222+
at:
3223+
$ref: '#/components/schemas/BlockIdentifiers'
3224+
configuration:
3225+
$ref: '#/components/schemas/CoretimeConfig'
3226+
saleInfo:
3227+
$ref: '#/components/schemas/CoretimeSaleInfo'
3228+
CoretimeRelayInfoResponse:
3229+
type: object
3230+
properties:
3231+
at:
3232+
$ref: '#/components/schemas/BlockIdentifiers'
3233+
brokerId:
3234+
type: string
3235+
description: The broker parachain id.
3236+
palletVersion:
3237+
type: string
3238+
description: The pallet version.
3239+
maxHistoricalRevenue:
3240+
type: string
3241+
description: The maximum historical revenue.
3242+
CoretimeChainCoresResponse:
3243+
type: object
3244+
properties:
3245+
at:
3246+
$ref: '#/components/schemas/BlockIdentifiers'
3247+
cores:
3248+
type: array
3249+
items:
3250+
$ref: '#/components/schemas/CoretimeCore'
3251+
CoretimeRelayCoresResponse:
3252+
type: object
3253+
properties:
3254+
at:
3255+
$ref: '#/components/schemas/BlockIdentifiers'
3256+
cores:
3257+
type: array
3258+
items:
3259+
$ref: '#/components/schemas/CoretimeRelayCoreDescriptor'
3260+
CoretimeRelayCoreDescriptor:
3261+
type: object
3262+
properties:
3263+
paraId:
3264+
type: string
3265+
description: The parachain id.
3266+
type:
3267+
type: string
3268+
description: The parachain type.
3269+
info:
3270+
type: object
3271+
properties:
3272+
currentWork:
3273+
type: object
3274+
properties:
3275+
assignments:
3276+
type: array
3277+
items:
3278+
type: object
3279+
properties:
3280+
isPool:
3281+
type: boolean
3282+
description: Whether the workload is a pool.
3283+
isTask:
3284+
type: boolean
3285+
description: Whether the workload is a task.
3286+
ratio:
3287+
type: string
3288+
description: The ratio of the workload.
3289+
remaining:
3290+
type: string
3291+
description: The remaining workload.
3292+
task:
3293+
type: string
3294+
description: The parachain id.
3295+
endHint:
3296+
type: string
3297+
description: The end hint.
3298+
pos:
3299+
type: string
3300+
description: The position.
3301+
step:
3302+
type: string
3303+
description: The step.
3304+
queue:
3305+
type: object
3306+
properties:
3307+
first:
3308+
type: string
3309+
description: The first assignment in queue.
3310+
last:
3311+
type: string
3312+
description: The last assignment in queue.
3313+
CoretimeCore:
3314+
type: object
3315+
properties:
3316+
coreId:
3317+
type: string
3318+
description: The core id.
3319+
taskId:
3320+
type: string
3321+
description: The parachain core.
3322+
workload:
3323+
type: object
3324+
$ref: '#/components/schemas/CoretimeWorkload'
3325+
type:
3326+
description: The paid price.
3327+
type: object
3328+
properties:
3329+
condition:
3330+
type: string
3331+
description: Type of assignment.
3332+
details:
3333+
type: object
3334+
oneOf:
3335+
- $ref: '#/components/schemas/CoretimeUntil'
3336+
- $ref: '#/components/schemas/CoretimeMask'
3337+
regions:
3338+
type: array
3339+
items:
3340+
$ref: '#/components/schemas/CoretimeRegion'
3341+
CoretimeConfig:
3342+
type: object
3343+
properties:
3344+
advanceNotice:
3345+
type: string
3346+
description: The advance notice.
3347+
interludeLength:
3348+
type: string
3349+
description: The interlude length.
3350+
leadinLength:
3351+
type: string
3352+
description: The leadin length.
3353+
regionLength:
3354+
type: string
3355+
description: The region length.
3356+
idealBulkProportion:
3357+
type: string
3358+
description: The ideal bulk proportion.
3359+
renewalBump:
3360+
type: string
3361+
description: The renewal bump.
3362+
contributionTimeout:
3363+
type: string
3364+
description: The contribution timeout.
3365+
CoretimeSaleInfo:
3366+
type: object
3367+
properties:
3368+
phase:
3369+
type: string
3370+
description: The phase of the sale.
3371+
saleStart:
3372+
type: string
3373+
description: The sale start.
3374+
leadinLength:
3375+
type: string
3376+
description: The leading length.
3377+
endPrice:
3378+
type: string
3379+
description: The end price.
3380+
regionBegin:
3381+
type: string
3382+
description: The region start time.
3383+
regionEnd:
3384+
type: string
3385+
description: The region end time.
3386+
idealCoresSold:
3387+
type: string
3388+
description: The ideal number of cores sold.
3389+
coresOffered:
3390+
type: string
3391+
description: The number of cores on sale.
3392+
firstCore:
3393+
type: string
3394+
description: The first core id.
3395+
selloutPrice:
3396+
type: string
3397+
description: The sellout price.
3398+
coresSold:
3399+
type: string
3400+
description: The number of cores sold.
3401+
RelayBlocksPerTimeslice:
3402+
type: string
3403+
description: The number of relay chain blocks per timeslice.
3404+
CoretimeMask:
3405+
type: string
3406+
description: The mask.
3407+
CoretimeUntil:
3408+
type: string
3409+
description: The lease expiry time.
3410+
CoretimeWorkload:
3411+
type: object
3412+
properties:
3413+
isPool:
3414+
type: boolean
3415+
description: Whether the workload is a pool.
3416+
isTask:
3417+
type: boolean
3418+
description: Whether the workload is a task.
3419+
mask:
3420+
type: string
3421+
description: The mask.
3422+
task:
3423+
type: string
3424+
description: The parachain id.
32163425
CoretimeRegion:
32173426
type: object
32183427
properties:

0 commit comments

Comments
 (0)