Update: PID Validation Method

.gitignore

@@ -24,7 +24,6 @@ yarn-error.log*
 
 # Runtime data
 pids
-*.pid
 *.seed
 *.pid.lock
 

src/Coscine.Api.Pid/.gitignore

+wwwroot/*.js
+node_modules
+typings
+dist

src/Coscine.Api.Pid/.npmignore

+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm
\ No newline at end of file

src/Coscine.Api.Pid/.openapi-generator-ignore

+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

src/Coscine.Api.Pid/.openapi-generator/FILES

+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts

src/Coscine.Api.Pid/.openapi-generator/VERSION

+5.2.1
\ No newline at end of file

src/Coscine.Api.Pid/api.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine.Api.Pid
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.3.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from './configuration';
+import globalAxios, { AxiosPromise, AxiosInstance } 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 } from './base';
+
+/**
+ * Message Object.
+ * @export
+ * @interface MessageObject
+ */
+export interface MessageObject {
+    /**
+     * Name of the requester.
+     * @type {string}
+     * @memberof MessageObject
+     */
+    name?: string | null;
+    /**
+     * Email address of the requester.
+     * @type {string}
+     * @memberof MessageObject
+     */
+    email?: string | null;
+    /**
+     * Message Text.
+     * @type {string}
+     * @memberof MessageObject
+     */
+    message?: string | null;
+    /**
+     * Send copy to requester.
+     * @type {boolean}
+     * @memberof MessageObject
+     */
+    sendCopy?: boolean;
+    /**
+     * Pid of the resource.
+     * @type {string}
+     * @memberof MessageObject
+     */
+    pid?: string | null;
+    /**
+     * Message Object.
+     * @type {string}
+     * @memberof MessageObject
+     */
+    guid?: string | null;
+}
+
+/**
+ * PidApi - axios parameter creator
+ * @export
+ */
+export const PidApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Returns a 200, if a PID is valid.
+         * @param {string} pid PID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pidIsValid: async (pid: string, options: any = {}): Promise<RequestArgs> => {
+            // verify required parameter 'pid' is not null or undefined
+            assertParamExists('pidIsValid', 'pid', pid)
+            const localVarPath = `/Pid/valid/{pid}`
+                .replace(`{${"pid"}}`, encodeURIComponent(String(pid)));
+            // 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 JWT token required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Sends a request to the pid owner.
+         * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pidSendMailToOwner: async (messageObject: MessageObject, options: any = {}): Promise<RequestArgs> => {
+            // verify required parameter 'messageObject' is not null or undefined
+            assertParamExists('pidSendMailToOwner', 'messageObject', messageObject)
+            const localVarPath = `/Pid/sendMailToOwner`;
+            // 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 JWT token required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(messageObject, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PidApi - functional programming interface
+ * @export
+ */
+export const PidApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PidApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Returns a 200, if a PID is valid.
+         * @param {string} pid PID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async pidIsValid(pid: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.pidIsValid(pid, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 
+         * @summary Sends a request to the pid owner.
+         * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async pidSendMailToOwner(messageObject: MessageObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.pidSendMailToOwner(messageObject, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * PidApi - factory interface
+ * @export
+ */
+export const PidApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PidApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Returns a 200, if a PID is valid.
+         * @param {string} pid PID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pidIsValid(pid: string, options?: any): AxiosPromise<any> {
+            return localVarFp.pidIsValid(pid, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Sends a request to the pid owner.
+         * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pidSendMailToOwner(messageObject: MessageObject, options?: any): AxiosPromise<any> {
+            return localVarFp.pidSendMailToOwner(messageObject, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * PidApi - object-oriented interface
+ * @export
+ * @class PidApi
+ * @extends {BaseAPI}
+ */
+export class PidApi extends BaseAPI {
+    /**
+     * 
+     * @summary Returns a 200, if a PID is valid.
+     * @param {string} pid PID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    public pidIsValid(pid: string, options?: any) {
+        return PidApiFp(this.configuration).pidIsValid(pid, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Sends a request to the pid owner.
+     * @param {MessageObject} messageObject Entry with the information for the email to the pid owner.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    public pidSendMailToOwner(messageObject: MessageObject, options?: any) {
+        return PidApiFp(this.configuration).pidSendMailToOwner(messageObject, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+

src/Coscine.Api.Pid/base.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine.Api.Pid
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.3.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from "./configuration";
+// Some imports not used depending on template conditions
+// @ts-ignore
+import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
+
+export const BASE_PATH = "https://d-sp23.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Pid".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: any;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}

src/Coscine.Api.Pid/common.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine.Api.Pid
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.3.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from "./configuration";
+import { RequiredError, RequestArgs } from "./base";
+import { AxiosInstance } from 'axios';
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    for (const object of objects) {
+        for (const key in object) {
+            if (Array.isArray(object[key])) {
+                searchParams.delete(key);
+                for (const item of object[key]) {
+                    searchParams.append(key, item);
+                }
+            } else {
+                searchParams.set(key, object[key]);
+            }
+        }
+    }
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url};
+        return axios.request(axiosRequestArgs);
+    };
+}

src/Coscine.Api.Pid/configuration.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine.Api.Pid
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.3.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

src/Coscine.Api.Pid/index.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coscine.Api.Pid
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.3.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

src/apis.ts

@@ -6,6 +6,7 @@ import { BlobApiFactory } from './Coscine.Api.Blob/api';
 import { MetadataApiFactory } from './Coscine.Api.Metadata/api';
 import { NoticeApiFactory } from './Coscine.Api.Notices/api';
 import { OrganizationApiFactory } from './Coscine.Api.Organization/api';
+import { PidApiFactory } from './Coscine.Api.Pid/api';
 import { DisciplineApiFactory } from './Coscine.Api.Project/api';
 import { LicenseApiFactory } from './Coscine.Api.Project/api';
 import { ProjectApiFactory } from './Coscine.Api.Project/api';
@@ -60,6 +61,7 @@ function implementations(axios?: AxiosInstance) {
     MetadataApi: MetadataApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Metadata', axios),
     NoticeApi: NoticeApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Notices', axios),
     OrganizationApi: OrganizationApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Organization', axios),
+    PidApi: PidApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Pid', axios),
     ProjectApi: ProjectApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Project', axios),
     ProjectQuotaApi: ProjectQuotaApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Project', axios),
     ProjectRoleApi: ProjectRoleApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Project', axios),

src/index.ts

@@ -12,6 +12,7 @@ export const LicenseApi = apis.LicenseApi;
 export const MetadataApi = apis.MetadataApi;
 export const NoticeApi = apis.NoticeApi;
 export const OrganizationApi = apis.OrganizationApi;
+export const PidApi = apis.PidApi;
 export const ProjectApi = apis.ProjectApi;
 export const ProjectQuotaApi = apis.ProjectQuotaApi;
 export const ProjectRoleApi = apis.ProjectRoleApi;