@se-uulm/snowballr-api-client 0.2.1-alpha.e0abdd5 → 0.2.1-alpha.e8b05f4

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.
Files changed (61) hide show
  1. package/README.md +23 -14
  2. package/dist/apis/AuthControllerApi.d.ts +181 -0
  3. package/dist/apis/AuthControllerApi.js +216 -0
  4. package/dist/apis/ProjectsControllerApi.d.ts +13 -13
  5. package/dist/apis/ProjectsControllerApi.js +8 -8
  6. package/dist/apis/UsersControllerApi.d.ts +60 -0
  7. package/dist/apis/UsersControllerApi.js +70 -0
  8. package/dist/apis/index.d.ts +2 -0
  9. package/dist/apis/index.js +2 -0
  10. package/dist/esm/apis/AuthControllerApi.d.ts +181 -0
  11. package/dist/esm/apis/AuthControllerApi.js +212 -0
  12. package/dist/esm/apis/ProjectsControllerApi.d.ts +13 -13
  13. package/dist/esm/apis/ProjectsControllerApi.js +8 -8
  14. package/dist/esm/apis/UsersControllerApi.d.ts +60 -0
  15. package/dist/esm/apis/UsersControllerApi.js +66 -0
  16. package/dist/esm/apis/index.d.ts +2 -0
  17. package/dist/esm/apis/index.js +2 -0
  18. package/dist/esm/models/ChangePasswordRequest.d.ts +34 -0
  19. package/dist/esm/models/ChangePasswordRequest.js +43 -0
  20. package/dist/esm/models/LoginRequest.d.ts +34 -0
  21. package/dist/esm/models/LoginRequest.js +43 -0
  22. package/dist/{models/Project.d.ts → esm/models/ProjectResponse.d.ts} +13 -13
  23. package/dist/esm/models/{Project.js → ProjectResponse.js} +11 -11
  24. package/dist/esm/models/RegisterRequest.d.ts +42 -0
  25. package/dist/esm/models/RegisterRequest.js +47 -0
  26. package/dist/esm/models/index.d.ts +4 -1
  27. package/dist/esm/models/index.js +4 -1
  28. package/dist/models/ChangePasswordRequest.d.ts +34 -0
  29. package/dist/models/ChangePasswordRequest.js +50 -0
  30. package/dist/models/LoginRequest.d.ts +34 -0
  31. package/dist/models/LoginRequest.js +50 -0
  32. package/dist/{esm/models/Project.d.ts → models/ProjectResponse.d.ts} +13 -13
  33. package/dist/models/{Project.js → ProjectResponse.js} +17 -17
  34. package/dist/models/RegisterRequest.d.ts +42 -0
  35. package/dist/models/RegisterRequest.js +54 -0
  36. package/dist/models/index.d.ts +4 -1
  37. package/dist/models/index.js +4 -1
  38. package/package.json +10 -4
  39. package/.openapi-generator/FILES +0 -25
  40. package/.openapi-generator/VERSION +0 -1
  41. package/.openapi-generator-ignore +0 -23
  42. package/docs/CreateProjectRequest.md +0 -34
  43. package/docs/DecisionMatrixPattern.md +0 -36
  44. package/docs/DecisionMatrixPatternEntry.md +0 -36
  45. package/docs/Project.md +0 -46
  46. package/docs/ProjectSettings.md +0 -42
  47. package/docs/ProjectsControllerApi.md +0 -264
  48. package/docs/ReviewDecisionMatrix.md +0 -36
  49. package/src/apis/ProjectsControllerApi.ts +0 -309
  50. package/src/apis/index.ts +0 -3
  51. package/src/index.ts +0 -5
  52. package/src/models/CreateProjectRequest.ts +0 -63
  53. package/src/models/DecisionMatrixPattern.ts +0 -90
  54. package/src/models/DecisionMatrixPatternEntry.ts +0 -81
  55. package/src/models/Project.ts +0 -121
  56. package/src/models/ProjectSettings.ts +0 -107
  57. package/src/models/ReviewDecisionMatrix.ts +0 -77
  58. package/src/models/index.ts +0 -8
  59. package/src/runtime.ts +0 -572
  60. package/tsconfig.esm.json +0 -7
  61. package/tsconfig.json +0 -16
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * SnowballR API
6
+ * REST API for the SnowballR Application
7
+ *
8
+ * The version of the OpenAPI document: v1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfChangePasswordRequest = instanceOfChangePasswordRequest;
17
+ exports.ChangePasswordRequestFromJSON = ChangePasswordRequestFromJSON;
18
+ exports.ChangePasswordRequestFromJSONTyped = ChangePasswordRequestFromJSONTyped;
19
+ exports.ChangePasswordRequestToJSON = ChangePasswordRequestToJSON;
20
+ exports.ChangePasswordRequestToJSONTyped = ChangePasswordRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ChangePasswordRequest interface.
23
+ */
24
+ function instanceOfChangePasswordRequest(value) {
25
+ return true;
26
+ }
27
+ function ChangePasswordRequestFromJSON(json) {
28
+ return ChangePasswordRequestFromJSONTyped(json, false);
29
+ }
30
+ function ChangePasswordRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'oldPassword': json['oldPassword'] == null ? undefined : json['oldPassword'],
36
+ 'newPassword': json['newPassword'] == null ? undefined : json['newPassword'],
37
+ };
38
+ }
39
+ function ChangePasswordRequestToJSON(json) {
40
+ return ChangePasswordRequestToJSONTyped(json, false);
41
+ }
42
+ function ChangePasswordRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'oldPassword': value['oldPassword'],
48
+ 'newPassword': value['newPassword'],
49
+ };
50
+ }
@@ -0,0 +1,34 @@
1
+ /**
2
+ * SnowballR API
3
+ * REST API for the SnowballR Application
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface LoginRequest
16
+ */
17
+ export interface LoginRequest {
18
+ /**
19
+ *
20
+ */
21
+ email?: string;
22
+ /**
23
+ *
24
+ */
25
+ password?: string;
26
+ }
27
+ /**
28
+ * Check if a given object implements the LoginRequest interface.
29
+ */
30
+ export declare function instanceOfLoginRequest(value: object): value is LoginRequest;
31
+ export declare function LoginRequestFromJSON(json: any): LoginRequest;
32
+ export declare function LoginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): LoginRequest;
33
+ export declare function LoginRequestToJSON(json: any): LoginRequest;
34
+ export declare function LoginRequestToJSONTyped(value?: LoginRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * SnowballR API
6
+ * REST API for the SnowballR Application
7
+ *
8
+ * The version of the OpenAPI document: v1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfLoginRequest = instanceOfLoginRequest;
17
+ exports.LoginRequestFromJSON = LoginRequestFromJSON;
18
+ exports.LoginRequestFromJSONTyped = LoginRequestFromJSONTyped;
19
+ exports.LoginRequestToJSON = LoginRequestToJSON;
20
+ exports.LoginRequestToJSONTyped = LoginRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the LoginRequest interface.
23
+ */
24
+ function instanceOfLoginRequest(value) {
25
+ return true;
26
+ }
27
+ function LoginRequestFromJSON(json) {
28
+ return LoginRequestFromJSONTyped(json, false);
29
+ }
30
+ function LoginRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'email': json['email'] == null ? undefined : json['email'],
36
+ 'password': json['password'] == null ? undefined : json['password'],
37
+ };
38
+ }
39
+ function LoginRequestToJSON(json) {
40
+ return LoginRequestToJSONTyped(json, false);
41
+ }
42
+ function LoginRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'email': value['email'],
48
+ 'password': value['password'],
49
+ };
50
+ }
@@ -13,9 +13,9 @@ import type { ProjectSettings } from './ProjectSettings';
13
13
  /**
14
14
  *
15
15
  * @export
16
- * @interface Project
16
+ * @interface ProjectResponse
17
17
  */
18
- export interface Project {
18
+ export interface ProjectResponse {
19
19
  /**
20
20
  *
21
21
  */
@@ -27,7 +27,7 @@ export interface Project {
27
27
  /**
28
28
  *
29
29
  */
30
- status?: ProjectStatusEnum;
30
+ status?: ProjectResponseStatusEnum;
31
31
  /**
32
32
  *
33
33
  */
@@ -39,28 +39,28 @@ export interface Project {
39
39
  /**
40
40
  *
41
41
  */
42
- currentStageStartedAt?: Date;
42
+ settings?: ProjectSettings;
43
43
  /**
44
44
  *
45
45
  */
46
- settings?: ProjectSettings;
46
+ currentStageStartedAt?: Date;
47
47
  }
48
48
  /**
49
49
  * @export
50
50
  */
51
- export declare const ProjectStatusEnum: {
51
+ export declare const ProjectResponseStatusEnum: {
52
52
  readonly ACTIVE: "ACTIVE";
53
53
  readonly ACTIVE_LOCKED: "ACTIVE_LOCKED";
54
54
  readonly ARCHIVED: "ARCHIVED";
55
55
  readonly DELETED: "DELETED";
56
56
  readonly CLEARED: "CLEARED";
57
57
  };
58
- export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
58
+ export type ProjectResponseStatusEnum = typeof ProjectResponseStatusEnum[keyof typeof ProjectResponseStatusEnum];
59
59
  /**
60
- * Check if a given object implements the Project interface.
60
+ * Check if a given object implements the ProjectResponse interface.
61
61
  */
62
- export declare function instanceOfProject(value: object): value is Project;
63
- export declare function ProjectFromJSON(json: any): Project;
64
- export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
65
- export declare function ProjectToJSON(json: any): Project;
66
- export declare function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator?: boolean): any;
62
+ export declare function instanceOfProjectResponse(value: object): value is ProjectResponse;
63
+ export declare function ProjectResponseFromJSON(json: any): ProjectResponse;
64
+ export declare function ProjectResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectResponse;
65
+ export declare function ProjectResponseToJSON(json: any): ProjectResponse;
66
+ export declare function ProjectResponseToJSONTyped(value?: ProjectResponse | null, ignoreDiscriminator?: boolean): any;
@@ -13,18 +13,18 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ProjectStatusEnum = void 0;
17
- exports.instanceOfProject = instanceOfProject;
18
- exports.ProjectFromJSON = ProjectFromJSON;
19
- exports.ProjectFromJSONTyped = ProjectFromJSONTyped;
20
- exports.ProjectToJSON = ProjectToJSON;
21
- exports.ProjectToJSONTyped = ProjectToJSONTyped;
16
+ exports.ProjectResponseStatusEnum = void 0;
17
+ exports.instanceOfProjectResponse = instanceOfProjectResponse;
18
+ exports.ProjectResponseFromJSON = ProjectResponseFromJSON;
19
+ exports.ProjectResponseFromJSONTyped = ProjectResponseFromJSONTyped;
20
+ exports.ProjectResponseToJSON = ProjectResponseToJSON;
21
+ exports.ProjectResponseToJSONTyped = ProjectResponseToJSONTyped;
22
22
  const runtime_1 = require("../runtime");
23
23
  const ProjectSettings_1 = require("./ProjectSettings");
24
24
  /**
25
25
  * @export
26
26
  */
27
- exports.ProjectStatusEnum = {
27
+ exports.ProjectResponseStatusEnum = {
28
28
  ACTIVE: 'ACTIVE',
29
29
  ACTIVE_LOCKED: 'ACTIVE_LOCKED',
30
30
  ARCHIVED: 'ARCHIVED',
@@ -32,15 +32,15 @@ exports.ProjectStatusEnum = {
32
32
  CLEARED: 'CLEARED',
33
33
  };
34
34
  /**
35
- * Check if a given object implements the Project interface.
35
+ * Check if a given object implements the ProjectResponse interface.
36
36
  */
37
- function instanceOfProject(value) {
37
+ function instanceOfProjectResponse(value) {
38
38
  return true;
39
39
  }
40
- function ProjectFromJSON(json) {
41
- return ProjectFromJSONTyped(json, false);
40
+ function ProjectResponseFromJSON(json) {
41
+ return ProjectResponseFromJSONTyped(json, false);
42
42
  }
43
- function ProjectFromJSONTyped(json, ignoreDiscriminator) {
43
+ function ProjectResponseFromJSONTyped(json, ignoreDiscriminator) {
44
44
  if (json == null) {
45
45
  return json;
46
46
  }
@@ -50,14 +50,14 @@ function ProjectFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'status': json['status'] == null ? undefined : json['status'],
51
51
  'currentStage': json['currentStage'] == null ? undefined : json['currentStage'],
52
52
  'maxStage': json['maxStage'] == null ? undefined : json['maxStage'],
53
- 'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : ((0, runtime_1.parseDateTime)(json['currentStageStartedAt'])),
54
53
  'settings': json['settings'] == null ? undefined : (0, ProjectSettings_1.ProjectSettingsFromJSON)(json['settings']),
54
+ 'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : ((0, runtime_1.parseDateTime)(json['currentStageStartedAt'])),
55
55
  };
56
56
  }
57
- function ProjectToJSON(json) {
58
- return ProjectToJSONTyped(json, false);
57
+ function ProjectResponseToJSON(json) {
58
+ return ProjectResponseToJSONTyped(json, false);
59
59
  }
60
- function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
60
+ function ProjectResponseToJSONTyped(value, ignoreDiscriminator = false) {
61
61
  if (value == null) {
62
62
  return value;
63
63
  }
@@ -67,7 +67,7 @@ function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
67
67
  'status': value['status'],
68
68
  'currentStage': value['currentStage'],
69
69
  'maxStage': value['maxStage'],
70
- 'currentStageStartedAt': value['currentStageStartedAt'] == null ? value['currentStageStartedAt'] : (0, runtime_1.serializeDateTime)(value['currentStageStartedAt']),
71
70
  'settings': (0, ProjectSettings_1.ProjectSettingsToJSON)(value['settings']),
71
+ 'currentStageStartedAt': value['currentStageStartedAt'] == null ? value['currentStageStartedAt'] : (0, runtime_1.serializeDateTime)(value['currentStageStartedAt']),
72
72
  };
73
73
  }
@@ -0,0 +1,42 @@
1
+ /**
2
+ * SnowballR API
3
+ * REST API for the SnowballR Application
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RegisterRequest
16
+ */
17
+ export interface RegisterRequest {
18
+ /**
19
+ *
20
+ */
21
+ firstName?: string;
22
+ /**
23
+ *
24
+ */
25
+ lastName?: string;
26
+ /**
27
+ *
28
+ */
29
+ email?: string;
30
+ /**
31
+ *
32
+ */
33
+ password?: string;
34
+ }
35
+ /**
36
+ * Check if a given object implements the RegisterRequest interface.
37
+ */
38
+ export declare function instanceOfRegisterRequest(value: object): value is RegisterRequest;
39
+ export declare function RegisterRequestFromJSON(json: any): RegisterRequest;
40
+ export declare function RegisterRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterRequest;
41
+ export declare function RegisterRequestToJSON(json: any): RegisterRequest;
42
+ export declare function RegisterRequestToJSONTyped(value?: RegisterRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * SnowballR API
6
+ * REST API for the SnowballR Application
7
+ *
8
+ * The version of the OpenAPI document: v1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfRegisterRequest = instanceOfRegisterRequest;
17
+ exports.RegisterRequestFromJSON = RegisterRequestFromJSON;
18
+ exports.RegisterRequestFromJSONTyped = RegisterRequestFromJSONTyped;
19
+ exports.RegisterRequestToJSON = RegisterRequestToJSON;
20
+ exports.RegisterRequestToJSONTyped = RegisterRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the RegisterRequest interface.
23
+ */
24
+ function instanceOfRegisterRequest(value) {
25
+ return true;
26
+ }
27
+ function RegisterRequestFromJSON(json) {
28
+ return RegisterRequestFromJSONTyped(json, false);
29
+ }
30
+ function RegisterRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'firstName': json['firstName'] == null ? undefined : json['firstName'],
36
+ 'lastName': json['lastName'] == null ? undefined : json['lastName'],
37
+ 'email': json['email'] == null ? undefined : json['email'],
38
+ 'password': json['password'] == null ? undefined : json['password'],
39
+ };
40
+ }
41
+ function RegisterRequestToJSON(json) {
42
+ return RegisterRequestToJSONTyped(json, false);
43
+ }
44
+ function RegisterRequestToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'firstName': value['firstName'],
50
+ 'lastName': value['lastName'],
51
+ 'email': value['email'],
52
+ 'password': value['password'],
53
+ };
54
+ }
@@ -1,6 +1,9 @@
1
+ export * from './ChangePasswordRequest';
1
2
  export * from './CreateProjectRequest';
2
3
  export * from './DecisionMatrixPattern';
3
4
  export * from './DecisionMatrixPatternEntry';
4
- export * from './Project';
5
+ export * from './LoginRequest';
6
+ export * from './ProjectResponse';
5
7
  export * from './ProjectSettings';
8
+ export * from './RegisterRequest';
6
9
  export * from './ReviewDecisionMatrix';
@@ -16,9 +16,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./ChangePasswordRequest"), exports);
19
20
  __exportStar(require("./CreateProjectRequest"), exports);
20
21
  __exportStar(require("./DecisionMatrixPattern"), exports);
21
22
  __exportStar(require("./DecisionMatrixPatternEntry"), exports);
22
- __exportStar(require("./Project"), exports);
23
+ __exportStar(require("./LoginRequest"), exports);
24
+ __exportStar(require("./ProjectResponse"), exports);
23
25
  __exportStar(require("./ProjectSettings"), exports);
26
+ __exportStar(require("./RegisterRequest"), exports);
24
27
  __exportStar(require("./ReviewDecisionMatrix"), exports);
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@se-uulm/snowballr-api-client",
3
- "version": "0.2.1-alpha.e0abdd5",
4
- "description": "OpenAPI client for @se-uulm/snowballr-api-client",
5
- "author": "OpenAPI-Generator",
3
+ "version": "0.2.1-alpha.e8b05f4",
4
+ "description": "API client for the SnowballR Web Application",
5
+ "author": "SnowballR",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/SE-UUlm/snowballr-backend.git"
@@ -18,5 +18,11 @@
18
18
  },
19
19
  "devDependencies": {
20
20
  "typescript": "^4.0 || ^5.0"
21
- }
21
+ },
22
+ "files": [
23
+ "dist",
24
+ "README.md",
25
+ "LICENSE",
26
+ "CHANGELOG.md"
27
+ ]
22
28
  }
@@ -1,25 +0,0 @@
1
- .gitignore
2
- .npmignore
3
- .openapi-generator-ignore
4
- README.md
5
- docs/CreateProjectRequest.md
6
- docs/DecisionMatrixPattern.md
7
- docs/DecisionMatrixPatternEntry.md
8
- docs/Project.md
9
- docs/ProjectSettings.md
10
- docs/ProjectsControllerApi.md
11
- docs/ReviewDecisionMatrix.md
12
- package.json
13
- src/apis/ProjectsControllerApi.ts
14
- src/apis/index.ts
15
- src/index.ts
16
- src/models/CreateProjectRequest.ts
17
- src/models/DecisionMatrixPattern.ts
18
- src/models/DecisionMatrixPatternEntry.ts
19
- src/models/Project.ts
20
- src/models/ProjectSettings.ts
21
- src/models/ReviewDecisionMatrix.ts
22
- src/models/index.ts
23
- src/runtime.ts
24
- tsconfig.esm.json
25
- tsconfig.json
@@ -1 +0,0 @@
1
- 7.26.0
@@ -1,23 +0,0 @@
1
- # OpenAPI Generator Ignore
2
- # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
-
4
- # Use this file to prevent files from being overwritten by the generator.
5
- # The patterns follow closely to .gitignore or .dockerignore.
6
-
7
- # As an example, the C# client generator defines ApiClient.cs.
8
- # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
- #ApiClient.cs
10
-
11
- # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
- #foo/*/qux
13
- # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
-
15
- # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
- #foo/**/qux
17
- # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
-
19
- # You can also negate patterns with an exclamation (!).
20
- # For example, you can ignore all files in a docs folder with the file extension .md:
21
- #docs/*.md
22
- # Then explicitly reverse the ignore rule for a single file:
23
- #!docs/README.md
@@ -1,34 +0,0 @@
1
-
2
- # CreateProjectRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `name` | string
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CreateProjectRequest } from '@se-uulm/snowballr-api-client'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "name": null,
19
- } satisfies CreateProjectRequest
20
-
21
- console.log(example)
22
-
23
- // Convert the instance to a JSON string
24
- const exampleJSON: string = JSON.stringify(example)
25
- console.log(exampleJSON)
26
-
27
- // Parse the JSON string back to an object
28
- const exampleParsed = JSON.parse(exampleJSON) as CreateProjectRequest
29
- console.log(exampleParsed)
30
- ```
31
-
32
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
-
34
-
@@ -1,36 +0,0 @@
1
-
2
- # DecisionMatrixPattern
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `decision` | string
10
- `entries` | [Array<DecisionMatrixPatternEntry>](DecisionMatrixPatternEntry.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { DecisionMatrixPattern } from '@se-uulm/snowballr-api-client'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "decision": null,
20
- "entries": null,
21
- } satisfies DecisionMatrixPattern
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as DecisionMatrixPattern
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
@@ -1,36 +0,0 @@
1
-
2
- # DecisionMatrixPatternEntry
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `decision` | string
10
- `count` | number
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { DecisionMatrixPatternEntry } from '@se-uulm/snowballr-api-client'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "decision": null,
20
- "count": null,
21
- } satisfies DecisionMatrixPatternEntry
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as DecisionMatrixPatternEntry
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
package/docs/Project.md DELETED
@@ -1,46 +0,0 @@
1
-
2
- # Project
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | string
10
- `name` | string
11
- `status` | string
12
- `currentStage` | number
13
- `maxStage` | number
14
- `currentStageStartedAt` | Date
15
- `settings` | [ProjectSettings](ProjectSettings.md)
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import type { Project } from '@se-uulm/snowballr-api-client'
21
-
22
- // TODO: Update the object below with actual values
23
- const example = {
24
- "id": null,
25
- "name": null,
26
- "status": null,
27
- "currentStage": null,
28
- "maxStage": null,
29
- "currentStageStartedAt": null,
30
- "settings": null,
31
- } satisfies Project
32
-
33
- console.log(example)
34
-
35
- // Convert the instance to a JSON string
36
- const exampleJSON: string = JSON.stringify(example)
37
- console.log(exampleJSON)
38
-
39
- // Parse the JSON string back to an object
40
- const exampleParsed = JSON.parse(exampleJSON) as Project
41
- console.log(exampleParsed)
42
- ```
43
-
44
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
-
46
-
@@ -1,42 +0,0 @@
1
-
2
- # ProjectSettings
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `similarityThreshold` | number
10
- `snowballingType` | string
11
- `reviewMaybeAllowed` | boolean
12
- `reviewDecisionMatrix` | [ReviewDecisionMatrix](ReviewDecisionMatrix.md)
13
- `fetchers` | { [key: string]: { [key: string]: string; }; }
14
-
15
- ## Example
16
-
17
- ```typescript
18
- import type { ProjectSettings } from '@se-uulm/snowballr-api-client'
19
-
20
- // TODO: Update the object below with actual values
21
- const example = {
22
- "similarityThreshold": null,
23
- "snowballingType": null,
24
- "reviewMaybeAllowed": null,
25
- "reviewDecisionMatrix": null,
26
- "fetchers": null,
27
- } satisfies ProjectSettings
28
-
29
- console.log(example)
30
-
31
- // Convert the instance to a JSON string
32
- const exampleJSON: string = JSON.stringify(example)
33
- console.log(exampleJSON)
34
-
35
- // Parse the JSON string back to an object
36
- const exampleParsed = JSON.parse(exampleJSON) as ProjectSettings
37
- console.log(exampleParsed)
38
- ```
39
-
40
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
-
42
-