Skip to content

Commit

Permalink
Update API client schema
Browse files Browse the repository at this point in the history
  • Loading branch information
bkis committed Nov 20, 2023
1 parent c411e71 commit bb56f0a
Showing 1 changed file with 100 additions and 20 deletions.
120 changes: 100 additions & 20 deletions Tekst-Web/src/api/schema.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,86 @@ export type webhooks = Record<string, never>;

export interface components {
schemas: {
/** AnyLayerRead */
AnyLayerRead: {
/**
* Id
* @example 5eb7cf5a86d9755df3a6c593
*/
id: string;
/**
* Title
* @description Title of this layer
*/
title: string;
/**
* Description
* @description Short, concise description of this data layer
*/
description?: string | null;
/**
* Textid
* @description ID of the text this layer belongs to
*/
textId?: string | null;
/**
* Level
* @description Text level this layer belongs to
*/
level: number;
/**
* Layertype
* @description A string identifying one of the available layer types
*/
layerType: string;
/**
* Ownerid
* @description User owning this layer
*/
ownerId?: string | null;
/**
* Sharedread
* @description Users with shared read access to this layer
* @default []
*/
sharedRead?: string[];
/**
* Sharedwrite
* @description Users with shared write access to this layer
* @default []
*/
sharedWrite?: string[];
/**
* Public
* @description Publication status of this layer
* @default false
*/
public?: boolean;
/**
* Proposed
* @description Whether this layer has been proposed for publication
* @default false
*/
proposed?: boolean;
/**
* Citation
* @description Citation details for this layer
*/
citation?: string | null;
/**
* Meta
* @description Arbitrary metadata
*/
meta?: {
[key: string]: string;
} | null;
/**
* Comment
* @description Plaintext, potentially multiline comment on this layer
*/
comment?: string | null;
[key: string]: unknown;
};
/** BearerResponse */
BearerResponse: {
/** Access Token */
Expand Down Expand Up @@ -722,18 +802,18 @@ export interface components {
* @default []
*/
sharedWrite?: string[];
/**
* Proposed
* @description Whether this layer has been proposed for publication
* @default false
*/
proposed?: boolean;
/**
* Public
* @description Publication status of this layer
* @default false
*/
public?: boolean;
/**
* Proposed
* @description Whether this layer has been proposed for publication
* @default false
*/
proposed?: boolean;
/**
* Citation
* @description Citation details for this layer
Expand Down Expand Up @@ -802,18 +882,18 @@ export interface components {
* @default []
*/
sharedWrite?: string[];
/**
* Proposed
* @description Whether this layer has been proposed for publication
* @default false
*/
proposed?: boolean;
/**
* Public
* @description Publication status of this layer
* @default false
*/
public?: boolean;
/**
* Proposed
* @description Whether this layer has been proposed for publication
* @default false
*/
proposed?: boolean;
/**
* Citation
* @description Citation details for this layer
Expand Down Expand Up @@ -851,10 +931,10 @@ export interface components {
sharedRead?: string[];
/** Sharedwrite */
sharedWrite?: string[];
/** Proposed */
proposed?: boolean;
/** Public */
public?: boolean;
/** Proposed */
proposed?: boolean;
/** Citation */
citation?: string | null;
/** Meta */
Expand Down Expand Up @@ -969,15 +1049,15 @@ export interface components {
* "usersActiveByDefault": false,
* "enableCookieAuth": true,
* "enableJwtAuth": true,
* "authCookieLifetime": 3600
* "authCookieLifetime": 10800
* }
*/
security?: components['schemas']['PlatformSecurityInfo'];
/** Layertypes */
layerTypes: components['schemas']['LayerTypeInfo'][];
/** Systemsegments */
systemSegments: components['schemas']['ClientSegmentRead'][];
/** Pagesinfo */
/** Infosegments */
infoSegments: components['schemas']['ClientSegmentHead'][];
};
/** PlatformSecurityInfo */
Expand All @@ -1004,7 +1084,7 @@ export interface components {
enableJwtAuth?: boolean;
/**
* Authcookielifetime
* @default 3600
* @default 10800
*/
authCookieLifetime?: number;
};
Expand All @@ -1018,7 +1098,7 @@ export interface components {
/**
* Infoplatformname
* @description Name of the platform
* @default Tekst-DEV
* @default Tekst-Dev
*/
infoPlatformName?: string;
/**
Expand Down Expand Up @@ -1725,7 +1805,7 @@ export interface operations {
/** @description Successful Response */
200: {
content: {
'application/json': Record<string, never>[];
'application/json': components['schemas']['AnyLayerRead'][];
};
};
/** @description Not found */
Expand All @@ -1751,7 +1831,7 @@ export interface operations {
/** @description Successful Response */
200: {
content: {
'application/json': Record<string, never>;
'application/json': components['schemas']['AnyLayerRead'];
};
};
/** @description Not found */
Expand Down

0 comments on commit bb56f0a

Please sign in to comment.