kitstore-cli 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/config.js +20 -4
- package/package.json +5 -1
- package/.env.test +0 -4
- package/.eslintrc.js +0 -29
- package/e2e/install.e2e.test.ts +0 -237
- package/e2e/integration.e2e.test.ts +0 -346
- package/e2e/login.e2e.test.ts +0 -188
- package/jest.config.js +0 -24
- package/openapitools.json +0 -7
- package/src/__tests__/commands/init.test.ts +0 -52
- package/src/__tests__/commands/install.test.ts +0 -449
- package/src/__tests__/commands/list.test.ts +0 -164
- package/src/__tests__/commands/login.test.ts +0 -293
- package/src/__tests__/commands/rule-check.test.ts +0 -52
- package/src/__tests__/commands/search.test.ts +0 -168
- package/src/__tests__/commands/upload.test.ts +0 -404
- package/src/__tests__/config.test.ts +0 -181
- package/src/__tests__/setup.ts +0 -11
- package/src/api/client.ts +0 -20
- package/src/api/generated/.openapi-generator/FILES +0 -17
- package/src/api/generated/.openapi-generator/VERSION +0 -1
- package/src/api/generated/.openapi-generator-ignore +0 -23
- package/src/api/generated/api.ts +0 -1171
- package/src/api/generated/base.ts +0 -62
- package/src/api/generated/common.ts +0 -113
- package/src/api/generated/configuration.ts +0 -121
- package/src/api/generated/docs/AuthApi.md +0 -158
- package/src/api/generated/docs/AuthResponseDto.md +0 -22
- package/src/api/generated/docs/AuthUserDto.md +0 -24
- package/src/api/generated/docs/HealthApi.md +0 -183
- package/src/api/generated/docs/LoginDto.md +0 -22
- package/src/api/generated/docs/RegisterDto.md +0 -24
- package/src/api/generated/docs/RuleAuthorDto.md +0 -22
- package/src/api/generated/docs/RuleResponseDto.md +0 -36
- package/src/api/generated/docs/RulesApi.md +0 -289
- package/src/api/generated/git_push.sh +0 -57
- package/src/api/generated/index.ts +0 -18
- package/src/commands/init.ts +0 -46
- package/src/commands/install.ts +0 -129
- package/src/commands/list.ts +0 -71
- package/src/commands/login.ts +0 -65
- package/src/commands/rule-check.ts +0 -49
- package/src/commands/search.ts +0 -66
- package/src/commands/upload.ts +0 -117
- package/src/config.ts +0 -66
- package/src/index.ts +0 -79
- package/test-cli-config.js +0 -118
- package/tsconfig.json +0 -24
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Cursor Kit API
|
|
5
|
-
* API for managing Cursor rules and commands
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
import type { Configuration } from './configuration';
|
|
17
|
-
// Some imports not used depending on template conditions
|
|
18
|
-
// @ts-ignore
|
|
19
|
-
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
20
|
-
import globalAxios from 'axios';
|
|
21
|
-
|
|
22
|
-
export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
|
|
23
|
-
|
|
24
|
-
export const COLLECTION_FORMATS = {
|
|
25
|
-
csv: ",",
|
|
26
|
-
ssv: " ",
|
|
27
|
-
tsv: "\t",
|
|
28
|
-
pipes: "|",
|
|
29
|
-
};
|
|
30
|
-
|
|
31
|
-
export interface RequestArgs {
|
|
32
|
-
url: string;
|
|
33
|
-
options: RawAxiosRequestConfig;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export class BaseAPI {
|
|
37
|
-
protected configuration: Configuration | undefined;
|
|
38
|
-
|
|
39
|
-
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
|
|
40
|
-
if (configuration) {
|
|
41
|
-
this.configuration = configuration;
|
|
42
|
-
this.basePath = configuration.basePath ?? basePath;
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
};
|
|
46
|
-
|
|
47
|
-
export class RequiredError extends Error {
|
|
48
|
-
constructor(public field: string, msg?: string) {
|
|
49
|
-
super(msg);
|
|
50
|
-
this.name = "RequiredError"
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
interface ServerMap {
|
|
55
|
-
[key: string]: {
|
|
56
|
-
url: string,
|
|
57
|
-
description: string,
|
|
58
|
-
}[];
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export const operationServerMap: ServerMap = {
|
|
62
|
-
}
|
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Cursor Kit API
|
|
5
|
-
* API for managing Cursor rules and commands
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
import type { Configuration } from "./configuration";
|
|
16
|
-
import type { RequestArgs } from "./base";
|
|
17
|
-
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
18
|
-
import { RequiredError } from "./base";
|
|
19
|
-
|
|
20
|
-
export const DUMMY_BASE_URL = 'https://example.com'
|
|
21
|
-
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @throws {RequiredError}
|
|
25
|
-
*/
|
|
26
|
-
export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
|
|
27
|
-
if (paramValue === null || paramValue === undefined) {
|
|
28
|
-
throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
|
|
33
|
-
if (configuration && configuration.apiKey) {
|
|
34
|
-
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
35
|
-
? await configuration.apiKey(keyParamName)
|
|
36
|
-
: await configuration.apiKey;
|
|
37
|
-
object[keyParamName] = localVarApiKeyValue;
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
|
|
42
|
-
if (configuration && (configuration.username || configuration.password)) {
|
|
43
|
-
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
|
|
48
|
-
if (configuration && configuration.accessToken) {
|
|
49
|
-
const accessToken = typeof configuration.accessToken === 'function'
|
|
50
|
-
? await configuration.accessToken()
|
|
51
|
-
: await configuration.accessToken;
|
|
52
|
-
object["Authorization"] = "Bearer " + accessToken;
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
|
|
57
|
-
if (configuration && configuration.accessToken) {
|
|
58
|
-
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
59
|
-
? await configuration.accessToken(name, scopes)
|
|
60
|
-
: await configuration.accessToken;
|
|
61
|
-
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
|
|
67
|
-
if (parameter == null) return;
|
|
68
|
-
if (typeof parameter === "object") {
|
|
69
|
-
if (Array.isArray(parameter)) {
|
|
70
|
-
(parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
71
|
-
}
|
|
72
|
-
else {
|
|
73
|
-
Object.keys(parameter).forEach(currentKey =>
|
|
74
|
-
setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
|
|
75
|
-
);
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
else {
|
|
79
|
-
if (urlSearchParams.has(key)) {
|
|
80
|
-
urlSearchParams.append(key, parameter);
|
|
81
|
-
}
|
|
82
|
-
else {
|
|
83
|
-
urlSearchParams.set(key, parameter);
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
export const setSearchParams = function (url: URL, ...objects: any[]) {
|
|
89
|
-
const searchParams = new URLSearchParams(url.search);
|
|
90
|
-
setFlattenedQueryParams(searchParams, objects);
|
|
91
|
-
url.search = searchParams.toString();
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
|
|
95
|
-
const nonString = typeof value !== 'string';
|
|
96
|
-
const needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
97
|
-
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
98
|
-
: nonString;
|
|
99
|
-
return needsSerialization
|
|
100
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
101
|
-
: (value || "");
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
export const toPathString = function (url: URL) {
|
|
105
|
-
return url.pathname + url.search + url.hash
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
|
|
109
|
-
return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
110
|
-
const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
|
|
111
|
-
return axios.request<T, R>(axiosRequestArgs);
|
|
112
|
-
};
|
|
113
|
-
}
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/**
|
|
3
|
-
* Cursor Kit API
|
|
4
|
-
* API for managing Cursor rules and commands
|
|
5
|
-
*
|
|
6
|
-
* The version of the OpenAPI document: 1.0
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
-
* https://openapi-generator.tech
|
|
11
|
-
* Do not edit the class manually.
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
interface AWSv4Configuration {
|
|
15
|
-
options?: {
|
|
16
|
-
region?: string
|
|
17
|
-
service?: string
|
|
18
|
-
}
|
|
19
|
-
credentials?: {
|
|
20
|
-
accessKeyId?: string
|
|
21
|
-
secretAccessKey?: string,
|
|
22
|
-
sessionToken?: string
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
export interface ConfigurationParameters {
|
|
27
|
-
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
-
username?: string;
|
|
29
|
-
password?: string;
|
|
30
|
-
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
-
awsv4?: AWSv4Configuration;
|
|
32
|
-
basePath?: string;
|
|
33
|
-
serverIndex?: number;
|
|
34
|
-
baseOptions?: any;
|
|
35
|
-
formDataCtor?: new () => any;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
export class Configuration {
|
|
39
|
-
/**
|
|
40
|
-
* parameter for apiKey security
|
|
41
|
-
* @param name security name
|
|
42
|
-
*/
|
|
43
|
-
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
44
|
-
/**
|
|
45
|
-
* parameter for basic security
|
|
46
|
-
*/
|
|
47
|
-
username?: string;
|
|
48
|
-
/**
|
|
49
|
-
* parameter for basic security
|
|
50
|
-
*/
|
|
51
|
-
password?: string;
|
|
52
|
-
/**
|
|
53
|
-
* parameter for oauth2 security
|
|
54
|
-
* @param name security name
|
|
55
|
-
* @param scopes oauth2 scope
|
|
56
|
-
*/
|
|
57
|
-
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
-
/**
|
|
59
|
-
* parameter for aws4 signature security
|
|
60
|
-
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
-
* @param {string} options.region - aws region
|
|
62
|
-
* @param {string} options.service - name of the service.
|
|
63
|
-
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
-
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
-
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
-
* @memberof Configuration
|
|
67
|
-
*/
|
|
68
|
-
awsv4?: AWSv4Configuration;
|
|
69
|
-
/**
|
|
70
|
-
* override base path
|
|
71
|
-
*/
|
|
72
|
-
basePath?: string;
|
|
73
|
-
/**
|
|
74
|
-
* override server index
|
|
75
|
-
*/
|
|
76
|
-
serverIndex?: number;
|
|
77
|
-
/**
|
|
78
|
-
* base options for axios calls
|
|
79
|
-
*/
|
|
80
|
-
baseOptions?: any;
|
|
81
|
-
/**
|
|
82
|
-
* The FormData constructor that will be used to create multipart form data
|
|
83
|
-
* requests. You can inject this here so that execution environments that
|
|
84
|
-
* do not support the FormData class can still run the generated client.
|
|
85
|
-
*
|
|
86
|
-
* @type {new () => FormData}
|
|
87
|
-
*/
|
|
88
|
-
formDataCtor?: new () => any;
|
|
89
|
-
|
|
90
|
-
constructor(param: ConfigurationParameters = {}) {
|
|
91
|
-
this.apiKey = param.apiKey;
|
|
92
|
-
this.username = param.username;
|
|
93
|
-
this.password = param.password;
|
|
94
|
-
this.accessToken = param.accessToken;
|
|
95
|
-
this.awsv4 = param.awsv4;
|
|
96
|
-
this.basePath = param.basePath;
|
|
97
|
-
this.serverIndex = param.serverIndex;
|
|
98
|
-
this.baseOptions = {
|
|
99
|
-
...param.baseOptions,
|
|
100
|
-
headers: {
|
|
101
|
-
...param.baseOptions?.headers,
|
|
102
|
-
},
|
|
103
|
-
};
|
|
104
|
-
this.formDataCtor = param.formDataCtor;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* Check if the given MIME is a JSON MIME.
|
|
109
|
-
* JSON MIME examples:
|
|
110
|
-
* application/json
|
|
111
|
-
* application/json; charset=UTF8
|
|
112
|
-
* APPLICATION/JSON
|
|
113
|
-
* application/vnd.company+json
|
|
114
|
-
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
115
|
-
* @return True if the given MIME is JSON, false otherwise.
|
|
116
|
-
*/
|
|
117
|
-
public isJsonMime(mime: string): boolean {
|
|
118
|
-
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
119
|
-
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
120
|
-
}
|
|
121
|
-
}
|
|
@@ -1,158 +0,0 @@
|
|
|
1
|
-
# AuthApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**authControllerLogin**](#authcontrollerlogin) | **POST** /api/auth/login | Login user|
|
|
8
|
-
|[**authControllerRegister**](#authcontrollerregister) | **POST** /api/auth/register | Register new user|
|
|
9
|
-
|[**authControllerValidate**](#authcontrollervalidate) | **POST** /api/auth/validate | Validate token|
|
|
10
|
-
|
|
11
|
-
# **authControllerLogin**
|
|
12
|
-
> AuthResponseDto authControllerLogin(loginDto)
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
### Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import {
|
|
19
|
-
AuthApi,
|
|
20
|
-
Configuration,
|
|
21
|
-
LoginDto
|
|
22
|
-
} from './api';
|
|
23
|
-
|
|
24
|
-
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new AuthApi(configuration);
|
|
26
|
-
|
|
27
|
-
let loginDto: LoginDto; //
|
|
28
|
-
|
|
29
|
-
const { status, data } = await apiInstance.authControllerLogin(
|
|
30
|
-
loginDto
|
|
31
|
-
);
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### Parameters
|
|
35
|
-
|
|
36
|
-
|Name | Type | Description | Notes|
|
|
37
|
-
|------------- | ------------- | ------------- | -------------|
|
|
38
|
-
| **loginDto** | **LoginDto**| | |
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
### Return type
|
|
42
|
-
|
|
43
|
-
**AuthResponseDto**
|
|
44
|
-
|
|
45
|
-
### Authorization
|
|
46
|
-
|
|
47
|
-
No authorization required
|
|
48
|
-
|
|
49
|
-
### HTTP request headers
|
|
50
|
-
|
|
51
|
-
- **Content-Type**: application/json
|
|
52
|
-
- **Accept**: application/json
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
### HTTP response details
|
|
56
|
-
| Status code | Description | Response headers |
|
|
57
|
-
|-------------|-------------|------------------|
|
|
58
|
-
|**200** | | - |
|
|
59
|
-
|**401** | Invalid credentials | - |
|
|
60
|
-
|
|
61
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
62
|
-
|
|
63
|
-
# **authControllerRegister**
|
|
64
|
-
> AuthResponseDto authControllerRegister(registerDto)
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
### Example
|
|
68
|
-
|
|
69
|
-
```typescript
|
|
70
|
-
import {
|
|
71
|
-
AuthApi,
|
|
72
|
-
Configuration,
|
|
73
|
-
RegisterDto
|
|
74
|
-
} from './api';
|
|
75
|
-
|
|
76
|
-
const configuration = new Configuration();
|
|
77
|
-
const apiInstance = new AuthApi(configuration);
|
|
78
|
-
|
|
79
|
-
let registerDto: RegisterDto; //
|
|
80
|
-
|
|
81
|
-
const { status, data } = await apiInstance.authControllerRegister(
|
|
82
|
-
registerDto
|
|
83
|
-
);
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### Parameters
|
|
87
|
-
|
|
88
|
-
|Name | Type | Description | Notes|
|
|
89
|
-
|------------- | ------------- | ------------- | -------------|
|
|
90
|
-
| **registerDto** | **RegisterDto**| | |
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
### Return type
|
|
94
|
-
|
|
95
|
-
**AuthResponseDto**
|
|
96
|
-
|
|
97
|
-
### Authorization
|
|
98
|
-
|
|
99
|
-
No authorization required
|
|
100
|
-
|
|
101
|
-
### HTTP request headers
|
|
102
|
-
|
|
103
|
-
- **Content-Type**: application/json
|
|
104
|
-
- **Accept**: application/json
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### HTTP response details
|
|
108
|
-
| Status code | Description | Response headers |
|
|
109
|
-
|-------------|-------------|------------------|
|
|
110
|
-
|**201** | | - |
|
|
111
|
-
|**409** | User already exists | - |
|
|
112
|
-
|
|
113
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
114
|
-
|
|
115
|
-
# **authControllerValidate**
|
|
116
|
-
> authControllerValidate()
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
### Example
|
|
120
|
-
|
|
121
|
-
```typescript
|
|
122
|
-
import {
|
|
123
|
-
AuthApi,
|
|
124
|
-
Configuration
|
|
125
|
-
} from './api';
|
|
126
|
-
|
|
127
|
-
const configuration = new Configuration();
|
|
128
|
-
const apiInstance = new AuthApi(configuration);
|
|
129
|
-
|
|
130
|
-
const { status, data } = await apiInstance.authControllerValidate();
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### Parameters
|
|
134
|
-
This endpoint does not have any parameters.
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
### Return type
|
|
138
|
-
|
|
139
|
-
void (empty response body)
|
|
140
|
-
|
|
141
|
-
### Authorization
|
|
142
|
-
|
|
143
|
-
[bearer](../README.md#bearer)
|
|
144
|
-
|
|
145
|
-
### HTTP request headers
|
|
146
|
-
|
|
147
|
-
- **Content-Type**: Not defined
|
|
148
|
-
- **Accept**: Not defined
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
### HTTP response details
|
|
152
|
-
| Status code | Description | Response headers |
|
|
153
|
-
|-------------|-------------|------------------|
|
|
154
|
-
|**200** | Token is valid | - |
|
|
155
|
-
|**401** | Token is invalid | - |
|
|
156
|
-
|
|
157
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
158
|
-
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# AuthResponseDto
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**user** | [**AuthUserDto**](AuthUserDto.md) | | [default to undefined]
|
|
9
|
-
**token** | **string** | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { AuthResponseDto } from './api';
|
|
15
|
-
|
|
16
|
-
const instance: AuthResponseDto = {
|
|
17
|
-
user,
|
|
18
|
-
token,
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# AuthUserDto
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**username** | **string** | | [default to undefined]
|
|
10
|
-
**email** | **string** | | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { AuthUserDto } from './api';
|
|
16
|
-
|
|
17
|
-
const instance: AuthUserDto = {
|
|
18
|
-
id,
|
|
19
|
-
username,
|
|
20
|
-
email,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,183 +0,0 @@
|
|
|
1
|
-
# HealthApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**healthControllerHealth**](#healthcontrollerhealth) | **GET** /api/health | |
|
|
8
|
-
|[**healthControllerLiveness**](#healthcontrollerliveness) | **GET** /api/health/live | |
|
|
9
|
-
|[**healthControllerPing**](#healthcontrollerping) | **GET** /api/health/ping | |
|
|
10
|
-
|[**healthControllerReadiness**](#healthcontrollerreadiness) | **GET** /api/health/ready | |
|
|
11
|
-
|
|
12
|
-
# **healthControllerHealth**
|
|
13
|
-
> healthControllerHealth()
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
### Example
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import {
|
|
20
|
-
HealthApi,
|
|
21
|
-
Configuration
|
|
22
|
-
} from './api';
|
|
23
|
-
|
|
24
|
-
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new HealthApi(configuration);
|
|
26
|
-
|
|
27
|
-
const { status, data } = await apiInstance.healthControllerHealth();
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
### Parameters
|
|
31
|
-
This endpoint does not have any parameters.
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
### Return type
|
|
35
|
-
|
|
36
|
-
void (empty response body)
|
|
37
|
-
|
|
38
|
-
### Authorization
|
|
39
|
-
|
|
40
|
-
No authorization required
|
|
41
|
-
|
|
42
|
-
### HTTP request headers
|
|
43
|
-
|
|
44
|
-
- **Content-Type**: Not defined
|
|
45
|
-
- **Accept**: Not defined
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
### HTTP response details
|
|
49
|
-
| Status code | Description | Response headers |
|
|
50
|
-
|-------------|-------------|------------------|
|
|
51
|
-
|**200** | | - |
|
|
52
|
-
|
|
53
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
54
|
-
|
|
55
|
-
# **healthControllerLiveness**
|
|
56
|
-
> healthControllerLiveness()
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### Example
|
|
60
|
-
|
|
61
|
-
```typescript
|
|
62
|
-
import {
|
|
63
|
-
HealthApi,
|
|
64
|
-
Configuration
|
|
65
|
-
} from './api';
|
|
66
|
-
|
|
67
|
-
const configuration = new Configuration();
|
|
68
|
-
const apiInstance = new HealthApi(configuration);
|
|
69
|
-
|
|
70
|
-
const { status, data } = await apiInstance.healthControllerLiveness();
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Parameters
|
|
74
|
-
This endpoint does not have any parameters.
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
### Return type
|
|
78
|
-
|
|
79
|
-
void (empty response body)
|
|
80
|
-
|
|
81
|
-
### Authorization
|
|
82
|
-
|
|
83
|
-
No authorization required
|
|
84
|
-
|
|
85
|
-
### HTTP request headers
|
|
86
|
-
|
|
87
|
-
- **Content-Type**: Not defined
|
|
88
|
-
- **Accept**: Not defined
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
### HTTP response details
|
|
92
|
-
| Status code | Description | Response headers |
|
|
93
|
-
|-------------|-------------|------------------|
|
|
94
|
-
|**200** | | - |
|
|
95
|
-
|
|
96
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
97
|
-
|
|
98
|
-
# **healthControllerPing**
|
|
99
|
-
> healthControllerPing()
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
### Example
|
|
103
|
-
|
|
104
|
-
```typescript
|
|
105
|
-
import {
|
|
106
|
-
HealthApi,
|
|
107
|
-
Configuration
|
|
108
|
-
} from './api';
|
|
109
|
-
|
|
110
|
-
const configuration = new Configuration();
|
|
111
|
-
const apiInstance = new HealthApi(configuration);
|
|
112
|
-
|
|
113
|
-
const { status, data } = await apiInstance.healthControllerPing();
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Parameters
|
|
117
|
-
This endpoint does not have any parameters.
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
### Return type
|
|
121
|
-
|
|
122
|
-
void (empty response body)
|
|
123
|
-
|
|
124
|
-
### Authorization
|
|
125
|
-
|
|
126
|
-
No authorization required
|
|
127
|
-
|
|
128
|
-
### HTTP request headers
|
|
129
|
-
|
|
130
|
-
- **Content-Type**: Not defined
|
|
131
|
-
- **Accept**: Not defined
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
### HTTP response details
|
|
135
|
-
| Status code | Description | Response headers |
|
|
136
|
-
|-------------|-------------|------------------|
|
|
137
|
-
|**200** | | - |
|
|
138
|
-
|
|
139
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
140
|
-
|
|
141
|
-
# **healthControllerReadiness**
|
|
142
|
-
> healthControllerReadiness()
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
### Example
|
|
146
|
-
|
|
147
|
-
```typescript
|
|
148
|
-
import {
|
|
149
|
-
HealthApi,
|
|
150
|
-
Configuration
|
|
151
|
-
} from './api';
|
|
152
|
-
|
|
153
|
-
const configuration = new Configuration();
|
|
154
|
-
const apiInstance = new HealthApi(configuration);
|
|
155
|
-
|
|
156
|
-
const { status, data } = await apiInstance.healthControllerReadiness();
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
### Parameters
|
|
160
|
-
This endpoint does not have any parameters.
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
### Return type
|
|
164
|
-
|
|
165
|
-
void (empty response body)
|
|
166
|
-
|
|
167
|
-
### Authorization
|
|
168
|
-
|
|
169
|
-
No authorization required
|
|
170
|
-
|
|
171
|
-
### HTTP request headers
|
|
172
|
-
|
|
173
|
-
- **Content-Type**: Not defined
|
|
174
|
-
- **Accept**: Not defined
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
### HTTP response details
|
|
178
|
-
| Status code | Description | Response headers |
|
|
179
|
-
|-------------|-------------|------------------|
|
|
180
|
-
|**200** | | - |
|
|
181
|
-
|
|
182
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
183
|
-
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# LoginDto
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**email** | **string** | | [default to undefined]
|
|
9
|
-
**password** | **string** | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { LoginDto } from './api';
|
|
15
|
-
|
|
16
|
-
const instance: LoginDto = {
|
|
17
|
-
email,
|
|
18
|
-
password,
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|