Skip to content
Snippets Groups Projects
Commit 28180a6a authored by Benedikt Heinrichs's avatar Benedikt Heinrichs
Browse files

Remove old Notice Api

parent 91876e05
No related branches found
No related tags found
1 merge request!68New: Maintenance API
Hide whitespace changes
Inline Side-by-side
Showing
with 0 additions and 674 deletions
src/Coscine.Api.Notices/.gitignore deleted 100644 → 0
+ 0
− 4
View file @ 91876e05
wwwroot/*.js
node_modules
typings
dist
src/Coscine.Api.Notices/.npmignore deleted 100644 → 0
+ 0
− 1
View file @ 91876e05
# 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.Notices/.openapi-generator-ignore deleted 100644 → 0
+ 0
− 23
View file @ 91876e05
# 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.Notices/.openapi-generator/FILES deleted 100644 → 0
+ 0
− 9
View file @ 91876e05
.gitignore
.npmignore
.openapi-generator-ignore
api.ts
base.ts
common.ts
configuration.ts
git_push.sh
index.ts
src/Coscine.Api.Notices/.openapi-generator/VERSION deleted 100644 → 0
+ 0
− 1
View file @ 91876e05
5.2.1
\ No newline at end of file
src/Coscine.Api.Notices/api.ts deleted 100644 → 0
+ 0
− 250
View file @ 91876e05
/* tslint:disable */
/* eslint-disable */
/**
* Coscine.Api.Notices
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.4.0
*
*
* 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';
/**
* This class represents a maintenance with its significant properties, which is returned from the api.
* @export
* @interface MaintenanceReturnObject
*/
export interface MaintenanceReturnObject {
/**
* Maintenance title.
* @type {string}
* @memberof MaintenanceReturnObject
*/
displayName?: string | null;
/**
* Maintenance url.
* @type {string}
* @memberof MaintenanceReturnObject
*/
url?: string | null;
/**
* Maintenance type.
* @type {string}
* @memberof MaintenanceReturnObject
*/
type?: string | null;
/**
* Maintenance description.
* @type {string}
* @memberof MaintenanceReturnObject
*/
body?: string | null;
/**
* Maintenance start.
* @type {string}
* @memberof MaintenanceReturnObject
*/
startsDate?: string | null;
/**
* Maintenance end.
* @type {string}
* @memberof MaintenanceReturnObject
*/
endsDate?: string | null;
}
/**
* NoticeApi - axios parameter creator
* @export
*/
export const NoticeApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Returns defined properties of the first entry of the rss feed
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
noticeGetMaintenance: async (options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/Notice/getMaintenance`;
// 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 Returns a notice
* @param {string} documentSlug Slug defining a configured notice
* @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
noticeGetNotice: async (documentSlug: string, language?: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'documentSlug' is not null or undefined
assertParamExists('noticeGetNotice', 'documentSlug', documentSlug)
const localVarPath = `/Notice/{documentSlug}`
.replace(`{${"documentSlug"}}`, encodeURIComponent(String(documentSlug)));
// 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)
if (language !== undefined) {
localVarQueryParameter['language'] = language;
}
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* NoticeApi - functional programming interface
* @export
*/
export const NoticeApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = NoticeApiAxiosParamCreator(configuration)
return {
/**
*
* @summary Returns defined properties of the first entry of the rss feed
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async noticeGetMaintenance(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MaintenanceReturnObject>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.noticeGetMaintenance(options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
*
* @summary Returns a notice
* @param {string} documentSlug Slug defining a configured notice
* @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
async noticeGetNotice(documentSlug: string, language?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.noticeGetNotice(documentSlug, language, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* NoticeApi - factory interface
* @export
*/
export const NoticeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = NoticeApiFp(configuration)
return {
/**
*
* @summary Returns defined properties of the first entry of the rss feed
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
noticeGetMaintenance(options?: any): AxiosPromise<MaintenanceReturnObject> {
return localVarFp.noticeGetMaintenance(options).then((request) => request(axios, basePath));
},
/**
*
* @summary Returns a notice
* @param {string} documentSlug Slug defining a configured notice
* @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
noticeGetNotice(documentSlug: string, language?: string, options?: any): AxiosPromise<any> {
return localVarFp.noticeGetNotice(documentSlug, language, options).then((request) => request(axios, basePath));
},
};
};
/**
* NoticeApi - object-oriented interface
* @export
* @class NoticeApi
* @extends {BaseAPI}
*/
export class NoticeApi extends BaseAPI {
/**
*
* @summary Returns defined properties of the first entry of the rss feed
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NoticeApi
*/
public noticeGetMaintenance(options?: any) {
return NoticeApiFp(this.configuration).noticeGetMaintenance(options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Returns a notice
* @param {string} documentSlug Slug defining a configured notice
* @param {string} [language] Language (e.g. \&quot;en\&quot; or \&quot;de\&quot;)
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
* @memberof NoticeApi
*/
public noticeGetNotice(documentSlug: string, language?: string, options?: any) {
return NoticeApiFp(this.configuration).noticeGetNotice(documentSlug, language, options).then((request) => request(this.axios, this.basePath));
}
}
src/Coscine.Api.Notices/base.ts deleted 100644 → 0
+ 0
− 71
View file @ 91876e05
/* tslint:disable */
/* eslint-disable */
/**
* Coscine.Api.Notices
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.4.0
*
*
* 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-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Notices".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.Notices/common.ts deleted 100644 → 0
+ 0
− 138
View file @ 91876e05
/* tslint:disable */
/* eslint-disable */
/**
* Coscine.Api.Notices
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.4.0
*
*
* 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.Notices/configuration.ts deleted 100644 → 0
+ 0
− 101
View file @ 91876e05
/* tslint:disable */
/* eslint-disable */
/**
* Coscine.Api.Notices
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.4.0
*
*
* 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.Notices/git_push.sh deleted 100644 → 0
+ 0
− 58
View file @ 91876e05
#!/bin/sh
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
#
# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
git_user_id=$1
git_repo_id=$2
release_note=$3
git_host=$4
if [ "$git_host" = "" ]; then
git_host="github.com"
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
fi
if [ "$git_user_id" = "" ]; then
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi
if [ "$release_note" = "" ]; then
release_note="Minor update"
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
fi
# Initialize the local directory as a Git repository
git init
# Adds the files in the local repository and stages them for commit.
git add .
# Commits the tracked changes and prepares them to be pushed to a remote repository.
git commit -m "$release_note"
# Sets the new remote
git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined
if [ "$GIT_TOKEN" = "" ]; then
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
else
git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
fi
fi
git pull origin master
# Pushes (Forces) the changes in the local repository up to the remote repository
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
git push origin master 2>&1 | grep -v 'To https'
src/Coscine.Api.Notices/index.ts deleted 100644 → 0
+ 0
− 18
View file @ 91876e05
/* tslint:disable */
/* eslint-disable */
/**
* Coscine.Api.Notices
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.4.0
*
*
* 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";
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment