Skip to content

Commit a8fca3a

Browse files
markgeejwmarkgeejw
committed
add getdesign
1 parent d9aa7db commit a8fca3a

File tree

1 file changed

+247
-0
lines changed

1 file changed

+247
-0
lines changed

‎source/_static/js/designSpec.js‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2882,6 +2882,166 @@ const designSpec = {
28822882
p: "designBoltzGen",
28832883
},
28842884
},
2885+
"/api/v1/design/{job_id}": {
2886+
get: {
2887+
tags: ["structure generation"],
2888+
summary: "Get structure generate request metadata",
2889+
description: "Get metadata about structure generate request.\n",
2890+
parameters: [
2891+
{
2892+
name: "job_id",
2893+
in: "path",
2894+
description: "Job ID of design request",
2895+
required: true,
2896+
schema: {
2897+
type: "string",
2898+
format: "uuid",
2899+
},
2900+
},
2901+
],
2902+
responses: {
2903+
"200": {
2904+
description: "Structure generate metadata successfully returned.",
2905+
content: {
2906+
"application/json": {
2907+
schema: {
2908+
title: "StructureGenerate",
2909+
description: "Structure generate request metadata.",
2910+
type: "object",
2911+
required: [
2912+
"job_id",
2913+
"prerequisite_job_id",
2914+
"created_date",
2915+
"start_date",
2916+
"end_date",
2917+
"status",
2918+
"progress_counter",
2919+
"model_id",
2920+
],
2921+
properties: {
2922+
job_id: {
2923+
title: "JobID",
2924+
description: "ID of job.",
2925+
type: "string",
2926+
format: "uuid",
2927+
"x-order": 1,
2928+
},
2929+
prerequisite_job_id: {
2930+
title: "PrerequisiteJobID",
2931+
description: "Prerequisite job ID.",
2932+
type: "string",
2933+
format: "uuid",
2934+
nullable: true,
2935+
default: null,
2936+
example: null,
2937+
"x-order": 2,
2938+
},
2939+
created_date: {
2940+
title: "Created Date",
2941+
description: "Datetime of created object",
2942+
type: "string",
2943+
format: "date-time",
2944+
example: "2024-01-01T12:34:56.789Z",
2945+
"x-order": 4,
2946+
},
2947+
start_date: {
2948+
title: "StartDate",
2949+
description: "Start date of job.",
2950+
type: "string",
2951+
format: "date-time",
2952+
nullable: true,
2953+
example: null,
2954+
default: null,
2955+
"x-order": 5,
2956+
},
2957+
end_date: {
2958+
title: "EndDate",
2959+
description: "End date of job.",
2960+
type: "string",
2961+
format: "date-time",
2962+
nullable: true,
2963+
example: null,
2964+
default: null,
2965+
"x-order": 6,
2966+
},
2967+
status: {
2968+
title: "JobStatus",
2969+
description: "Status of job.",
2970+
type: "string",
2971+
enum: ["PENDING", "RUNNING", "SUCCESS", "FAILURE"],
2972+
"x-order": 7,
2973+
},
2974+
progress_counter: {
2975+
title: "ProgressCounter",
2976+
description:
2977+
"Counter of the progress of job from 0 to 100.",
2978+
type: "integer",
2979+
minimum: 0,
2980+
maximum: 100,
2981+
example: 0,
2982+
default: 0,
2983+
"x-order": 8,
2984+
},
2985+
model_id: {
2986+
type: "string",
2987+
example: "rfdiffusion",
2988+
},
2989+
args: {
2990+
type: "object",
2991+
additionalProperties: true,
2992+
},
2993+
},
2994+
},
2995+
},
2996+
},
2997+
},
2998+
"401": {
2999+
description:
3000+
"Bad or expired token. This can happen if the token is revoked or expired. User should re-authenticate with their credentials.",
3001+
content: {
3002+
"application/json": {
3003+
schema: {
3004+
title: "Error",
3005+
description: "A error object providing details of the error.",
3006+
required: ["detail"],
3007+
type: "object",
3008+
properties: {
3009+
detail: {
3010+
title: "Detail",
3011+
type: "string",
3012+
},
3013+
},
3014+
},
3015+
},
3016+
},
3017+
},
3018+
"404": {
3019+
description: "Design job not found.",
3020+
content: {
3021+
"application/json": {
3022+
schema: {
3023+
title: "Error",
3024+
description: "A error object providing details of the error.",
3025+
required: ["detail"],
3026+
type: "object",
3027+
properties: {
3028+
detail: {
3029+
title: "Detail",
3030+
type: "string",
3031+
},
3032+
},
3033+
},
3034+
},
3035+
},
3036+
},
3037+
},
3038+
security: [
3039+
{
3040+
oauth2: [],
3041+
},
3042+
],
3043+
},
3044+
},
28853045
},
28863046
components: {
28873047
securitySchemes: {
@@ -4507,6 +4667,93 @@ const designSpec = {
45074667
},
45084668
},
45094669
},
4670+
StructureGenerate: {
4671+
title: "StructureGenerate",
4672+
description: "Structure generate request metadata.",
4673+
type: "object",
4674+
required: [
4675+
"job_id",
4676+
"prerequisite_job_id",
4677+
"created_date",
4678+
"start_date",
4679+
"end_date",
4680+
"status",
4681+
"progress_counter",
4682+
"model_id",
4683+
],
4684+
properties: {
4685+
job_id: {
4686+
title: "JobID",
4687+
description: "ID of job.",
4688+
type: "string",
4689+
format: "uuid",
4690+
"x-order": 1,
4691+
},
4692+
prerequisite_job_id: {
4693+
title: "PrerequisiteJobID",
4694+
description: "Prerequisite job ID.",
4695+
type: "string",
4696+
format: "uuid",
4697+
nullable: true,
4698+
default: null,
4699+
example: null,
4700+
"x-order": 2,
4701+
},
4702+
created_date: {
4703+
title: "Created Date",
4704+
description: "Datetime of created object",
4705+
type: "string",
4706+
format: "date-time",
4707+
example: "2024-01-01T12:34:56.789Z",
4708+
"x-order": 4,
4709+
},
4710+
start_date: {
4711+
title: "StartDate",
4712+
description: "Start date of job.",
4713+
type: "string",
4714+
format: "date-time",
4715+
nullable: true,
4716+
example: null,
4717+
default: null,
4718+
"x-order": 5,
4719+
},
4720+
end_date: {
4721+
title: "EndDate",
4722+
description: "End date of job.",
4723+
type: "string",
4724+
format: "date-time",
4725+
nullable: true,
4726+
example: null,
4727+
default: null,
4728+
"x-order": 6,
4729+
},
4730+
status: {
4731+
title: "JobStatus",
4732+
description: "Status of job.",
4733+
type: "string",
4734+
enum: ["PENDING", "RUNNING", "SUCCESS", "FAILURE"],
4735+
"x-order": 7,
4736+
},
4737+
progress_counter: {
4738+
title: "ProgressCounter",
4739+
description: "Counter of the progress of job from 0 to 100.",
4740+
type: "integer",
4741+
minimum: 0,
4742+
maximum: 100,
4743+
example: 0,
4744+
default: 0,
4745+
"x-order": 8,
4746+
},
4747+
model_id: {
4748+
type: "string",
4749+
example: "rfdiffusion",
4750+
},
4751+
args: {
4752+
type: "object",
4753+
additionalProperties: true,
4754+
},
4755+
},
4756+
},
45104757
},
45114758
},
45124759
tags: [

0 commit comments

Comments
 (0)