diff --git a/src/Coscine.Api.STS/base.ts b/src/Coscine.Api.STS/base.ts index 7b984b4b1d826893a7a35433c6c9f8a2b6aa09a0..9d36ad917fc9c21ffebd97f2ac7ebdf9c7a2f4e0 100644 --- a/src/Coscine.Api.STS/base.ts +++ b/src/Coscine.Api.STS/base.ts @@ -19,7 +19,7 @@ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://d-sp23.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.STS".replace(/\/+$/, ""); +export const BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.STS".replace(/\/+$/, ""); /** * diff --git a/src/Coscine.Api/@coscine/api/admin-api.ts b/src/Coscine.Api/@coscine/api/admin-api.ts index 40e0a537a082301cd3e6b243c3a2a53749ad0c3b..26bc1a0d09d0ef9ba43409fcc092963eb4594f77 100644 --- a/src/Coscine.Api/@coscine/api/admin-api.ts +++ b/src/Coscine.Api/@coscine/api/admin-api.ts @@ -26,6 +26,8 @@ import { ActivityLogDtoPagedResponse } from '../../@coscine/model'; // @ts-ignore import { CoscineHttpMethod } from '../../@coscine/model'; // @ts-ignore +import { DeployedGraphDtoPagedResponse } from '../../@coscine/model'; +// @ts-ignore import { MetadataUpdateAdminParameters } from '../../@coscine/model'; // @ts-ignore import { ProjectAdminDtoPagedResponse } from '../../@coscine/model'; @@ -325,6 +327,54 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Gets all deployed graphs. + * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. + * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. + * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDeployedGraphs: async (pageNumber?: number, pageSize?: number, orderBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/admin/graphs`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; + } + + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; + } + + if (orderBy !== undefined) { + localVarQueryParameter['OrderBy'] = orderBy; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -552,6 +602,21 @@ export const AdminApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['AdminApi.getAllUsers']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Gets all deployed graphs. + * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. + * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. + * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getDeployedGraphs(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployedGraphDtoPagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDeployedGraphs(pageNumber, pageSize, orderBy, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['AdminApi.getDeployedGraphs']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> * @summary Gets a metadata graph. @@ -653,6 +718,16 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath getAllUsers(requestParameters: AdminApiGetAllUsersRequest = {}, options?: AxiosRequestConfig): AxiosPromise<UserDtoPagedResponse> { return localVarFp.getAllUsers(requestParameters.tosAccepted, requestParameters.pageSize, requestParameters.pageNumber, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Gets all deployed graphs. + * @param {AdminApiGetDeployedGraphsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDeployedGraphs(requestParameters: AdminApiGetDeployedGraphsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<DeployedGraphDtoPagedResponse> { + return localVarFp.getDeployedGraphs(requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); + }, /** * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> * @summary Gets a metadata graph. @@ -882,6 +957,34 @@ export interface AdminApiGetAllUsersRequest { readonly orderBy?: string } +/** + * Request parameters for getDeployedGraphs operation in AdminApi. + * @export + * @interface AdminApiGetDeployedGraphsRequest + */ +export interface AdminApiGetDeployedGraphsRequest { + /** + * The desired page number. Should be greater than or equal to 1. Default is 1. + * @type {number} + * @memberof AdminApiGetDeployedGraphs + */ + readonly pageNumber?: number + + /** + * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. + * @type {number} + * @memberof AdminApiGetDeployedGraphs + */ + readonly pageSize?: number + + /** + * Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. + * @type {string} + * @memberof AdminApiGetDeployedGraphs + */ + readonly orderBy?: string +} + /** * Request parameters for getMetadataGraph operation in AdminApi. * @export @@ -1011,6 +1114,18 @@ export class AdminApi extends BaseAPI { return AdminApiFp(this.configuration).getAllUsers(requestParameters.tosAccepted, requestParameters.pageSize, requestParameters.pageNumber, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath)); } + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Gets all deployed graphs. + * @param {AdminApiGetDeployedGraphsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AdminApi + */ + public getDeployedGraphs(requestParameters: AdminApiGetDeployedGraphsRequest = {}, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).getDeployedGraphs(requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath)); + } + /** * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> * @summary Gets a metadata graph. diff --git a/src/Coscine.Api/@coscine/api/application-profile-api.ts b/src/Coscine.Api/@coscine/api/application-profile-api.ts index 24d43c70508e40b748c4562aef0afefb744e4037..681486991c951d57baffd43041077c90d7e9d102 100644 --- a/src/Coscine.Api/@coscine/api/application-profile-api.ts +++ b/src/Coscine.Api/@coscine/api/application-profile-api.ts @@ -73,7 +73,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Submits a request to create a new application profile. * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. @@ -110,7 +110,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an application profile by its URI. * @param {string} profile The URI of the application profile to retrieve. * @param {RdfFormat} [format] The desired data format for the returned application profile. @@ -159,7 +159,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all application profiles. * @param {string} [searchTerm] Gets or sets the search term used to filter application profiles. * @param {AcceptedLanguage} [language] Gets or sets the language for which the application profiles are requested. @@ -222,7 +222,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the `raw` application profile definition by its URI. * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. @@ -281,7 +281,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Submits a request to create a new application profile. * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. @@ -294,7 +294,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an application profile by its URI. * @param {string} profile The URI of the application profile to retrieve. * @param {RdfFormat} [format] The desired data format for the returned application profile. @@ -309,7 +309,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all application profiles. * @param {string} [searchTerm] Gets or sets the search term used to filter application profiles. * @param {AcceptedLanguage} [language] Gets or sets the language for which the application profiles are requested. @@ -327,7 +327,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the `raw` application profile definition by its URI. * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. @@ -359,7 +359,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat return localVarFp.apiV2ApplicationProfilesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Submits a request to create a new application profile. * @param {ApplicationProfileApiCreateApplicationProfileRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -369,7 +369,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat return localVarFp.createApplicationProfileRequest(requestParameters.applicationProfileForCreationDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an application profile by its URI. * @param {ApplicationProfileApiGetApplicationProfileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -379,7 +379,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat return localVarFp.getApplicationProfile(requestParameters.profile, requestParameters.format, requestParameters.acceptLanguage, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all application profiles. * @param {ApplicationProfileApiGetApplicationProfilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -389,7 +389,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat return localVarFp.getApplicationProfiles(requestParameters.searchTerm, requestParameters.language, requestParameters.modules, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the `raw` application profile definition by its URI. * @param {ApplicationProfileApiGetRawApplicationProfileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -525,7 +525,7 @@ export class ApplicationProfileApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Submits a request to create a new application profile. * @param {ApplicationProfileApiCreateApplicationProfileRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -537,7 +537,7 @@ export class ApplicationProfileApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an application profile by its URI. * @param {ApplicationProfileApiGetApplicationProfileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -549,7 +549,7 @@ export class ApplicationProfileApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all application profiles. * @param {ApplicationProfileApiGetApplicationProfilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -561,7 +561,7 @@ export class ApplicationProfileApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the `raw` application profile definition by its URI. * @param {ApplicationProfileApiGetRawApplicationProfileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/blob-api.ts b/src/Coscine.Api/@coscine/api/blob-api.ts index ef8c561f048aa578dd718c636697ec029d5c9e71..93e7c9d5d59b729276255e8a6647263a740579f2 100644 --- a/src/Coscine.Api/@coscine/api/blob-api.ts +++ b/src/Coscine.Api/@coscine/api/blob-api.ts @@ -69,7 +69,7 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new blob for a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -123,7 +123,7 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a blob from a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -168,7 +168,7 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Download a blob from a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -213,7 +213,7 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates an existing blob of a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -291,7 +291,7 @@ export const BlobApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new blob for a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -307,7 +307,7 @@ export const BlobApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a blob from a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -322,7 +322,7 @@ export const BlobApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Download a blob from a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -337,7 +337,7 @@ export const BlobApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates an existing blob of a resource. * @param {string} projectId The identifier or slug of the project. * @param {string} resourceId The identifier of the resource. @@ -373,7 +373,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new blob for a resource. * @param {BlobApiCreateBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -383,7 +383,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? return localVarFp.createBlob(requestParameters.projectId, requestParameters.resourceId, requestParameters.key, requestParameters.file, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a blob from a resource. * @param {BlobApiDeleteBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -393,7 +393,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? return localVarFp.deleteBlob(requestParameters.projectId, requestParameters.resourceId, requestParameters.key, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Download a blob from a resource. * @param {BlobApiGetBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -403,7 +403,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? return localVarFp.getBlob(requestParameters.projectId, requestParameters.resourceId, requestParameters.key, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates an existing blob of a resource. * @param {BlobApiUpdateBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -582,7 +582,7 @@ export class BlobApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new blob for a resource. * @param {BlobApiCreateBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -594,7 +594,7 @@ export class BlobApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a blob from a resource. * @param {BlobApiDeleteBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -606,7 +606,7 @@ export class BlobApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Download a blob from a resource. * @param {BlobApiGetBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -618,7 +618,7 @@ export class BlobApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates an existing blob of a resource. * @param {BlobApiUpdateBlobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/discipline-api.ts b/src/Coscine.Api/@coscine/api/discipline-api.ts index c14a3e28c2fdaac465d913041e9458cacccf6aa5..f85d78d7695cb5f4b37fdb91509d93a850544299 100644 --- a/src/Coscine.Api/@coscine/api/discipline-api.ts +++ b/src/Coscine.Api/@coscine/api/discipline-api.ts @@ -65,7 +65,7 @@ export const DisciplineApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a discipline with the specified ID. * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const DisciplineApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all disciplines. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -172,7 +172,7 @@ export const DisciplineApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a discipline with the specified ID. * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. @@ -185,7 +185,7 @@ export const DisciplineApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all disciplines. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -219,7 +219,7 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas return localVarFp.apiV2DisciplinesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a discipline with the specified ID. * @param {DisciplineApiGetDisciplineRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas return localVarFp.getDiscipline(requestParameters.disciplineId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all disciplines. * @param {DisciplineApiGetDisciplinesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class DisciplineApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a discipline with the specified ID. * @param {DisciplineApiGetDisciplineRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class DisciplineApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all disciplines. * @param {DisciplineApiGetDisciplinesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/handle-api.ts b/src/Coscine.Api/@coscine/api/handle-api.ts index 8a99e5aef3a824c58aa0129df8eedf03c20c7793..3feaa120a47b7d0ede9d232cf49d0c4b14297ce8 100644 --- a/src/Coscine.Api/@coscine/api/handle-api.ts +++ b/src/Coscine.Api/@coscine/api/handle-api.ts @@ -65,7 +65,7 @@ export const HandleApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * * @summary Retrieves all values of a handle by its PID. * @param {string} prefix The prefix of the PID * @param {string} suffix The suffix of the PID @@ -173,7 +173,7 @@ export const HandleApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * * @summary Retrieves all values of a handle by its PID. * @param {string} prefix The prefix of the PID * @param {string} suffix The suffix of the PID @@ -221,7 +221,7 @@ export const HandleApiFactory = function (configuration?: Configuration, basePat return localVarFp.apiV2HandlesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * * @summary Retrieves all values of a handle by its PID. * @param {HandleApiGetHandleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -311,7 +311,7 @@ export class HandleApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * * @summary Retrieves all values of a handle by its PID. * @param {HandleApiGetHandleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/language-api.ts b/src/Coscine.Api/@coscine/api/language-api.ts index bda07a14dbdef69028a8cb2c959a563a9894433e..5a0f1dad1916aabc088fa2471470eb6dcdaf8fcc 100644 --- a/src/Coscine.Api/@coscine/api/language-api.ts +++ b/src/Coscine.Api/@coscine/api/language-api.ts @@ -65,7 +65,7 @@ export const LanguageApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a language by ID. * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const LanguageApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all languages. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -172,7 +172,7 @@ export const LanguageApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a language by ID. * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. @@ -185,7 +185,7 @@ export const LanguageApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all languages. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -219,7 +219,7 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP return localVarFp.apiV2LanguagesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a language by ID. * @param {LanguageApiGetLanguageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP return localVarFp.getLanguage(requestParameters.languageId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all languages. * @param {LanguageApiGetLanguagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class LanguageApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a language by ID. * @param {LanguageApiGetLanguageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class LanguageApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all languages. * @param {LanguageApiGetLanguagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/license-api.ts b/src/Coscine.Api/@coscine/api/license-api.ts index 0fd6c6828c55c6aea4245b47408d5fb764366b4f..1d2bb474e2c4c3b406fd6d42d812912d1516d2ac 100644 --- a/src/Coscine.Api/@coscine/api/license-api.ts +++ b/src/Coscine.Api/@coscine/api/license-api.ts @@ -65,7 +65,7 @@ export const LicenseApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a license with the specified ID. * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const LicenseApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all licenses. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -172,7 +172,7 @@ export const LicenseApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a license with the specified ID. * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. @@ -185,7 +185,7 @@ export const LicenseApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all licenses. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -219,7 +219,7 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa return localVarFp.apiV2LicensesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a license with the specified ID. * @param {LicenseApiGetLicenseRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa return localVarFp.getLicense(requestParameters.licenseId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all licenses. * @param {LicenseApiGetLicensesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class LicenseApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a license with the specified ID. * @param {LicenseApiGetLicenseRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class LicenseApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all licenses. * @param {LicenseApiGetLicensesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/maintenance-api.ts b/src/Coscine.Api/@coscine/api/maintenance-api.ts index 4598d52e90ec516dbec4c15c08b5aaa74a7b1549..24643f164b83c87a6cf02e5c1b90665b8e3b1834 100644 --- a/src/Coscine.Api/@coscine/api/maintenance-api.ts +++ b/src/Coscine.Api/@coscine/api/maintenance-api.ts @@ -63,7 +63,7 @@ export const MaintenanceApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -118,7 +118,7 @@ export const MaintenanceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -149,7 +149,7 @@ export const MaintenanceApiFactory = function (configuration?: Configuration, ba return localVarFp.apiV2MaintenancesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -179,7 +179,7 @@ export class MaintenanceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/Coscine.Api/@coscine/api/organization-api.ts b/src/Coscine.Api/@coscine/api/organization-api.ts index 2c6c7e4d4ef471ce47756df7827bb507e3a28279..15e08ed28fcfddeacee42e448b3e331b66fc09d7 100644 --- a/src/Coscine.Api/@coscine/api/organization-api.ts +++ b/src/Coscine.Api/@coscine/api/organization-api.ts @@ -65,7 +65,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an organization. * @param {string} organizationRorUri The parameters for organization filtering and pagination. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all organizations. * @param {string} [searchTerm] Gets or sets the search term used to filter organizations. * @param {boolean} [filterByPublicationService] Gets or sets the option to find only organizations having the publication service set. @@ -182,7 +182,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an organization. * @param {string} organizationRorUri The parameters for organization filtering and pagination. * @param {*} [options] Override http request option. @@ -195,7 +195,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all organizations. * @param {string} [searchTerm] Gets or sets the search term used to filter organizations. * @param {boolean} [filterByPublicationService] Gets or sets the option to find only organizations having the publication service set. @@ -231,7 +231,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b return localVarFp.apiV2OrganizationsOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an organization. * @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -241,7 +241,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b return localVarFp.getOrganization(requestParameters.organizationRorUri, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all organizations. * @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -328,7 +328,7 @@ export class OrganizationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an organization. * @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -340,7 +340,7 @@ export class OrganizationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all organizations. * @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/pid-api.ts b/src/Coscine.Api/@coscine/api/pid-api.ts index a727801b80a5478994897338461f8b872f987cdf..8c24ebc53a9e60eedc94b6e81e57afc9b01aff10 100644 --- a/src/Coscine.Api/@coscine/api/pid-api.ts +++ b/src/Coscine.Api/@coscine/api/pid-api.ts @@ -67,7 +67,7 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix. * @param {string} prefix The PID prefix. Limited to the values provided by the API. * @param {string} suffix The PID suffix of a project or a resource, represented as a GUID. @@ -171,7 +171,7 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Sends an inquiry to the owner of the given PID. * @param {string} prefix The PID prefix of a project or a resource to validate * @param {string} suffix The PID body of a project or a resource to validate @@ -238,7 +238,7 @@ export const PidApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix. * @param {string} prefix The PID prefix. Limited to the values provided by the API. * @param {string} suffix The PID suffix of a project or a resource, represented as a GUID. @@ -270,7 +270,7 @@ export const PidApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Sends an inquiry to the owner of the given PID. * @param {string} prefix The PID prefix of a project or a resource to validate * @param {string} suffix The PID body of a project or a resource to validate @@ -304,7 +304,7 @@ export const PidApiFactory = function (configuration?: Configuration, basePath?: return localVarFp.apiV2PidsOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix. * @param {PidApiGetPidRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -324,7 +324,7 @@ export const PidApiFactory = function (configuration?: Configuration, basePath?: return localVarFp.getPids(requestParameters.includeProjects, requestParameters.includeResources, requestParameters.includeDeleted, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Sends an inquiry to the owner of the given PID. * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -453,7 +453,7 @@ export class PidApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix. * @param {PidApiGetPidRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -477,7 +477,7 @@ export class PidApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Sends an inquiry to the owner of the given PID. * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-api.ts b/src/Coscine.Api/@coscine/api/project-api.ts index 233fc3868c5202ec4e708055a9d33354597be481..d073ab43a5e435402f41794d2c43cd98ee34e097 100644 --- a/src/Coscine.Api/@coscine/api/project-api.ts +++ b/src/Coscine.Api/@coscine/api/project-api.ts @@ -69,7 +69,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new project. * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. @@ -106,7 +106,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project. * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. @@ -143,7 +143,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project. * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] Gets or sets a value indicating whether to include sub-projects in the retrieval. @@ -185,7 +185,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all projects. * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations. * @param {boolean} [topLevel] Gets or sets a value indicating whether to retrieve only top-level projects. @@ -243,7 +243,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project. * @param {string} projectId The ID of the project. * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. @@ -306,7 +306,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new project. * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. @@ -319,7 +319,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project. * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. @@ -332,7 +332,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project. * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] Gets or sets a value indicating whether to include sub-projects in the retrieval. @@ -346,7 +346,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all projects. * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations. * @param {boolean} [topLevel] Gets or sets a value indicating whether to retrieve only top-level projects. @@ -363,7 +363,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project. * @param {string} projectId The ID of the project. * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. @@ -396,7 +396,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return localVarFp.apiV2ProjectsOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new project. * @param {ProjectApiCreateProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -406,7 +406,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return localVarFp.createProject(requestParameters.projectForCreationDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project. * @param {ProjectApiDeleteProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -416,7 +416,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return localVarFp.deleteProject(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project. * @param {ProjectApiGetProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -426,7 +426,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return localVarFp.getProject(requestParameters.projectId, requestParameters.includeSubProjects, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all projects. * @param {ProjectApiGetProjectsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -436,7 +436,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return localVarFp.getProjects(requestParameters.includeOrganizations, requestParameters.topLevel, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project. * @param {ProjectApiUpdateProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -579,7 +579,7 @@ export class ProjectApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new project. * @param {ProjectApiCreateProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -591,7 +591,7 @@ export class ProjectApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project. * @param {ProjectApiDeleteProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -603,7 +603,7 @@ export class ProjectApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project. * @param {ProjectApiGetProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -615,7 +615,7 @@ export class ProjectApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all projects. * @param {ProjectApiGetProjectsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -627,7 +627,7 @@ export class ProjectApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project. * @param {ProjectApiUpdateProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-invitation-api.ts b/src/Coscine.Api/@coscine/api/project-invitation-api.ts index 04414bf5c190745b586e11598bf3013d68254f75..3ba79e1463d6eb4b68d705bcdc928f3af9a13a5d 100644 --- a/src/Coscine.Api/@coscine/api/project-invitation-api.ts +++ b/src/Coscine.Api/@coscine/api/project-invitation-api.ts @@ -71,7 +71,7 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. @@ -112,7 +112,7 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} projectInvitationId The ID of the project invitation to delete. @@ -153,7 +153,7 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} projectInvitationId The ID of the project invitation to retrieve. @@ -194,7 +194,7 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project invitations for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -269,7 +269,7 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. @@ -283,7 +283,7 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} projectInvitationId The ID of the project invitation to delete. @@ -297,7 +297,7 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project invitation for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} projectInvitationId The ID of the project invitation to retrieve. @@ -311,7 +311,7 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project invitations for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -347,7 +347,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati return localVarFp.apiV2ProjectsProjectIdInvitationsOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project invitation for a specified project. * @param {ProjectInvitationApiCreateProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -357,7 +357,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati return localVarFp.createProjectInvitation(requestParameters.projectId, requestParameters.projectInvitationForProjectManipulationDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project invitation for a specified project. * @param {ProjectInvitationApiDeleteProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -367,7 +367,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati return localVarFp.deleteProjectInvitation(requestParameters.projectId, requestParameters.projectInvitationId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project invitation for a specified project. * @param {ProjectInvitationApiGetProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -377,7 +377,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati return localVarFp.getProjectInvitation(requestParameters.projectId, requestParameters.projectInvitationId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project invitations for a specified project. * @param {ProjectInvitationApiGetProjectInvitationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -521,7 +521,7 @@ export class ProjectInvitationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project invitation for a specified project. * @param {ProjectInvitationApiCreateProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -533,7 +533,7 @@ export class ProjectInvitationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project invitation for a specified project. * @param {ProjectInvitationApiDeleteProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -545,7 +545,7 @@ export class ProjectInvitationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project invitation for a specified project. * @param {ProjectInvitationApiGetProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -557,7 +557,7 @@ export class ProjectInvitationApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project invitations for a specified project. * @param {ProjectInvitationApiGetProjectInvitationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-member-api.ts b/src/Coscine.Api/@coscine/api/project-member-api.ts index 4de829501a23861895f253cbc279c28696520364..f329194d9d52c9ceb40ff966d2681bf7e0b1e696 100644 --- a/src/Coscine.Api/@coscine/api/project-member-api.ts +++ b/src/Coscine.Api/@coscine/api/project-member-api.ts @@ -36,7 +36,7 @@ import { ProjectRoleForProjectManipulationDto } from '../../@coscine/model'; export const ProjectMemberApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. @@ -114,7 +114,7 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to delete. @@ -155,7 +155,7 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to retrieve. @@ -196,7 +196,7 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project memberships for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -248,7 +248,7 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to update. @@ -303,7 +303,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ProjectMemberApiAxiosParamCreator(configuration) return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. @@ -330,7 +330,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to delete. @@ -344,7 +344,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to retrieve. @@ -358,7 +358,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project memberships for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -374,7 +374,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project membership for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} membershipId The ID of the project membership to update. @@ -399,7 +399,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, const localVarFp = ProjectMemberApiFp(configuration) return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project membership for a specified project. * @param {ProjectMemberApiAddMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -419,7 +419,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, return localVarFp.apiV2ProjectsProjectIdMembersOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project membership for a specified project. * @param {ProjectMemberApiDeleteMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -429,7 +429,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, return localVarFp.deleteMembership(requestParameters.projectId, requestParameters.membershipId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project membership for a specified project. * @param {ProjectMemberApiGetMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -439,7 +439,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, return localVarFp.getMembership(requestParameters.projectId, requestParameters.membershipId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project memberships for a specified project. * @param {ProjectMemberApiGetMembershipsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -449,7 +449,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, return localVarFp.getMemberships(requestParameters.projectId, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project membership for a specified project. * @param {ProjectMemberApiUpdateMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -609,7 +609,7 @@ export interface ProjectMemberApiUpdateMembershipRequest { */ export class ProjectMemberApi extends BaseAPI { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a project membership for a specified project. * @param {ProjectMemberApiAddMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -633,7 +633,7 @@ export class ProjectMemberApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a project membership for a specified project. * @param {ProjectMemberApiDeleteMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -645,7 +645,7 @@ export class ProjectMemberApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project membership for a specified project. * @param {ProjectMemberApiGetMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -657,7 +657,7 @@ export class ProjectMemberApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project memberships for a specified project. * @param {ProjectMemberApiGetMembershipsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -669,7 +669,7 @@ export class ProjectMemberApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project membership for a specified project. * @param {ProjectMemberApiUpdateMembershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-publication-request-api.ts b/src/Coscine.Api/@coscine/api/project-publication-request-api.ts index 99e4345a41751c5e47a889408e7a3ad6b3a8758a..952f469a81d97f200af408ccd67f00074ee09000 100644 --- a/src/Coscine.Api/@coscine/api/project-publication-request-api.ts +++ b/src/Coscine.Api/@coscine/api/project-publication-request-api.ts @@ -69,7 +69,7 @@ export const ProjectPublicationRequestApiAxiosParamCreator = function (configura }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new publication request. * @param {string} projectId The Id or slug of the project. * @param {PublicationRequestForCreationDto} [publicationRequestForCreationDto] The publication request data for creation. @@ -133,7 +133,7 @@ export const ProjectPublicationRequestApiFp = function(configuration?: Configura return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new publication request. * @param {string} projectId The Id or slug of the project. * @param {PublicationRequestForCreationDto} [publicationRequestForCreationDto] The publication request data for creation. @@ -167,7 +167,7 @@ export const ProjectPublicationRequestApiFactory = function (configuration?: Con return localVarFp.apiV2ProjectsProjectIdPublicationsRequestsOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new publication request. * @param {ProjectPublicationRequestApiCreatePublicationRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -234,7 +234,7 @@ export class ProjectPublicationRequestApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new publication request. * @param {ProjectPublicationRequestApiCreatePublicationRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-quota-api.ts b/src/Coscine.Api/@coscine/api/project-quota-api.ts index 0ded5d91b7971285a39154139f2e32eaa31fa40c..4b799f9b48c169c7d9ada620da50533f367c2384 100644 --- a/src/Coscine.Api/@coscine/api/project-quota-api.ts +++ b/src/Coscine.Api/@coscine/api/project-quota-api.ts @@ -71,7 +71,7 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project quota for a specified project and resource type. * @param {string} projectId The Id or slug of the project. * @param {string} resourceTypeId The ID of the resource type. @@ -112,7 +112,7 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project quotas for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -164,7 +164,7 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project quota for a specified project and resource type. * @param {string} projectId The Id or slug of the project. * @param {string} resourceTypeId The ID of the resource type. @@ -232,7 +232,7 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project quota for a specified project and resource type. * @param {string} projectId The Id or slug of the project. * @param {string} resourceTypeId The ID of the resource type. @@ -246,7 +246,7 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project quotas for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -262,7 +262,7 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project quota for a specified project and resource type. * @param {string} projectId The Id or slug of the project. * @param {string} resourceTypeId The ID of the resource type. @@ -297,7 +297,7 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b return localVarFp.apiV2ProjectsProjectIdQuotasOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project quota for a specified project and resource type. * @param {ProjectQuotaApiGetProjectQuotaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -307,7 +307,7 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b return localVarFp.getProjectQuota(requestParameters.projectId, requestParameters.resourceTypeId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project quotas for a specified project. * @param {ProjectQuotaApiGetProjectQuotasRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -317,7 +317,7 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b return localVarFp.getProjectQuotas(requestParameters.projectId, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project quota for a specified project and resource type. * @param {ProjectQuotaApiUpdateProjectQuotaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -447,7 +447,7 @@ export class ProjectQuotaApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a project quota for a specified project and resource type. * @param {ProjectQuotaApiGetProjectQuotaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -459,7 +459,7 @@ export class ProjectQuotaApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all project quotas for a specified project. * @param {ProjectQuotaApiGetProjectQuotasRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -471,7 +471,7 @@ export class ProjectQuotaApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a project quota for a specified project and resource type. * @param {ProjectQuotaApiUpdateProjectQuotaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-resource-api.ts b/src/Coscine.Api/@coscine/api/project-resource-api.ts index 7a37fd56dd59afda4a0f5992756093c6ec980805..5136e70dc3b22a87fae9022e0e101d0ca383f891 100644 --- a/src/Coscine.Api/@coscine/api/project-resource-api.ts +++ b/src/Coscine.Api/@coscine/api/project-resource-api.ts @@ -73,7 +73,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. @@ -114,7 +114,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to delete. @@ -155,7 +155,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to retrieve. @@ -196,7 +196,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all resources for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -248,7 +248,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to update. @@ -316,7 +316,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. @@ -330,7 +330,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to delete. @@ -344,7 +344,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to retrieve. @@ -358,7 +358,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all resources for a specified project. * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. @@ -374,7 +374,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a resource for a specified project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource to update. @@ -409,7 +409,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return localVarFp.apiV2ProjectsProjectIdResourcesOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new resource for a specified project. * @param {ProjectResourceApiCreateResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -419,7 +419,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return localVarFp.createResourceForProject(requestParameters.projectId, requestParameters.resourceForCreationDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a resource for a specified project. * @param {ProjectResourceApiDeleteResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -429,7 +429,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return localVarFp.deleteResourceForProject(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource for a specified project. * @param {ProjectResourceApiGetResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -439,7 +439,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return localVarFp.getResourceForProject(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all resources for a specified project. * @param {ProjectResourceApiGetResourcesForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -449,7 +449,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return localVarFp.getResourcesForProject(requestParameters.projectId, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a resource for a specified project. * @param {ProjectResourceApiUpdateResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -621,7 +621,7 @@ export class ProjectResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates a new resource for a specified project. * @param {ProjectResourceApiCreateResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -633,7 +633,7 @@ export class ProjectResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Deletes a resource for a specified project. * @param {ProjectResourceApiDeleteResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -645,7 +645,7 @@ export class ProjectResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource for a specified project. * @param {ProjectResourceApiGetResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -657,7 +657,7 @@ export class ProjectResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all resources for a specified project. * @param {ProjectResourceApiGetResourcesForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -669,7 +669,7 @@ export class ProjectResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates a resource for a specified project. * @param {ProjectResourceApiUpdateResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-resource-quota-api.ts b/src/Coscine.Api/@coscine/api/project-resource-quota-api.ts index 4e1cde745aa9c92f3e98c1d804fb2c41f3790dce..4cfb9c25f1becb2c1438152981a47eb8e9c4ea9b 100644 --- a/src/Coscine.Api/@coscine/api/project-resource-quota-api.ts +++ b/src/Coscine.Api/@coscine/api/project-resource-quota-api.ts @@ -71,7 +71,7 @@ export const ProjectResourceQuotaApiAxiosParamCreator = function (configuration? }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource quota for a specific resource in a project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource. @@ -136,7 +136,7 @@ export const ProjectResourceQuotaApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource quota for a specific resource in a project. * @param {string} projectId The Id or slug of the project. * @param {string} resourceId The ID of the resource. @@ -170,7 +170,7 @@ export const ProjectResourceQuotaApiFactory = function (configuration?: Configur return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource quota for a specific resource in a project. * @param {ProjectResourceQuotaApiGetQuotaForResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -244,7 +244,7 @@ export class ProjectResourceQuotaApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource quota for a specific resource in a project. * @param {ProjectResourceQuotaApiGetQuotaForResourceForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/project-resource-type-api.ts b/src/Coscine.Api/@coscine/api/project-resource-type-api.ts index 8613253bcfb384ed85cb21ba9d162317acb40774..3fde077aa635017e08fc364cf3d78be8b21da54d 100644 --- a/src/Coscine.Api/@coscine/api/project-resource-type-api.ts +++ b/src/Coscine.Api/@coscine/api/project-resource-type-api.ts @@ -67,7 +67,7 @@ export const ProjectResourceTypeApiAxiosParamCreator = function (configuration?: }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the available resource types information for a specific project. * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. @@ -127,7 +127,7 @@ export const ProjectResourceTypeApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the available resource types information for a specific project. * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. @@ -160,7 +160,7 @@ export const ProjectResourceTypeApiFactory = function (configuration?: Configura return localVarFp.apiV2ProjectsProjectIdResourceTypesOptions(requestParameters.projectId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the available resource types information for a specific project. * @param {ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -220,7 +220,7 @@ export class ProjectResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the available resource types information for a specific project. * @param {ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/provenance-api.ts b/src/Coscine.Api/@coscine/api/provenance-api.ts new file mode 100644 index 0000000000000000000000000000000000000000..77585e8bf97bf72b9182ecbb80f5f626b9ec5710 --- /dev/null +++ b/src/Coscine.Api/@coscine/api/provenance-api.ts @@ -0,0 +1,398 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../../base'; +// @ts-ignore +import { ProvenanceDtoResponse } from '../../@coscine/model'; +// @ts-ignore +import { ProvenanceForUpdateDto } from '../../@coscine/model'; +/** + * ProvenanceApi - axios parameter creator + * @export + */ +export const ProvenanceApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions: async (projectId: string, resourceId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/provenance` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Retrieves the specific provenance information associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} path Gets or sets the path of the metadata tree. + * @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSpecificProvenance: async (projectId: string, resourceId: string, path: string, version?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('getSpecificProvenance', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('getSpecificProvenance', 'resourceId', resourceId) + // verify required parameter 'path' is not null or undefined + assertParamExists('getSpecificProvenance', 'path', path) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/provenance/specific` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (path !== undefined) { + localVarQueryParameter['Path'] = path; + } + + if (version !== undefined) { + localVarQueryParameter['Version'] = version; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates existing specific provenance information of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ProvenanceForUpdateDto} [provenanceForUpdateDto] The updated provenance information. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateSpecificProvenance: async (projectId: string, resourceId: string, provenanceForUpdateDto?: ProvenanceForUpdateDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('updateSpecificProvenance', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('updateSpecificProvenance', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/provenance/specific` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(provenanceForUpdateDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ProvenanceApi - functional programming interface + * @export + */ +export const ProvenanceApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ProvenanceApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(projectId: string, resourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(projectId, resourceId, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ProvenanceApi.apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * + * @summary Retrieves the specific provenance information associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} path Gets or sets the path of the metadata tree. + * @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getSpecificProvenance(projectId: string, resourceId: string, path: string, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvenanceDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecificProvenance(projectId, resourceId, path, version, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ProvenanceApi.getSpecificProvenance']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates existing specific provenance information of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ProvenanceForUpdateDto} [provenanceForUpdateDto] The updated provenance information. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateSpecificProvenance(projectId: string, resourceId: string, provenanceForUpdateDto?: ProvenanceForUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSpecificProvenance(projectId, resourceId, provenanceForUpdateDto, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['ProvenanceApi.updateSpecificProvenance']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + } +}; + +/** + * ProvenanceApi - factory interface + * @export + */ +export const ProvenanceApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ProvenanceApiFp(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters: ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void> { + return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieves the specific provenance information associated with a resource. + * @param {ProvenanceApiGetSpecificProvenanceRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSpecificProvenance(requestParameters: ProvenanceApiGetSpecificProvenanceRequest, options?: AxiosRequestConfig): AxiosPromise<ProvenanceDtoResponse> { + return localVarFp.getSpecificProvenance(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.version, options).then((request) => request(axios, basePath)); + }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates existing specific provenance information of a resource. + * @param {ProvenanceApiUpdateSpecificProvenanceRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateSpecificProvenance(requestParameters: ProvenanceApiUpdateSpecificProvenanceRequest, options?: AxiosRequestConfig): AxiosPromise<void> { + return localVarFp.updateSpecificProvenance(requestParameters.projectId, requestParameters.resourceId, requestParameters.provenanceForUpdateDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions operation in ProvenanceApi. + * @export + * @interface ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest + */ +export interface ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest { + /** + * + * @type {string} + * @memberof ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions + */ + readonly projectId: string + + /** + * + * @type {string} + * @memberof ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions + */ + readonly resourceId: string +} + +/** + * Request parameters for getSpecificProvenance operation in ProvenanceApi. + * @export + * @interface ProvenanceApiGetSpecificProvenanceRequest + */ +export interface ProvenanceApiGetSpecificProvenanceRequest { + /** + * The unique identifier or slug of the project. + * @type {string} + * @memberof ProvenanceApiGetSpecificProvenance + */ + readonly projectId: string + + /** + * The unique identifier of the resource. + * @type {string} + * @memberof ProvenanceApiGetSpecificProvenance + */ + readonly resourceId: string + + /** + * Gets or sets the path of the metadata tree. + * @type {string} + * @memberof ProvenanceApiGetSpecificProvenance + */ + readonly path: string + + /** + * Gets or sets the desired version. If the version is null, the newest will be returned. + * @type {number} + * @memberof ProvenanceApiGetSpecificProvenance + */ + readonly version?: number +} + +/** + * Request parameters for updateSpecificProvenance operation in ProvenanceApi. + * @export + * @interface ProvenanceApiUpdateSpecificProvenanceRequest + */ +export interface ProvenanceApiUpdateSpecificProvenanceRequest { + /** + * The unique identifier or slug of the project. + * @type {string} + * @memberof ProvenanceApiUpdateSpecificProvenance + */ + readonly projectId: string + + /** + * The unique identifier of the resource. + * @type {string} + * @memberof ProvenanceApiUpdateSpecificProvenance + */ + readonly resourceId: string + + /** + * The updated provenance information. + * @type {ProvenanceForUpdateDto} + * @memberof ProvenanceApiUpdateSpecificProvenance + */ + readonly provenanceForUpdateDto?: ProvenanceForUpdateDto +} + +/** + * ProvenanceApi - object-oriented interface + * @export + * @class ProvenanceApi + * @extends {BaseAPI} + */ +export class ProvenanceApi extends BaseAPI { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProvenanceApi + */ + public apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters: ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest, options?: AxiosRequestConfig) { + return ProvenanceApiFp(this.configuration).apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Retrieves the specific provenance information associated with a resource. + * @param {ProvenanceApiGetSpecificProvenanceRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProvenanceApi + */ + public getSpecificProvenance(requestParameters: ProvenanceApiGetSpecificProvenanceRequest, options?: AxiosRequestConfig) { + return ProvenanceApiFp(this.configuration).getSpecificProvenance(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.version, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates existing specific provenance information of a resource. + * @param {ProvenanceApiUpdateSpecificProvenanceRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProvenanceApi + */ + public updateSpecificProvenance(requestParameters: ProvenanceApiUpdateSpecificProvenanceRequest, options?: AxiosRequestConfig) { + return ProvenanceApiFp(this.configuration).updateSpecificProvenance(requestParameters.projectId, requestParameters.resourceId, requestParameters.provenanceForUpdateDto, options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/src/Coscine.Api/@coscine/api/resource-api.ts b/src/Coscine.Api/@coscine/api/resource-api.ts index 1eb01d4da8f3c009aacb44a0f32594a32a785806..d017965589457689bdbc9e4aec89d9bc15053689 100644 --- a/src/Coscine.Api/@coscine/api/resource-api.ts +++ b/src/Coscine.Api/@coscine/api/resource-api.ts @@ -63,7 +63,7 @@ export const ResourceApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource by its ID. * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. @@ -122,7 +122,7 @@ export const ResourceApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource by its ID. * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. @@ -154,7 +154,7 @@ export const ResourceApiFactory = function (configuration?: Configuration, baseP return localVarFp.apiV2ResourcesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource by its ID. * @param {ResourceApiGetResourceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -199,7 +199,7 @@ export class ResourceApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a resource by its ID. * @param {ResourceApiGetResourceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/resource-type-api.ts b/src/Coscine.Api/@coscine/api/resource-type-api.ts index e14c5ea28ec7592468eb3014d7e8afab3bdba8d9..1e9a7a30fb13fefc3a046d8e3546e2dd16575bf5 100644 --- a/src/Coscine.Api/@coscine/api/resource-type-api.ts +++ b/src/Coscine.Api/@coscine/api/resource-type-api.ts @@ -71,7 +71,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain Domain/Host of the GitLab Provider. @@ -122,7 +122,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain Domain/Host of the GitLab Provider. * @param {string} accessToken GitLab Project or Group Access Token. @@ -169,7 +169,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -202,7 +202,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain Domain/Host of the GitLab Provider. @@ -253,7 +253,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource type information for a specific resource type. * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. @@ -312,7 +312,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain Domain/Host of the GitLab Provider. @@ -327,7 +327,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain Domain/Host of the GitLab Provider. * @param {string} accessToken GitLab Project or Group Access Token. @@ -341,7 +341,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -353,7 +353,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain Domain/Host of the GitLab Provider. @@ -368,7 +368,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource type information for a specific resource type. * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. @@ -400,7 +400,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return localVarFp.apiV2ResourceTypesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -410,7 +410,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return localVarFp.getAllGitlabBranchesForProject(requestParameters.gitlabProjectId, requestParameters.domain, requestParameters.accessToken, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -420,7 +420,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return localVarFp.getAllGitlabProjects(requestParameters.domain, requestParameters.accessToken, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -429,7 +429,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return localVarFp.getAllResourceTypesInformation(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -439,7 +439,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return localVarFp.getGitlabProject(requestParameters.gitlabProjectId, requestParameters.domain, requestParameters.accessToken, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource type information for a specific resource type. * @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -561,7 +561,7 @@ export class ResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -573,7 +573,7 @@ export class ResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -585,7 +585,7 @@ export class ResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -596,7 +596,7 @@ export class ResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. * @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -608,7 +608,7 @@ export class ResourceTypeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the resource type information for a specific resource type. * @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/role-api.ts b/src/Coscine.Api/@coscine/api/role-api.ts index 7ed68d5d46f9a8dccf35459486eb016931211620..8177cca8b37957a129443c35910e611f0188e63a 100644 --- a/src/Coscine.Api/@coscine/api/role-api.ts +++ b/src/Coscine.Api/@coscine/api/role-api.ts @@ -65,7 +65,7 @@ export const RoleApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a role by ID. * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const RoleApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all roles. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -172,7 +172,7 @@ export const RoleApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a role by ID. * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. @@ -185,7 +185,7 @@ export const RoleApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all roles. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -219,7 +219,7 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? return localVarFp.apiV2RolesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a role by ID. * @param {RoleApiGetRoleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? return localVarFp.getRole(requestParameters.roleId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all roles. * @param {RoleApiGetRolesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class RoleApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a role by ID. * @param {RoleApiGetRoleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class RoleApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all roles. * @param {RoleApiGetRolesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/search-api.ts b/src/Coscine.Api/@coscine/api/search-api.ts index a651e85baa8b54325dcf6d20927b0ad174f743fd..9d09f029c2c4169124f0bc94e8d97bf7ba04d211 100644 --- a/src/Coscine.Api/@coscine/api/search-api.ts +++ b/src/Coscine.Api/@coscine/api/search-api.ts @@ -65,7 +65,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a search result by given search parameters. * @param {string} [query] The search query * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax @@ -155,7 +155,7 @@ export const SearchApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a search result by given search parameters. * @param {string} [query] The search query * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax @@ -193,7 +193,7 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat return localVarFp.apiV2SearchOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a search result by given search parameters. * @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -280,7 +280,7 @@ export class SearchApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a search result by given search parameters. * @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/self-api-token-api.ts b/src/Coscine.Api/@coscine/api/self-api-token-api.ts index e1ab7c19962cd8eb2e728a02ca165530c3d1b284..46b3b709b4605bdb2040750d367b10e42bf300a6 100644 --- a/src/Coscine.Api/@coscine/api/self-api-token-api.ts +++ b/src/Coscine.Api/@coscine/api/self-api-token-api.ts @@ -67,7 +67,7 @@ export const SelfApiTokenApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates an API token for the current authenticated user. * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. * @param {*} [options] Override http request option. @@ -104,7 +104,7 @@ export const SelfApiTokenApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all API tokens for the current authenticated user. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -152,7 +152,7 @@ export const SelfApiTokenApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an API token for the current authenticated user. * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. @@ -189,7 +189,7 @@ export const SelfApiTokenApiAxiosParamCreator = function (configuration?: Config }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Revokes an API token for the current authenticated user. * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. @@ -248,7 +248,7 @@ export const SelfApiTokenApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates an API token for the current authenticated user. * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. * @param {*} [options] Override http request option. @@ -261,7 +261,7 @@ export const SelfApiTokenApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all API tokens for the current authenticated user. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -276,7 +276,7 @@ export const SelfApiTokenApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an API token for the current authenticated user. * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. @@ -289,7 +289,7 @@ export const SelfApiTokenApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Revokes an API token for the current authenticated user. * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. @@ -321,7 +321,7 @@ export const SelfApiTokenApiFactory = function (configuration?: Configuration, b return localVarFp.apiV2SelfApiTokensOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates an API token for the current authenticated user. * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -331,7 +331,7 @@ export const SelfApiTokenApiFactory = function (configuration?: Configuration, b return localVarFp.createApiToken(requestParameters.apiTokenForCreationDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all API tokens for the current authenticated user. * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -341,7 +341,7 @@ export const SelfApiTokenApiFactory = function (configuration?: Configuration, b return localVarFp.getAllApiTokens(requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an API token for the current authenticated user. * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -351,7 +351,7 @@ export const SelfApiTokenApiFactory = function (configuration?: Configuration, b return localVarFp.getApiToken(requestParameters.apiTokenId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Revokes an API token for the current authenticated user. * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -452,7 +452,7 @@ export class SelfApiTokenApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Creates an API token for the current authenticated user. * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -464,7 +464,7 @@ export class SelfApiTokenApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all API tokens for the current authenticated user. * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -476,7 +476,7 @@ export class SelfApiTokenApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves an API token for the current authenticated user. * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -488,7 +488,7 @@ export class SelfApiTokenApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Revokes an API token for the current authenticated user. * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/self-api.ts b/src/Coscine.Api/@coscine/api/self-api.ts index 4a6d273de7e2f503428a3d8eec774e16fa46bf48..700f50a26fb6f40e56fc1b88cd203a4448935ad8 100644 --- a/src/Coscine.Api/@coscine/api/self-api.ts +++ b/src/Coscine.Api/@coscine/api/self-api.ts @@ -40,7 +40,7 @@ import { UserTermsOfServiceAcceptDto } from '../../@coscine/model'; export const SelfApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Accepts the current Terms Of Service for the current authenticated user. * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] * @param {*} [options] Override http request option. @@ -110,7 +110,7 @@ export const SelfApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Confirms the email of a user. * @param {string} confirmationToken Gets or initializes the confirmation token for user email confirmation. * @param {*} [options] Override http request option. @@ -150,7 +150,7 @@ export const SelfApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current authenticated user. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -183,7 +183,7 @@ export const SelfApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Initiates user merging for the current user. * @param {IdentityProviders} identityProvider The identity provider from which user data is to be merged. * @param {*} [options] Override http request option. @@ -223,7 +223,7 @@ export const SelfApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Resolves a project invitation for the authenticated user. * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. * @param {*} [options] Override http request option. @@ -260,7 +260,7 @@ export const SelfApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates the current authenticated user. * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. * @param {*} [options] Override http request option. @@ -307,7 +307,7 @@ export const SelfApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SelfApiAxiosParamCreator(configuration) return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Accepts the current Terms Of Service for the current authenticated user. * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] * @param {*} [options] Override http request option. @@ -332,7 +332,7 @@ export const SelfApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Confirms the email of a user. * @param {string} confirmationToken Gets or initializes the confirmation token for user email confirmation. * @param {*} [options] Override http request option. @@ -345,7 +345,7 @@ export const SelfApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current authenticated user. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -357,7 +357,7 @@ export const SelfApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Initiates user merging for the current user. * @param {IdentityProviders} identityProvider The identity provider from which user data is to be merged. * @param {*} [options] Override http request option. @@ -370,7 +370,7 @@ export const SelfApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Resolves a project invitation for the authenticated user. * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. * @param {*} [options] Override http request option. @@ -383,7 +383,7 @@ export const SelfApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates the current authenticated user. * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. * @param {*} [options] Override http request option. @@ -406,7 +406,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? const localVarFp = SelfApiFp(configuration) return { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Accepts the current Terms Of Service for the current authenticated user. * @param {SelfApiAcceptCurrentTosRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -425,7 +425,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? return localVarFp.apiV2SelfOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Confirms the email of a user. * @param {SelfApiConfirmUserEmailRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -435,7 +435,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? return localVarFp.confirmUserEmail(requestParameters.confirmationToken, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current authenticated user. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -444,7 +444,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? return localVarFp.getCurrentUser(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Initiates user merging for the current user. * @param {SelfApiInitiateUserMergeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -454,7 +454,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? return localVarFp.initiateUserMerge(requestParameters.identityProvider, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Resolves a project invitation for the authenticated user. * @param {SelfApiResolveProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -464,7 +464,7 @@ export const SelfApiFactory = function (configuration?: Configuration, basePath? return localVarFp.resolveProjectInvitation(requestParameters.projectInvitationResolveDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates the current authenticated user. * @param {SelfApiUpdateCurrentUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -554,7 +554,7 @@ export interface SelfApiUpdateCurrentUserRequest { */ export class SelfApi extends BaseAPI { /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Accepts the current Terms Of Service for the current authenticated user. * @param {SelfApiAcceptCurrentTosRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -577,7 +577,7 @@ export class SelfApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Confirms the email of a user. * @param {SelfApiConfirmUserEmailRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -589,7 +589,7 @@ export class SelfApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current authenticated user. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -600,7 +600,7 @@ export class SelfApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Initiates user merging for the current user. * @param {SelfApiInitiateUserMergeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -612,7 +612,7 @@ export class SelfApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Resolves a project invitation for the authenticated user. * @param {SelfApiResolveProjectInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -624,7 +624,7 @@ export class SelfApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates the current authenticated user. * @param {SelfApiUpdateCurrentUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/title-api.ts b/src/Coscine.Api/@coscine/api/title-api.ts index ed532589360f0296e7e4c4ec7027a96e82ed0db9..9c5a32cbafb004ecf0bc7bb806c9ee1f5992ed26 100644 --- a/src/Coscine.Api/@coscine/api/title-api.ts +++ b/src/Coscine.Api/@coscine/api/title-api.ts @@ -65,7 +65,7 @@ export const TitleApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a title by ID. * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. @@ -102,7 +102,7 @@ export const TitleApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all titles. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -172,7 +172,7 @@ export const TitleApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a title by ID. * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. @@ -185,7 +185,7 @@ export const TitleApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all titles. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -219,7 +219,7 @@ export const TitleApiFactory = function (configuration?: Configuration, basePath return localVarFp.apiV2TitlesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a title by ID. * @param {TitleApiGetTitleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const TitleApiFactory = function (configuration?: Configuration, basePath return localVarFp.getTitle(requestParameters.titleId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all titles. * @param {TitleApiGetTitlesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class TitleApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a title by ID. * @param {TitleApiGetTitleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class TitleApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all titles. * @param {TitleApiGetTitlesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/tos-api.ts b/src/Coscine.Api/@coscine/api/tos-api.ts index efb1fb49535087f440fbe9585e9bb05c2bd08e08..8fea057cf7d48966dd33ef0d413bd68802a30e3d 100644 --- a/src/Coscine.Api/@coscine/api/tos-api.ts +++ b/src/Coscine.Api/@coscine/api/tos-api.ts @@ -63,7 +63,7 @@ export const TosApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current Terms of Service version. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -118,7 +118,7 @@ export const TosApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current Terms of Service version. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -149,7 +149,7 @@ export const TosApiFactory = function (configuration?: Configuration, basePath?: return localVarFp.apiV2TosOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current Terms of Service version. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -179,7 +179,7 @@ export class TosApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the current Terms of Service version. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/Coscine.Api/@coscine/api/tree-api.ts b/src/Coscine.Api/@coscine/api/tree-api.ts index 5a156f19ff3e172cf5f8e511f6b81ca9b64eddb5..9e6ed4c0f28560170429c35ab4216f86bb9c0920 100644 --- a/src/Coscine.Api/@coscine/api/tree-api.ts +++ b/src/Coscine.Api/@coscine/api/tree-api.ts @@ -22,6 +22,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../../base'; // @ts-ignore +import { ExtractedMetadataTreeForCreationDto } from '../../@coscine/model'; +// @ts-ignore +import { ExtractedMetadataTreeForUpdateDto } from '../../@coscine/model'; +// @ts-ignore import { FileTreeDtoPagedResponse } from '../../@coscine/model'; // @ts-ignore import { MetadataTreeDtoPagedResponse } from '../../@coscine/model'; @@ -30,6 +34,8 @@ import { MetadataTreeDtoResponse } from '../../@coscine/model'; // @ts-ignore import { MetadataTreeForCreationDto } from '../../@coscine/model'; // @ts-ignore +import { MetadataTreeForDeletionDto } from '../../@coscine/model'; +// @ts-ignore import { MetadataTreeForUpdateDto } from '../../@coscine/model'; // @ts-ignore import { RdfFormat } from '../../@coscine/model'; @@ -81,7 +87,52 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Creates a new extracted metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ExtractedMetadataTreeForCreationDto} [extractedMetadataTreeForCreationDto] The metadata tree data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createExtractedMetadataTree: async (projectId: string, resourceId: string, extractedMetadataTreeForCreationDto?: ExtractedMetadataTreeForCreationDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('createExtractedMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('createExtractedMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/extracted` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(extractedMetadataTreeForCreationDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * * @summary Creates a new metadata tree for a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. @@ -125,6 +176,51 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Deletes (invalidates) a metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForDeletionDto} [metadataTreeForDeletionDto] The dto for the deletion. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteMetadataTree: async (projectId: string, resourceId: string, metadataTreeForDeletionDto?: MetadataTreeForDeletionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('deleteMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('deleteMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(metadataTreeForDeletionDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * The `OrderBy` query is currently not supported. * @summary Retrieves the file tree associated with a resource. @@ -187,20 +283,21 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the metadata tree associated with a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. * @param {string} [path] Gets or sets the path of the metadata tree. * @param {RdfFormat} [format] Gets or sets the format of the RDF data. * @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included. + * @param {boolean} [includeProvenance] Gets or sets if provenance metadata should be included. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMetadataTree: async (projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + getMetadataTree: async (projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, includeProvenance?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { // verify required parameter 'projectId' is not null or undefined assertParamExists('getMetadataTree', 'projectId', projectId) // verify required parameter 'resourceId' is not null or undefined @@ -234,6 +331,10 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['IncludeExtractedMetadata'] = includeExtractedMetadata; } + if (includeProvenance !== undefined) { + localVarQueryParameter['IncludeProvenance'] = includeProvenance; + } + if (pageNumber !== undefined) { localVarQueryParameter['PageNumber'] = pageNumber; } @@ -258,22 +359,25 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the specific metadata tree associated with a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. - * @param {string} [path] Gets or sets the path of the metadata tree. + * @param {string} path Gets or sets the path of the metadata tree. * @param {RdfFormat} [format] Gets or sets the format of the RDF data. * @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included. + * @param {boolean} [includeProvenance] Gets or sets if provenance should be included. * @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSpecificMetadataTree: async (projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, version?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + getSpecificMetadataTree: async (projectId: string, resourceId: string, path: string, format?: RdfFormat, includeExtractedMetadata?: boolean, includeProvenance?: boolean, version?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { // verify required parameter 'projectId' is not null or undefined assertParamExists('getSpecificMetadataTree', 'projectId', projectId) // verify required parameter 'resourceId' is not null or undefined assertParamExists('getSpecificMetadataTree', 'resourceId', resourceId) + // verify required parameter 'path' is not null or undefined + assertParamExists('getSpecificMetadataTree', 'path', path) const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/specific` .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); @@ -303,6 +407,10 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['IncludeExtractedMetadata'] = includeExtractedMetadata; } + if (includeProvenance !== undefined) { + localVarQueryParameter['IncludeProvenance'] = includeProvenance; + } + if (version !== undefined) { localVarQueryParameter['Version'] = version; } @@ -319,7 +427,52 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ExtractedMetadataTreeForUpdateDto} [extractedMetadataTreeForUpdateDto] The updated metadata tree data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateExtractedMetadataTree: async (projectId: string, resourceId: string, extractedMetadataTreeForUpdateDto?: ExtractedMetadataTreeForUpdateDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('updateExtractedMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('updateExtractedMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/extracted` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(extractedMetadataTreeForUpdateDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * * @summary Updates an existing metadata tree of a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. @@ -388,7 +541,22 @@ export const TreeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Creates a new extracted metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ExtractedMetadataTreeForCreationDto} [extractedMetadataTreeForCreationDto] The metadata tree data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createExtractedMetadataTree(projectId: string, resourceId: string, extractedMetadataTreeForCreationDto?: ExtractedMetadataTreeForCreationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createExtractedMetadataTree(projectId, resourceId, extractedMetadataTreeForCreationDto, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TreeApi.createExtractedMetadataTree']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * * @summary Creates a new metadata tree for a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. @@ -402,6 +570,21 @@ export const TreeApiFp = function(configuration?: Configuration) { const operationBasePath = operationServerMap['TreeApi.createMetadataTree']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Deletes (invalidates) a metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForDeletionDto} [metadataTreeForDeletionDto] The dto for the deletion. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteMetadataTree(projectId: string, resourceId: string, metadataTreeForDeletionDto?: MetadataTreeForDeletionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetadataTree(projectId, resourceId, metadataTreeForDeletionDto, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TreeApi.deleteMetadataTree']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, /** * The `OrderBy` query is currently not supported. * @summary Retrieves the file tree associated with a resource. @@ -421,45 +604,62 @@ export const TreeApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the metadata tree associated with a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. * @param {string} [path] Gets or sets the path of the metadata tree. * @param {RdfFormat} [format] Gets or sets the format of the RDF data. * @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included. + * @param {boolean} [includeProvenance] Gets or sets if provenance metadata should be included. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoPagedResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadataTree(projectId, resourceId, path, format, includeExtractedMetadata, pageNumber, pageSize, orderBy, options); + async getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, includeProvenance?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoPagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadataTree(projectId, resourceId, path, format, includeExtractedMetadata, includeProvenance, pageNumber, pageSize, orderBy, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['TreeApi.getMetadataTree']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the specific metadata tree associated with a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. - * @param {string} [path] Gets or sets the path of the metadata tree. + * @param {string} path Gets or sets the path of the metadata tree. * @param {RdfFormat} [format] Gets or sets the format of the RDF data. * @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included. + * @param {boolean} [includeProvenance] Gets or sets if provenance should be included. * @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSpecificMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecificMetadataTree(projectId, resourceId, path, format, includeExtractedMetadata, version, options); + async getSpecificMetadataTree(projectId: string, resourceId: string, path: string, format?: RdfFormat, includeExtractedMetadata?: boolean, includeProvenance?: boolean, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecificMetadataTree(projectId, resourceId, path, format, includeExtractedMetadata, includeProvenance, version, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['TreeApi.getSpecificMetadataTree']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {ExtractedMetadataTreeForUpdateDto} [extractedMetadataTreeForUpdateDto] The updated metadata tree data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateExtractedMetadataTree(projectId: string, resourceId: string, extractedMetadataTreeForUpdateDto?: ExtractedMetadataTreeForUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateExtractedMetadataTree(projectId, resourceId, extractedMetadataTreeForUpdateDto, options); + const index = configuration?.serverIndex ?? 0; + const operationBasePath = operationServerMap['TreeApi.updateExtractedMetadataTree']?.[index]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); + }, + /** + * * @summary Updates an existing metadata tree of a resource. * @param {string} projectId The unique identifier or slug of the project. * @param {string} resourceId The unique identifier of the resource. @@ -494,7 +694,17 @@ export const TreeApiFactory = function (configuration?: Configuration, basePath? return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(requestParameters.projectId, requestParameters.resourceId, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Creates a new extracted metadata tree for a resource. + * @param {TreeApiCreateExtractedMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createExtractedMetadataTree(requestParameters: TreeApiCreateExtractedMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoResponse> { + return localVarFp.createExtractedMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.extractedMetadataTreeForCreationDto, options).then((request) => request(axios, basePath)); + }, + /** + * * @summary Creates a new metadata tree for a resource. * @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -503,6 +713,16 @@ export const TreeApiFactory = function (configuration?: Configuration, basePath? createMetadataTree(requestParameters: TreeApiCreateMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoResponse> { return localVarFp.createMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.metadataTreeForCreationDto, options).then((request) => request(axios, basePath)); }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Deletes (invalidates) a metadata tree associated with a resource. + * @param {TreeApiDeleteMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteMetadataTree(requestParameters: TreeApiDeleteMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<void> { + return localVarFp.deleteMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.metadataTreeForDeletionDto, options).then((request) => request(axios, basePath)); + }, /** * The `OrderBy` query is currently not supported. * @summary Retrieves the file tree associated with a resource. @@ -514,27 +734,37 @@ export const TreeApiFactory = function (configuration?: Configuration, basePath? return localVarFp.getFileTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the metadata tree associated with a resource. * @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoPagedResponse> { - return localVarFp.getMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); + return localVarFp.getMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.includeProvenance, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the specific metadata tree associated with a resource. * @param {TreeApiGetSpecificMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpecificMetadataTree(requestParameters: TreeApiGetSpecificMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoResponse> { - return localVarFp.getSpecificMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.version, options).then((request) => request(axios, basePath)); + return localVarFp.getSpecificMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.includeProvenance, requestParameters.version, options).then((request) => request(axios, basePath)); + }, + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates an existing metadata tree of a resource. + * @param {TreeApiUpdateExtractedMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateExtractedMetadataTree(requestParameters: TreeApiUpdateExtractedMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<void> { + return localVarFp.updateExtractedMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.extractedMetadataTreeForUpdateDto, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Updates an existing metadata tree of a resource. * @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -567,6 +797,34 @@ export interface TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsReq readonly resourceId: string } +/** + * Request parameters for createExtractedMetadataTree operation in TreeApi. + * @export + * @interface TreeApiCreateExtractedMetadataTreeRequest + */ +export interface TreeApiCreateExtractedMetadataTreeRequest { + /** + * The unique identifier or slug of the project. + * @type {string} + * @memberof TreeApiCreateExtractedMetadataTree + */ + readonly projectId: string + + /** + * The unique identifier of the resource. + * @type {string} + * @memberof TreeApiCreateExtractedMetadataTree + */ + readonly resourceId: string + + /** + * The metadata tree data for creation. + * @type {ExtractedMetadataTreeForCreationDto} + * @memberof TreeApiCreateExtractedMetadataTree + */ + readonly extractedMetadataTreeForCreationDto?: ExtractedMetadataTreeForCreationDto +} + /** * Request parameters for createMetadataTree operation in TreeApi. * @export @@ -595,6 +853,34 @@ export interface TreeApiCreateMetadataTreeRequest { readonly metadataTreeForCreationDto?: MetadataTreeForCreationDto } +/** + * Request parameters for deleteMetadataTree operation in TreeApi. + * @export + * @interface TreeApiDeleteMetadataTreeRequest + */ +export interface TreeApiDeleteMetadataTreeRequest { + /** + * The unique identifier or slug of the project. + * @type {string} + * @memberof TreeApiDeleteMetadataTree + */ + readonly projectId: string + + /** + * The unique identifier of the resource. + * @type {string} + * @memberof TreeApiDeleteMetadataTree + */ + readonly resourceId: string + + /** + * The dto for the deletion. + * @type {MetadataTreeForDeletionDto} + * @memberof TreeApiDeleteMetadataTree + */ + readonly metadataTreeForDeletionDto?: MetadataTreeForDeletionDto +} + /** * Request parameters for getFileTree operation in TreeApi. * @export @@ -685,6 +971,13 @@ export interface TreeApiGetMetadataTreeRequest { */ readonly includeExtractedMetadata?: boolean + /** + * Gets or sets if provenance metadata should be included. + * @type {boolean} + * @memberof TreeApiGetMetadataTree + */ + readonly includeProvenance?: boolean + /** * The desired page number. Should be greater than or equal to 1. Default is 1. * @type {number} @@ -732,7 +1025,7 @@ export interface TreeApiGetSpecificMetadataTreeRequest { * @type {string} * @memberof TreeApiGetSpecificMetadataTree */ - readonly path?: string + readonly path: string /** * Gets or sets the format of the RDF data. @@ -748,6 +1041,13 @@ export interface TreeApiGetSpecificMetadataTreeRequest { */ readonly includeExtractedMetadata?: boolean + /** + * Gets or sets if provenance should be included. + * @type {boolean} + * @memberof TreeApiGetSpecificMetadataTree + */ + readonly includeProvenance?: boolean + /** * Gets or sets the desired version. If the version is null, the newest will be returned. * @type {number} @@ -756,6 +1056,34 @@ export interface TreeApiGetSpecificMetadataTreeRequest { readonly version?: number } +/** + * Request parameters for updateExtractedMetadataTree operation in TreeApi. + * @export + * @interface TreeApiUpdateExtractedMetadataTreeRequest + */ +export interface TreeApiUpdateExtractedMetadataTreeRequest { + /** + * The unique identifier or slug of the project. + * @type {string} + * @memberof TreeApiUpdateExtractedMetadataTree + */ + readonly projectId: string + + /** + * The unique identifier of the resource. + * @type {string} + * @memberof TreeApiUpdateExtractedMetadataTree + */ + readonly resourceId: string + + /** + * The updated metadata tree data. + * @type {ExtractedMetadataTreeForUpdateDto} + * @memberof TreeApiUpdateExtractedMetadataTree + */ + readonly extractedMetadataTreeForUpdateDto?: ExtractedMetadataTreeForUpdateDto +} + /** * Request parameters for updateMetadataTree operation in TreeApi. * @export @@ -804,7 +1132,19 @@ export class TreeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Creates a new extracted metadata tree for a resource. + * @param {TreeApiCreateExtractedMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TreeApi + */ + public createExtractedMetadataTree(requestParameters: TreeApiCreateExtractedMetadataTreeRequest, options?: AxiosRequestConfig) { + return TreeApiFp(this.configuration).createExtractedMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.extractedMetadataTreeForCreationDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * * @summary Creates a new metadata tree for a resource. * @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -815,6 +1155,18 @@ export class TreeApi extends BaseAPI { return TreeApiFp(this.configuration).createMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.metadataTreeForCreationDto, options).then((request) => request(this.axios, this.basePath)); } + /** + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Deletes (invalidates) a metadata tree associated with a resource. + * @param {TreeApiDeleteMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TreeApi + */ + public deleteMetadataTree(requestParameters: TreeApiDeleteMetadataTreeRequest, options?: AxiosRequestConfig) { + return TreeApiFp(this.configuration).deleteMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.metadataTreeForDeletionDto, options).then((request) => request(this.axios, this.basePath)); + } + /** * The `OrderBy` query is currently not supported. * @summary Retrieves the file tree associated with a resource. @@ -828,7 +1180,7 @@ export class TreeApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the metadata tree associated with a resource. * @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -836,11 +1188,11 @@ export class TreeApi extends BaseAPI { * @memberof TreeApi */ public getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig) { - return TreeApiFp(this.configuration).getMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath)); + return TreeApiFp(this.configuration).getMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.includeProvenance, requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath)); } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves the specific metadata tree associated with a resource. * @param {TreeApiGetSpecificMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -848,11 +1200,23 @@ export class TreeApi extends BaseAPI { * @memberof TreeApi */ public getSpecificMetadataTree(requestParameters: TreeApiGetSpecificMetadataTreeRequest, options?: AxiosRequestConfig) { - return TreeApiFp(this.configuration).getSpecificMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.version, options).then((request) => request(this.axios, this.basePath)); + return TreeApiFp(this.configuration).getSpecificMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.path, requestParameters.format, requestParameters.includeExtractedMetadata, requestParameters.includeProvenance, requestParameters.version, options).then((request) => request(this.axios, this.basePath)); } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p> + * @summary Updates an existing metadata tree of a resource. + * @param {TreeApiUpdateExtractedMetadataTreeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TreeApi + */ + public updateExtractedMetadataTree(requestParameters: TreeApiUpdateExtractedMetadataTreeRequest, options?: AxiosRequestConfig) { + return TreeApiFp(this.configuration).updateExtractedMetadataTree(requestParameters.projectId, requestParameters.resourceId, requestParameters.extractedMetadataTreeForUpdateDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * * @summary Updates an existing metadata tree of a resource. * @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/user-api.ts b/src/Coscine.Api/@coscine/api/user-api.ts index bc1187032f6af370791e827089ccb983d96d112b..ac552214730d8bf03cf9acf4e7e826646349418e 100644 --- a/src/Coscine.Api/@coscine/api/user-api.ts +++ b/src/Coscine.Api/@coscine/api/user-api.ts @@ -63,7 +63,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all users. * @param {string} searchTerm Gets or sets the search term. * @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". @@ -130,7 +130,7 @@ export const UserApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all users. * @param {string} searchTerm Gets or sets the search term. * @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". @@ -163,7 +163,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? return localVarFp.apiV2UsersOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all users. * @param {UserApiGetUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -215,7 +215,7 @@ export class UserApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all users. * @param {UserApiGetUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/visibility-api.ts b/src/Coscine.Api/@coscine/api/visibility-api.ts index 70aea880512ce828bdc15b52979c76a3dd626811..9eb50b2baed1c52bb62a4c04569bba8431ea5636 100644 --- a/src/Coscine.Api/@coscine/api/visibility-api.ts +++ b/src/Coscine.Api/@coscine/api/visibility-api.ts @@ -65,7 +65,7 @@ export const VisibilityApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all visibilities. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -113,7 +113,7 @@ export const VisibilityApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a visibility by ID. * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. @@ -172,7 +172,7 @@ export const VisibilityApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all visibilities. * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1. * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. @@ -187,7 +187,7 @@ export const VisibilityApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a visibility by ID. * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. @@ -219,7 +219,7 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas return localVarFp.apiV2VisibilitiesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all visibilities. * @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -229,7 +229,7 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas return localVarFp.getVisibilities(requestParameters.pageNumber, requestParameters.pageSize, requestParameters.orderBy, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a visibility by ID. * @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -302,7 +302,7 @@ export class VisibilityApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves all visibilities. * @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -314,7 +314,7 @@ export class VisibilityApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves a visibility by ID. * @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/api/vocabulary-api.ts b/src/Coscine.Api/@coscine/api/vocabulary-api.ts index 9dba9194cb2963fb75f083ae0a1c2894f91a18f4..17ed85a4f8f22139c6d86310a27167a0fa7bff37 100644 --- a/src/Coscine.Api/@coscine/api/vocabulary-api.ts +++ b/src/Coscine.Api/@coscine/api/vocabulary-api.ts @@ -69,7 +69,7 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies. * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested. @@ -171,7 +171,7 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves vocabulary instances. * @param {string} _class Gets or sets the URI class, which is a required field. * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances. @@ -258,7 +258,7 @@ export const VocabularyApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies. * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested. @@ -289,7 +289,7 @@ export const VocabularyApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves vocabulary instances. * @param {string} _class Gets or sets the URI class, which is a required field. * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances. @@ -326,7 +326,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas return localVarFp.apiV2VocabulariesOptions(options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves top-level instances from vocabularies. * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -346,7 +346,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas return localVarFp.getVocabularyInstance(requestParameters.instance, requestParameters.acceptLanguage, options).then((request) => request(axios, basePath)); }, /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves vocabulary instances. * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -489,7 +489,7 @@ export class VocabularyApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves top-level instances from vocabularies. * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -513,7 +513,7 @@ export class VocabularyApi extends BaseAPI { } /** - * <p><strong>Required JWT roles for access:</strong> <code></code>.</p> + * * @summary Retrieves vocabulary instances. * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. diff --git a/src/Coscine.Api/@coscine/model/deployed-graph-dto-paged-response.ts b/src/Coscine.Api/@coscine/model/deployed-graph-dto-paged-response.ts new file mode 100644 index 0000000000000000000000000000000000000000..10e2d632cb4865e71753cb785dce492765af7982 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/deployed-graph-dto-paged-response.ts @@ -0,0 +1,60 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { DeployedGraphDto } from './deployed-graph-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { Pagination } from './pagination'; + +/** + * + * @export + * @interface DeployedGraphDtoPagedResponse + */ +export interface DeployedGraphDtoPagedResponse { + /** + * + * @type {Array<DeployedGraphDto>} + * @memberof DeployedGraphDtoPagedResponse + */ + 'data'?: Array<DeployedGraphDto> | null; + /** + * + * @type {boolean} + * @memberof DeployedGraphDtoPagedResponse + */ + 'isSuccess'?: boolean; + /** + * + * @type {number} + * @memberof DeployedGraphDtoPagedResponse + */ + 'statusCode'?: number | null; + /** + * + * @type {string} + * @memberof DeployedGraphDtoPagedResponse + */ + 'traceId'?: string | null; + /** + * + * @type {Pagination} + * @memberof DeployedGraphDtoPagedResponse + */ + 'pagination'?: Pagination; +} + diff --git a/src/Coscine.Api/@coscine/model/deployed-graph-dto.ts b/src/Coscine.Api/@coscine/model/deployed-graph-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..f4ea8dff8b984729363a1b03245fbb008d9629d9 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/deployed-graph-dto.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Represents a Data Transfer Object (DTO) for deployed graph details. + * @export + * @interface DeployedGraphDto + */ +export interface DeployedGraphDto { + /** + * Graph URI and identifier. + * @type {string} + * @memberof DeployedGraphDto + */ + 'uri'?: string; + /** + * Collection of file hashes associated with the graph. + * @type {Array<string>} + * @memberof DeployedGraphDto + */ + 'fileHashes'?: Array<string>; +} + diff --git a/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-creation-dto.ts b/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-creation-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..0899ccf6779eb45902636355684e5ef16ebca152 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-creation-dto.ts @@ -0,0 +1,54 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { ProvenanceParametersDto } from './provenance-parameters-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto'; + +/** + * Data transfer object (DTO) representing the creation of a metadata tree. Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto. + * @export + * @interface ExtractedMetadataTreeForCreationDto + */ +export interface ExtractedMetadataTreeForCreationDto { + /** + * Gets or initializes the path of the metadata tree. + * @type {string} + * @memberof ExtractedMetadataTreeForCreationDto + */ + 'path': string; + /** + * Gets or sets the id of the new metadata tree. + * @type {string} + * @memberof ExtractedMetadataTreeForCreationDto + */ + 'id': string; + /** + * + * @type {RdfDefinitionForManipulationDto} + * @memberof ExtractedMetadataTreeForCreationDto + */ + 'definition': RdfDefinitionForManipulationDto; + /** + * + * @type {ProvenanceParametersDto} + * @memberof ExtractedMetadataTreeForCreationDto + */ + 'provenance': ProvenanceParametersDto; +} + diff --git a/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-update-dto.ts b/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-update-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..2d8ee742b85637e8920503f533e360a4d9e84ec5 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/extracted-metadata-tree-for-update-dto.ts @@ -0,0 +1,60 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { ProvenanceParametersDto } from './provenance-parameters-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto'; + +/** + * Data transfer object (DTO) representing the update of a metadata tree. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto. + * @export + * @interface ExtractedMetadataTreeForUpdateDto + */ +export interface ExtractedMetadataTreeForUpdateDto { + /** + * Gets or initializes the path of the metadata tree. + * @type {string} + * @memberof ExtractedMetadataTreeForUpdateDto + */ + 'path': string; + /** + * Gets or sets the id of the to update metadata tree. + * @type {string} + * @memberof ExtractedMetadataTreeForUpdateDto + */ + 'id': string; + /** + * + * @type {RdfDefinitionForManipulationDto} + * @memberof ExtractedMetadataTreeForUpdateDto + */ + 'definition': RdfDefinitionForManipulationDto; + /** + * + * @type {ProvenanceParametersDto} + * @memberof ExtractedMetadataTreeForUpdateDto + */ + 'provenance': ProvenanceParametersDto; + /** + * Gets or initializes a flag for creating a new metadata version. + * @type {boolean} + * @memberof ExtractedMetadataTreeForUpdateDto + */ + 'forceNewMetadataVersion'?: boolean; +} + diff --git a/src/Coscine.Api/@coscine/model/hash-parameters-dto.ts b/src/Coscine.Api/@coscine/model/hash-parameters-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..998ff888da601f1dd3cb42145fba73bb71774749 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/hash-parameters-dto.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Data transfer object (DTO) representing Hash Parameters in a request. + * @export + * @interface HashParametersDto + */ +export interface HashParametersDto { + /** + * Gets or initializes the hash algorithm name. + * @type {string} + * @memberof HashParametersDto + */ + 'algorithmName': string; + /** + * Gets or initializes the hash value. + * @type {string} + * @memberof HashParametersDto + */ + 'value': string; +} + diff --git a/src/Coscine.Api/@coscine/model/index.ts b/src/Coscine.Api/@coscine/model/index.ts index 14861d0ebc5c336779bdfcc3fe71ecadd82acd96..4222a3ba44fb6fa1ac6efea820f7cdebf463643b 100644 --- a/src/Coscine.Api/@coscine/model/index.ts +++ b/src/Coscine.Api/@coscine/model/index.ts @@ -13,12 +13,16 @@ export * from './application-profile-for-creation-dto-response'; export * from './application-profile-for-resource-creation-dto'; export * from './application-profile-minimal-dto'; export * from './coscine-http-method'; +export * from './deployed-graph-dto'; +export * from './deployed-graph-dto-paged-response'; export * from './discipline-dto'; export * from './discipline-dto-paged-response'; export * from './discipline-dto-response'; export * from './discipline-for-project-manipulation-dto'; export * from './discipline-for-resource-manipulation-dto'; export * from './discipline-for-user-manipulation-dto'; +export * from './extracted-metadata-tree-for-creation-dto'; +export * from './extracted-metadata-tree-for-update-dto'; export * from './file-action-dto'; export * from './file-action-http-method'; export * from './file-actions-dto'; @@ -38,6 +42,7 @@ export * from './handle-dto-response'; export * from './handle-for-update-dto'; export * from './handle-value-dto'; export * from './handle-value-for-update-dto'; +export * from './hash-parameters-dto'; export * from './identity-provider-dto'; export * from './identity-providers'; export * from './language-dto'; @@ -55,6 +60,7 @@ export * from './metadata-tree-dto-paged-response'; export * from './metadata-tree-dto-response'; export * from './metadata-tree-extracted-dto'; export * from './metadata-tree-for-creation-dto'; +export * from './metadata-tree-for-deletion-dto'; export * from './metadata-tree-for-update-dto'; export * from './metadata-update-admin-parameters'; export * from './organization-dto'; @@ -91,6 +97,10 @@ export * from './project-role-dto-response'; export * from './project-role-for-project-creation-dto'; export * from './project-role-for-project-manipulation-dto'; export * from './project-role-minimal-dto'; +export * from './provenance-dto'; +export * from './provenance-dto-response'; +export * from './provenance-for-update-dto'; +export * from './provenance-parameters-dto'; export * from './public-user-dto'; export * from './public-user-dto-ienumerable-response'; export * from './publication-advisory-service-dto'; @@ -162,6 +172,7 @@ export * from './user-merge-dto-response'; export * from './user-minimal-dto'; export * from './user-organization-dto'; export * from './user-terms-of-service-accept-dto'; +export * from './variant-dto'; export * from './visibility-dto'; export * from './visibility-dto-paged-response'; export * from './visibility-dto-response'; diff --git a/src/Coscine.Api/@coscine/model/metadata-tree-dto.ts b/src/Coscine.Api/@coscine/model/metadata-tree-dto.ts index c1925ecd4d800443a7e5176bdbbf0c77a02267dc..4a460f884a9d2b9dde4e9896a680cc3820e5245e 100644 --- a/src/Coscine.Api/@coscine/model/metadata-tree-dto.ts +++ b/src/Coscine.Api/@coscine/model/metadata-tree-dto.ts @@ -18,6 +18,9 @@ import { MetadataTreeExtractedDto } from './metadata-tree-extracted-dto'; // May contain unused imports in some cases // @ts-ignore +import { ProvenanceDto } from './provenance-dto'; +// May contain unused imports in some cases +// @ts-ignore import { RdfDefinitionDto } from './rdf-definition-dto'; // May contain unused imports in some cases // @ts-ignore @@ -41,6 +44,12 @@ export interface MetadataTreeDto { * @memberof MetadataTreeDto */ 'type'?: TreeDataType; + /** + * Gets or sets the id of the specific metadata tree. + * @type {string} + * @memberof MetadataTreeDto + */ + 'id'?: string; /** * Gets or sets the version associated with the metadata. * @type {string} @@ -65,6 +74,12 @@ export interface MetadataTreeDto { * @memberof MetadataTreeDto */ 'extracted'?: MetadataTreeExtractedDto; + /** + * + * @type {ProvenanceDto} + * @memberof MetadataTreeDto + */ + 'provenance'?: ProvenanceDto; } diff --git a/src/Coscine.Api/@coscine/model/metadata-tree-for-deletion-dto.ts b/src/Coscine.Api/@coscine/model/metadata-tree-for-deletion-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..e479079f67a9c695273374db12a7e61150d7235f --- /dev/null +++ b/src/Coscine.Api/@coscine/model/metadata-tree-for-deletion-dto.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Data transfer object (DTO) for deleting a specific version of metadata. + * @export + * @interface MetadataTreeForDeletionDto + */ +export interface MetadataTreeForDeletionDto { + /** + * Gets or initializes the path of the metadata tree. + * @type {string} + * @memberof MetadataTreeForDeletionDto + */ + 'path': string; + /** + * Gets or initializes the version of the metadata tree to be deleted. + * @type {number} + * @memberof MetadataTreeForDeletionDto + */ + 'version': number; + /** + * Gets or initializes the invalidation entity. + * @type {string} + * @memberof MetadataTreeForDeletionDto + */ + 'invalidatedBy': string; +} + diff --git a/src/Coscine.Api/@coscine/model/provenance-dto-response.ts b/src/Coscine.Api/@coscine/model/provenance-dto-response.ts new file mode 100644 index 0000000000000000000000000000000000000000..b4d7fc535b6a56160270005e1f3b93cb9f6c962b --- /dev/null +++ b/src/Coscine.Api/@coscine/model/provenance-dto-response.ts @@ -0,0 +1,51 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { ProvenanceDto } from './provenance-dto'; + +/** + * + * @export + * @interface ProvenanceDtoResponse + */ +export interface ProvenanceDtoResponse { + /** + * + * @type {ProvenanceDto} + * @memberof ProvenanceDtoResponse + */ + 'data'?: ProvenanceDto; + /** + * + * @type {boolean} + * @memberof ProvenanceDtoResponse + */ + 'isSuccess'?: boolean; + /** + * + * @type {number} + * @memberof ProvenanceDtoResponse + */ + 'statusCode'?: number | null; + /** + * + * @type {string} + * @memberof ProvenanceDtoResponse + */ + 'traceId'?: string | null; +} + diff --git a/src/Coscine.Api/@coscine/model/provenance-dto.ts b/src/Coscine.Api/@coscine/model/provenance-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..562345f43eb74e8de77555265cfb9c079b29b19c --- /dev/null +++ b/src/Coscine.Api/@coscine/model/provenance-dto.ts @@ -0,0 +1,72 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { HashParametersDto } from './hash-parameters-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { VariantDto } from './variant-dto'; + +/** + * Represents a data transfer object (DTO) for provenance information. + * @export + * @interface ProvenanceDto + */ +export interface ProvenanceDto { + /** + * Gets or sets the id of the current metadata graph. + * @type {string} + * @memberof ProvenanceDto + */ + 'id'?: string; + /** + * Gets or sets the date and time when the metadata was generated. + * @type {string} + * @memberof ProvenanceDto + */ + 'generatedAt'?: string | null; + /** + * Gets or sets the adapted versions from the specific metadata tree. + * @type {Array<string>} + * @memberof ProvenanceDto + */ + 'wasRevisionOf'?: Array<string>; + /** + * Gets or sets the variants of the specific metadata tree. + * @type {Array<VariantDto>} + * @memberof ProvenanceDto + */ + 'variants'?: Array<VariantDto>; + /** + * The similarity to the last version. + * @type {number} + * @memberof ProvenanceDto + */ + 'similarityToLastVersion'?: number | null; + /** + * Information if the specific metadata tree was invalidated by something. + * @type {string} + * @memberof ProvenanceDto + */ + 'wasInvalidatedBy'?: string | null; + /** + * + * @type {HashParametersDto} + * @memberof ProvenanceDto + */ + 'hashParameters'?: HashParametersDto; +} + diff --git a/src/Coscine.Api/@coscine/model/provenance-for-update-dto.ts b/src/Coscine.Api/@coscine/model/provenance-for-update-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..dc834b195a4536bb9970558d6a5bb5b989c6261a --- /dev/null +++ b/src/Coscine.Api/@coscine/model/provenance-for-update-dto.ts @@ -0,0 +1,72 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { HashParametersDto } from './hash-parameters-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { VariantDto } from './variant-dto'; + +/** + * Data transfer object (DTO) representing the update of provenance Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProvenanceParametersDto. + * @export + * @interface ProvenanceForUpdateDto + */ +export interface ProvenanceForUpdateDto { + /** + * Gets or sets the adapted versions from the specific metadata tree. + * @type {Array<string>} + * @memberof ProvenanceForUpdateDto + */ + 'wasRevisionOf'?: Array<string>; + /** + * Gets or sets the variants of the specific metadata tree. + * @type {Array<VariantDto>} + * @memberof ProvenanceForUpdateDto + */ + 'variants'?: Array<VariantDto>; + /** + * Information if the specific metadata tree was invalidated by something. + * @type {string} + * @memberof ProvenanceForUpdateDto + */ + 'wasInvalidatedBy'?: string | null; + /** + * The similarity to the last version. + * @type {number} + * @memberof ProvenanceForUpdateDto + */ + 'similarityToLastVersion'?: number | null; + /** + * Gets or initializes the version of the metadata extractor. + * @type {string} + * @memberof ProvenanceForUpdateDto + */ + 'metadataExtractorVersion'?: string | null; + /** + * + * @type {HashParametersDto} + * @memberof ProvenanceForUpdateDto + */ + 'hashParameters'?: HashParametersDto; + /** + * Gets or sets the id of the specific metadata tree. + * @type {string} + * @memberof ProvenanceForUpdateDto + */ + 'id'?: string; +} + diff --git a/src/Coscine.Api/@coscine/model/provenance-parameters-dto.ts b/src/Coscine.Api/@coscine/model/provenance-parameters-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..92e6861dc6cb2251b22609fa95fa64c0bee5f689 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/provenance-parameters-dto.ts @@ -0,0 +1,66 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { HashParametersDto } from './hash-parameters-dto'; +// May contain unused imports in some cases +// @ts-ignore +import { VariantDto } from './variant-dto'; + +/** + * Data transfer object (DTO) representing Provenance Parameters in a request. + * @export + * @interface ProvenanceParametersDto + */ +export interface ProvenanceParametersDto { + /** + * Gets or sets the adapted versions from the specific metadata tree. + * @type {Array<string>} + * @memberof ProvenanceParametersDto + */ + 'wasRevisionOf'?: Array<string>; + /** + * Gets or sets the variants of the specific metadata tree. + * @type {Array<VariantDto>} + * @memberof ProvenanceParametersDto + */ + 'variants'?: Array<VariantDto>; + /** + * Information if the specific metadata tree was invalidated by something. + * @type {string} + * @memberof ProvenanceParametersDto + */ + 'wasInvalidatedBy'?: string | null; + /** + * The similarity to the last version. + * @type {number} + * @memberof ProvenanceParametersDto + */ + 'similarityToLastVersion'?: number | null; + /** + * Gets or initializes the version of the metadata extractor. + * @type {string} + * @memberof ProvenanceParametersDto + */ + 'metadataExtractorVersion'?: string | null; + /** + * + * @type {HashParametersDto} + * @memberof ProvenanceParametersDto + */ + 'hashParameters'?: HashParametersDto; +} + diff --git a/src/Coscine.Api/@coscine/model/rdf-format.ts b/src/Coscine.Api/@coscine/model/rdf-format.ts index abe6a2cdee8e9961386ef645596a9ae02a4ea79e..37653764fbe2ffdae9b855ada26ef3098c1374cc 100644 --- a/src/Coscine.Api/@coscine/model/rdf-format.ts +++ b/src/Coscine.Api/@coscine/model/rdf-format.ts @@ -22,7 +22,8 @@ export const RdfFormat = { TextTurtle: 'text/turtle', - ApplicationLdjson: 'application/ld+json' + ApplicationLdjson: 'application/ld+json', + ApplicationXTrig: 'application/x-trig' } as const; export type RdfFormat = typeof RdfFormat[keyof typeof RdfFormat]; diff --git a/src/Coscine.Api/@coscine/model/resource-admin-dto.ts b/src/Coscine.Api/@coscine/model/resource-admin-dto.ts index 22a660ec283fd52ede763eab782ded8eb0bbebc9..39a9170d90930e31199e91964b1236c3400fa6a4 100644 --- a/src/Coscine.Api/@coscine/model/resource-admin-dto.ts +++ b/src/Coscine.Api/@coscine/model/resource-admin-dto.ts @@ -27,6 +27,9 @@ import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource import { LicenseDto } from './license-dto'; // May contain unused imports in some cases // @ts-ignore +import { ProjectMinimalDto } from './project-minimal-dto'; +// May contain unused imports in some cases +// @ts-ignore import { ProjectResourceMinimalDto } from './project-resource-minimal-dto'; // May contain unused imports in some cases // @ts-ignore @@ -155,6 +158,12 @@ export interface ResourceAdminDto { * @memberof ResourceAdminDto */ 'archived'?: boolean; + /** + * The projects associated with the resource. + * @type {Array<ProjectMinimalDto>} + * @memberof ResourceAdminDto + */ + 'projects'?: Array<ProjectMinimalDto> | null; /** * Indicates whether the resource is deleted. * @type {boolean} diff --git a/src/Coscine.Api/@coscine/model/resource-dto.ts b/src/Coscine.Api/@coscine/model/resource-dto.ts index e9cb9c71c4a3131ea6e4a70c2a6df022d9865b89..633411d451102c22909a9e62f2ac6e78bbf179f3 100644 --- a/src/Coscine.Api/@coscine/model/resource-dto.ts +++ b/src/Coscine.Api/@coscine/model/resource-dto.ts @@ -27,6 +27,9 @@ import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource import { LicenseDto } from './license-dto'; // May contain unused imports in some cases // @ts-ignore +import { ProjectMinimalDto } from './project-minimal-dto'; +// May contain unused imports in some cases +// @ts-ignore import { ResourceTypeDto } from './resource-type-dto'; // May contain unused imports in some cases // @ts-ignore @@ -149,5 +152,11 @@ export interface ResourceDto { * @memberof ResourceDto */ 'archived'?: boolean; + /** + * The projects associated with the resource. + * @type {Array<ProjectMinimalDto>} + * @memberof ResourceDto + */ + 'projects'?: Array<ProjectMinimalDto> | null; } diff --git a/src/Coscine.Api/@coscine/model/variant-dto.ts b/src/Coscine.Api/@coscine/model/variant-dto.ts new file mode 100644 index 0000000000000000000000000000000000000000..239f24f930792206accd5bcc9a84921fda361945 --- /dev/null +++ b/src/Coscine.Api/@coscine/model/variant-dto.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Coscine Web API + * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. + * + * The version of the OpenAPI document: 2.0 + * Contact: servicedesk@itc.rwth-aachen.de + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Represents the variants of this specific metadata tree. + * @export + * @interface VariantDto + */ +export interface VariantDto { + /** + * Name of the graph. + * @type {string} + * @memberof VariantDto + */ + 'graphName'?: string; + /** + * Similarity value 0-1 + * @type {number} + * @memberof VariantDto + */ + 'similarity'?: number; +} + diff --git a/src/Coscine.Api/api.ts b/src/Coscine.Api/api.ts index 6c6142da1f5363a608939dbc11894a2022a7cc2c..665ff0519585ca3ffcf62de3aa5f421066fc3463 100644 --- a/src/Coscine.Api/api.ts +++ b/src/Coscine.Api/api.ts @@ -32,6 +32,7 @@ export * from './@coscine/api/project-quota-api'; export * from './@coscine/api/project-resource-api'; export * from './@coscine/api/project-resource-quota-api'; export * from './@coscine/api/project-resource-type-api'; +export * from './@coscine/api/provenance-api'; export * from './@coscine/api/resource-api'; export * from './@coscine/api/resource-type-api'; export * from './@coscine/api/role-api'; diff --git a/src/Coscine.Api/base.ts b/src/Coscine.Api/base.ts index 7a1bec6f19c665469ce93b9126c0d62dcb199f5a..4ff64b63b683b53a801189aa7a535d512101dfc7 100644 --- a/src/Coscine.Api/base.ts +++ b/src/Coscine.Api/base.ts @@ -19,7 +19,7 @@ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://d-sp23.devlef.campus.rwth-aachen.de/coscine".replace(/\/+$/, ""); +export const BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine".replace(/\/+$/, ""); /** *