@devopness/sdk-js 2.112.0 → 2.113.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/README.md +4 -4
- package/dist/api/generated/models/action-deployment-commit.d.ts +9 -27
- package/dist/api/generated/models/action-deployment-content.d.ts +19 -13
- package/dist/api/generated/models/index.d.ts +1 -0
- package/dist/api/generated/models/index.js +1 -0
- package/dist/api/generated/models/repository-tag-commit.d.ts +30 -0
- package/dist/api/generated/models/repository-tag-commit.js +14 -0
- package/dist/api/generated/models/repository-tag.d.ts +7 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,8 +62,8 @@ async function getUserProfile() {
|
|
|
62
62
|
await authenticate('user@email.com', 'secret-password');
|
|
63
63
|
|
|
64
64
|
// Now that we're authenticated, we can invoke methods on any services.
|
|
65
|
-
// Here we're invoking the `
|
|
66
|
-
const currentUser = await devopnessApi.users.
|
|
65
|
+
// Here we're invoking the `getUserMe()` method on the `users` service
|
|
66
|
+
const currentUser = await devopnessApi.users.getUserMe();
|
|
67
67
|
console.log('Successfully retrieved user profile: ', currentUser);
|
|
68
68
|
}
|
|
69
69
|
|
|
@@ -74,7 +74,7 @@ getUserProfile();
|
|
|
74
74
|
This package includes TypeScript declarations for every method.
|
|
75
75
|
TypeScript versions `>= 4.4` are supported.
|
|
76
76
|
|
|
77
|
-
>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'
|
|
77
|
+
>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you're using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
|
|
78
78
|
|
|
79
79
|
## Development & Testing
|
|
80
80
|
To build and test the SDK locally, [**fork this repository**](https://github.com/devopness/devopness/fork) and follow these steps:
|
|
@@ -123,7 +123,7 @@ cd packages/sdks/javascript/
|
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
#### 2. Install missing dependencies
|
|
126
|
-
This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
|
|
126
|
+
This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
|
|
127
127
|
for your operating system.
|
|
128
128
|
```
|
|
129
129
|
npm install
|
|
@@ -16,29 +16,29 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface ActionDeploymentCommit {
|
|
18
18
|
/**
|
|
19
|
-
* The
|
|
20
|
-
* @type {
|
|
19
|
+
* The repository of the deployed application
|
|
20
|
+
* @type {string}
|
|
21
21
|
* @memberof ActionDeploymentCommit
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
repository: string;
|
|
24
24
|
/**
|
|
25
|
-
* The
|
|
25
|
+
* The author of the commit
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof ActionDeploymentCommit
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
author_name: string;
|
|
30
30
|
/**
|
|
31
|
-
* The
|
|
31
|
+
* The commit author\'s email
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ActionDeploymentCommit
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
author_email: string;
|
|
36
36
|
/**
|
|
37
|
-
* The
|
|
37
|
+
* The date and time when the commit was created
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof ActionDeploymentCommit
|
|
40
40
|
*/
|
|
41
|
-
|
|
41
|
+
committed_at: string;
|
|
42
42
|
/**
|
|
43
43
|
* The commit hash used on deployment
|
|
44
44
|
* @type {string}
|
|
@@ -51,24 +51,6 @@ export interface ActionDeploymentCommit {
|
|
|
51
51
|
* @memberof ActionDeploymentCommit
|
|
52
52
|
*/
|
|
53
53
|
message: string;
|
|
54
|
-
/**
|
|
55
|
-
* The author of the commit
|
|
56
|
-
* @type {string}
|
|
57
|
-
* @memberof ActionDeploymentCommit
|
|
58
|
-
*/
|
|
59
|
-
author_name: string;
|
|
60
|
-
/**
|
|
61
|
-
* The commit author\'s email
|
|
62
|
-
* @type {string}
|
|
63
|
-
* @memberof ActionDeploymentCommit
|
|
64
|
-
*/
|
|
65
|
-
author_email: string;
|
|
66
|
-
/**
|
|
67
|
-
* The date and time when the commit was created
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof ActionDeploymentCommit
|
|
70
|
-
*/
|
|
71
|
-
committed_at: string;
|
|
72
54
|
/**
|
|
73
55
|
* The commit URL on the source provider
|
|
74
56
|
* @type {string}
|
|
@@ -17,23 +17,23 @@ import { DeploymentType } from './deployment-type';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface ActionDeploymentContent {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {
|
|
20
|
+
*
|
|
21
|
+
* @type {DeploymentType}
|
|
22
22
|
* @memberof ActionDeploymentContent
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
type: DeploymentType;
|
|
25
25
|
/**
|
|
26
|
-
* The source
|
|
26
|
+
* The \'source type\' from which the application source code will be retrieved and deployed. It can be one of `branch`, `tag` or `commit`. If not provided, the application\'s default branch will be used.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof ActionDeploymentContent
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
source_type: string;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {
|
|
32
|
+
* A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash.
|
|
33
|
+
* @type {string}
|
|
34
34
|
* @memberof ActionDeploymentContent
|
|
35
35
|
*/
|
|
36
|
-
|
|
36
|
+
source_ref: string;
|
|
37
37
|
/**
|
|
38
38
|
* The repository of the deployed application
|
|
39
39
|
* @type {string}
|
|
@@ -41,15 +41,21 @@ export interface ActionDeploymentContent {
|
|
|
41
41
|
*/
|
|
42
42
|
repository: string;
|
|
43
43
|
/**
|
|
44
|
-
* The
|
|
45
|
-
* @type {
|
|
44
|
+
* The ID of the source provider
|
|
45
|
+
* @type {number}
|
|
46
46
|
* @memberof ActionDeploymentContent
|
|
47
47
|
*/
|
|
48
|
-
|
|
48
|
+
provider_id: number;
|
|
49
49
|
/**
|
|
50
|
-
* The
|
|
50
|
+
* The source provider\'s name
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof ActionDeploymentContent
|
|
53
53
|
*/
|
|
54
|
-
|
|
54
|
+
provider_name: string;
|
|
55
|
+
/**
|
|
56
|
+
* The ID of the pipeline
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof ActionDeploymentContent
|
|
59
|
+
*/
|
|
60
|
+
pipeline_id: number;
|
|
55
61
|
}
|
|
@@ -153,6 +153,7 @@ export * from './repository';
|
|
|
153
153
|
export * from './repository-branch';
|
|
154
154
|
export * from './repository-relation';
|
|
155
155
|
export * from './repository-tag';
|
|
156
|
+
export * from './repository-tag-commit';
|
|
156
157
|
export * from './request-relation';
|
|
157
158
|
export * from './resource-event';
|
|
158
159
|
export * from './resource-event-relation';
|
|
@@ -169,6 +169,7 @@ __exportStar(require("./repository"), exports);
|
|
|
169
169
|
__exportStar(require("./repository-branch"), exports);
|
|
170
170
|
__exportStar(require("./repository-relation"), exports);
|
|
171
171
|
__exportStar(require("./repository-tag"), exports);
|
|
172
|
+
__exportStar(require("./repository-tag-commit"), exports);
|
|
172
173
|
__exportStar(require("./request-relation"), exports);
|
|
173
174
|
__exportStar(require("./resource-event"), exports);
|
|
174
175
|
__exportStar(require("./resource-event-relation"), exports);
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* devopness API
|
|
3
|
+
* Devopness API - Painless essential DevOps to everyone
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
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 RepositoryTagCommit
|
|
16
|
+
*/
|
|
17
|
+
export interface RepositoryTagCommit {
|
|
18
|
+
/**
|
|
19
|
+
* The commit comment\'s full hash that uniquely identify it
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof RepositoryTagCommit
|
|
22
|
+
*/
|
|
23
|
+
hash: string;
|
|
24
|
+
/**
|
|
25
|
+
* The direct URL for accessing commit details on the provider\'s web application
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof RepositoryTagCommit
|
|
28
|
+
*/
|
|
29
|
+
url: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* devopness API
|
|
5
|
+
* Devopness API - Painless essential DevOps to everyone
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { RepositoryTagCommit } from './repository-tag-commit';
|
|
12
13
|
/**
|
|
13
14
|
* A repository tag
|
|
14
15
|
* @export
|
|
@@ -21,4 +22,10 @@ export interface RepositoryTag {
|
|
|
21
22
|
* @memberof RepositoryTag
|
|
22
23
|
*/
|
|
23
24
|
name: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {RepositoryTagCommit}
|
|
28
|
+
* @memberof RepositoryTag
|
|
29
|
+
*/
|
|
30
|
+
commit: RepositoryTagCommit;
|
|
24
31
|
}
|