Skip to content

Commit 4741c8b

Browse files
kysrpexkysrpex
committed
Merge branch 'job_files_fastapi_migration' into arc
2 parents 5d19724 + 071d2d5 commit 4741c8b

File tree

4 files changed

+609
-166
lines changed

4 files changed

+609
-166
lines changed

‎client/src/api/schema/schema.ts‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3045,6 +3045,44 @@ export interface paths {
30453045
patch?: never;
30463046
trace?: never;
30473047
};
3048+
"/api/jobs/{job_id}/files": {
3049+
parameters: {
3050+
query?: never;
3051+
header?: never;
3052+
path?: never;
3053+
cookie?: never;
3054+
};
3055+
/**
3056+
* Get a file required to staging a job.
3057+
* @description Get a file required to staging a job (proper datasets, extra inputs, task-split inputs, working directory
3058+
* files).
3059+
*
3060+
* This API method is intended only for consumption by job runners, not end users.
3061+
*/
3062+
get: operations["index_api_jobs__job_id__files_get"];
3063+
put?: never;
3064+
/**
3065+
* Populate an output file.
3066+
* @description Populate an output file (formal dataset, task split part, working directory file (such as those related to
3067+
* metadata). This should be a multipart POST with a 'file' parameter containing the contents of the actual file to
3068+
* create.
3069+
*
3070+
* This API method is intended only for consumption by job runners, not end users.
3071+
*/
3072+
post: operations["create_api_jobs__job_id__files_post"];
3073+
delete?: never;
3074+
options?: never;
3075+
/**
3076+
* Get a file required to staging a job.
3077+
* @description Get a file required to staging a job (proper datasets, extra inputs, task-split inputs, working directory
3078+
* files).
3079+
*
3080+
* This API method is intended only for consumption by job runners, not end users.
3081+
*/
3082+
head: operations["index_api_jobs__job_id__files_head"];
3083+
patch?: never;
3084+
trace?: never;
3085+
};
30483086
"/api/jobs/{job_id}/inputs": {
30493087
parameters: {
30503088
query?: never;
@@ -6680,6 +6718,34 @@ export interface components {
66806718
/** Name */
66816719
name?: unknown;
66826720
};
6721+
/** Body_create_api_jobs__job_id__files_post */
6722+
Body_create_api_jobs__job_id__files_post: {
6723+
/**
6724+
* File
6725+
* Format: binary
6726+
*/
6727+
__file?: string;
6728+
/** File Path */
6729+
__file_path?: string;
6730+
/**
6731+
* File
6732+
* Format: binary
6733+
* @description Contents of the file to create.
6734+
*/
6735+
file?: string;
6736+
/**
6737+
* Job Key
6738+
* @description A key used to authenticate this request as acting on behalf or a job runner for the specified job.
6739+
*/
6740+
job_key?: string | null;
6741+
/**
6742+
* Path
6743+
* @description Path to file to create.
6744+
*/
6745+
path?: string | null;
6746+
/** Session Id */
6747+
session_id?: string;
6748+
};
66836749
/** Body_create_form_api_libraries__library_id__contents_post */
66846750
Body_create_form_api_libraries__library_id__contents_post: {
66856751
/** Create Type */
@@ -31495,6 +31561,171 @@ export interface operations {
3149531561
};
3149631562
};
3149731563
};
31564+
index_api_jobs__job_id__files_get: {
31565+
parameters: {
31566+
query: {
31567+
/** @description Path to file. */
31568+
path: string;
31569+
/** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job. */
31570+
job_key: string;
31571+
};
31572+
header?: {
31573+
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
31574+
"run-as"?: string | null;
31575+
};
31576+
path: {
31577+
/** @description Encoded id string of the job. */
31578+
job_id: string;
31579+
};
31580+
cookie?: never;
31581+
};
31582+
requestBody?: never;
31583+
responses: {
31584+
/** @description Contents of file. */
31585+
200: {
31586+
headers: {
31587+
[name: string]: unknown;
31588+
};
31589+
content: {
31590+
"application/octet-stream": unknown;
31591+
};
31592+
};
31593+
/** @description File not found, path does not refer to a file, or input dataset(s) for job have been purged. */
31594+
400: {
31595+
headers: {
31596+
[name: string]: unknown;
31597+
};
31598+
content?: never;
31599+
};
31600+
/** @description Request Error */
31601+
"4XX": {
31602+
headers: {
31603+
[name: string]: unknown;
31604+
};
31605+
content: {
31606+
"application/json": components["schemas"]["MessageExceptionModel"];
31607+
};
31608+
};
31609+
/** @description Server Error */
31610+
"5XX": {
31611+
headers: {
31612+
[name: string]: unknown;
31613+
};
31614+
content: {
31615+
"application/json": components["schemas"]["MessageExceptionModel"];
31616+
};
31617+
};
31618+
};
31619+
};
31620+
create_api_jobs__job_id__files_post: {
31621+
parameters: {
31622+
query?: {
31623+
/** @description Path to file to create. */
31624+
path?: string | null;
31625+
/** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job. */
31626+
job_key?: string | null;
31627+
};
31628+
header?: {
31629+
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
31630+
"run-as"?: string | null;
31631+
};
31632+
path: {
31633+
/** @description Encoded id string of the job. */
31634+
job_id: string;
31635+
};
31636+
cookie?: never;
31637+
};
31638+
requestBody?: {
31639+
content: {
31640+
"multipart/form-data": components["schemas"]["Body_create_api_jobs__job_id__files_post"];
31641+
};
31642+
};
31643+
responses: {
31644+
/** @description An okay message. */
31645+
200: {
31646+
headers: {
31647+
[name: string]: unknown;
31648+
};
31649+
content: {
31650+
"application/json": unknown;
31651+
};
31652+
};
31653+
/** @description Request Error */
31654+
"4XX": {
31655+
headers: {
31656+
[name: string]: unknown;
31657+
};
31658+
content: {
31659+
"application/json": components["schemas"]["MessageExceptionModel"];
31660+
};
31661+
};
31662+
/** @description Server Error */
31663+
"5XX": {
31664+
headers: {
31665+
[name: string]: unknown;
31666+
};
31667+
content: {
31668+
"application/json": components["schemas"]["MessageExceptionModel"];
31669+
};
31670+
};
31671+
};
31672+
};
31673+
index_api_jobs__job_id__files_head: {
31674+
parameters: {
31675+
query: {
31676+
/** @description Path to file. */
31677+
path: string;
31678+
/** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job. */
31679+
job_key: string;
31680+
};
31681+
header?: {
31682+
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
31683+
"run-as"?: string | null;
31684+
};
31685+
path: {
31686+
/** @description Encoded id string of the job. */
31687+
job_id: string;
31688+
};
31689+
cookie?: never;
31690+
};
31691+
requestBody?: never;
31692+
responses: {
31693+
/** @description Contents of file. */
31694+
200: {
31695+
headers: {
31696+
[name: string]: unknown;
31697+
};
31698+
content: {
31699+
"application/octet-stream": unknown;
31700+
};
31701+
};
31702+
/** @description File not found, path does not refer to a file, or input dataset(s) for job have been purged. */
31703+
400: {
31704+
headers: {
31705+
[name: string]: unknown;
31706+
};
31707+
content?: never;
31708+
};
31709+
/** @description Request Error */
31710+
"4XX": {
31711+
headers: {
31712+
[name: string]: unknown;
31713+
};
31714+
content: {
31715+
"application/json": components["schemas"]["MessageExceptionModel"];
31716+
};
31717+
};
31718+
/** @description Server Error */
31719+
"5XX": {
31720+
headers: {
31721+
[name: string]: unknown;
31722+
};
31723+
content: {
31724+
"application/json": components["schemas"]["MessageExceptionModel"];
31725+
};
31726+
};
31727+
};
31728+
};
3149831729
get_inputs_api_jobs__job_id__inputs_get: {
3149931730
parameters: {
3150031731
query?: never;

0 commit comments

Comments
 (0)