Skip to content

Commit

Permalink
Rebuild schema for object store APIs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmchilton
jmchilton committed Sep 7, 2023
1 parent 7ba1321 commit e339fd3
Showing 1 changed file with 282 additions and 1 deletion.
283 changes: 282 additions & 1 deletion client/src/schema/schema.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,22 @@ export interface paths {
*/
delete: operations["delete_user_notification_api_notifications__notification_id__delete"];
};
"/api/object_store_instances": {
/** Get a list of persisted object store instances defined by the requesting user. */
get: operations["object_stores__instances_index"];
/** Create a user-bound object store. */
post: operations["object_stores__create_instance"];
};
"/api/object_store_instances/{user_object_store_id}": {
/** Get a list of persisted object store instances defined by the requesting user. */
get: operations["object_stores__instances_get"];
/** Update or upgrade user object store instance. */
put: operations["object_stores__instances_update"];
};
"/api/object_store_templates": {
/** Get a list of object store templates available to build user defined object stores from */
get: operations["object_stores__templates_index"];
};
"/api/object_stores": {
/** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */
get: operations["index_api_object_stores_get"];
Expand Down Expand Up @@ -2034,7 +2050,7 @@ export interface components {
| "more_stable"
| "less_stable"
)
| ("cloud" | "quota" | "no_quota" | "restricted");
| ("cloud" | "quota" | "no_quota" | "restricted" | "user_defined");
};
/**
* BasicRoleModel
Expand Down Expand Up @@ -2775,6 +2791,25 @@ export interface components {
/** Store Dict */
store_dict?: Record<string, never>;
};
/** CreateInstancePayload */
CreateInstancePayload: {
/** Description */
description?: string;
/** Name */
name: string;
/** Secrets */
secrets: {
[key: string]: string | undefined;
};
/** Template Id */
template_id: string;
/** Template Version */
template_version: number;
/** Variables */
variables: {
[key: string]: (string | boolean | number) | undefined;
};
};
/**
* CreateLibrariesFromStore
* @description Base model definition with common configuration used by all derived models.
Expand Down Expand Up @@ -7490,6 +7525,66 @@ export interface components {
*/
up_to_date: boolean;
};
/** ObjectStoreTemplateSecret */
ObjectStoreTemplateSecret: {
/** Help */
help?: string;
/** Name */
name: string;
};
/**
* ObjectStoreTemplateSummaries
* @description Represents a collection of ObjectStoreTemplate summaries.
*/
ObjectStoreTemplateSummaries: components["schemas"]["ObjectStoreTemplateSummary"][];
/**
* ObjectStoreTemplateSummary
* @description Version of ObjectStoreTemplate we can send to the UI/API.
*
* The configuration key in the child type may have secretes
* and shouldn't be exposed over the API - at least to non-admins.
*/
ObjectStoreTemplateSummary: {
/** Badges */
badges: components["schemas"]["BadgeDict"][];
/** Description */
description?: string;
/**
* Hidden
* @default false
*/
hidden?: boolean;
/** Id */
id: string;
/** Name */
name?: string;
/** Secrets */
secrets?: components["schemas"]["ObjectStoreTemplateSecret"][];
/**
* Type
* @enum {string}
*/
type: "s3" | "azure_blob" | "disk" | "generic_s3";
/** Variables */
variables?: components["schemas"]["ObjectStoreTemplateVariable"][];
/**
* Version
* @default 0
*/
version?: number;
};
/** ObjectStoreTemplateVariable */
ObjectStoreTemplateVariable: {
/** Help */
help?: string;
/** Name */
name: string;
/**
* Type
* @enum {string}
*/
type: "string" | "boolean" | "integer";
};
/** Organization */
Organization: {
/**
Expand Down Expand Up @@ -8977,6 +9072,24 @@ export interface components {
*/
visible?: boolean;
};
/** UpdateInstancePayload */
UpdateInstancePayload: {
/** Description */
description?: string;
/** Name */
name?: string;
/** Variables */
variables?: {
[key: string]: (string | boolean | number) | undefined;
};
};
/** UpdateInstanceSecretPayload */
UpdateInstanceSecretPayload: {
/** Secret Name */
secret_name: string;
/** Secret Value */
secret_value: string;
};
/**
* UpdateLibraryFolderPayload
* @description Base model definition with common configuration used by all derived models.
Expand Down Expand Up @@ -9085,6 +9198,19 @@ export interface components {
[key: string]: components["schemas"]["NotificationCategorySettings"] | undefined;
};
};
/** UpgradeInstancePayload */
UpgradeInstancePayload: {
/** Secrets */
secrets: {
[key: string]: string | undefined;
};
/** Template Version */
template_version: number;
/** Variables */
variables: {
[key: string]: (string | boolean | number) | undefined;
};
};
/**
* UrlDataElement
* @description Base model definition with common configuration used by all derived models.
Expand Down Expand Up @@ -9157,6 +9283,37 @@ export interface components {
*/
enabled: boolean;
};
/** UserConcreteObjectStoreModel */
UserConcreteObjectStoreModel: {
/** Badges */
badges: components["schemas"]["BadgeDict"][];
/** Description */
description?: string;
/** Id */
id: number;
/** Name */
name?: string;
/** Object Store Id */
object_store_id?: string;
/** Private */
private: boolean;
quota: components["schemas"]["QuotaModel"];
/** Secrets */
secrets: string[];
/** Template Id */
template_id: string;
/** Template Version */
template_version: number;
/**
* Type
* @enum {string}
*/
type: "s3" | "azure_blob" | "disk" | "generic_s3";
/** Variables */
variables?: {
[key: string]: (string | boolean | number) | undefined;
};
};
/**
* UserCreationPayload
* @description Base model definition with common configuration used by all derived models.
Expand Down Expand Up @@ -15444,6 +15601,130 @@ export interface operations {
};
};
};
object_stores__instances_index: {
/** Get a list of persisted object store instances defined by the requesting user. */
parameters?: {
/** @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. */
header?: {
"run-as"?: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
"application/json": components["schemas"]["UserConcreteObjectStoreModel"][];
};
};
/** @description Validation Error */
422: {
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
object_stores__create_instance: {
/** Create a user-bound object store. */
parameters?: {
/** @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. */
header?: {
"run-as"?: string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateInstancePayload"];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
"application/json": components["schemas"]["UserConcreteObjectStoreModel"];
};
};
/** @description Validation Error */
422: {
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
object_stores__instances_get: {
/** Get a list of persisted object store instances defined by the requesting user. */
parameters: {
/** @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. */
header?: {
"run-as"?: string;
};
/** @description The model ID for a persisted UserObjectStore object. */
path: {
user_object_store_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
"application/json": components["schemas"]["UserConcreteObjectStoreModel"];
};
};
/** @description Validation Error */
422: {
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
object_stores__instances_update: {
/** Update or upgrade user object store instance. */
parameters: {
/** @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. */
header?: {
"run-as"?: string;
};
/** @description The model ID for a persisted UserObjectStore object. */
path: {
user_object_store_id: string;
};
};
requestBody: {
content: {
"application/json":
| components["schemas"]["UpdateInstanceSecretPayload"]
| components["schemas"]["UpgradeInstancePayload"]
| components["schemas"]["UpdateInstancePayload"];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
"application/json": components["schemas"]["UserConcreteObjectStoreModel"];
};
};
/** @description Validation Error */
422: {
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
object_stores__templates_index: {
/** Get a list of object store templates available to build user defined object stores from */
responses: {
/** @description A list of the configured object store templates. */
200: {
content: {
"application/json": components["schemas"]["ObjectStoreTemplateSummaries"];
};
};
};
};
index_api_object_stores_get: {
/** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */
parameters?: {
Expand Down

0 comments on commit e339fd3

Please sign in to comment.