Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit 9dec0c7

Browse files
callmekatootiecallmekatootie
authored
Merge pull request #9 from topcoder-platform/Issue_8
Sync wrapper with changes to api
2 parents c794297 + 6b04fef commit 9dec0c7

15 files changed

+280
-24
lines changed

‎docs/ArtifactData.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,4 @@ It is a form data
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**typeId** | **String** | The type id. |
109
**artifact** | **File** | The artifact file to be uploaded. | The object should have properties name(indicate the file name) and data(a Buffer represents the file content)

‎docs/Criteria.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**page** | **Integer** | The page number. | Default value is 1
88
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
9+
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review type.
10+
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
911
**name** | **String** | The name filter for review types. |
1012
**isActive** | **Boolean** | The active boolean flag filter for review types. |

‎docs/Review.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **String** | The review id. |
88
**score** | **Number** | The review score. |
9+
**legacyReviewId** | **Number** | The review id in the legacy system. |
910
**typeId** | **String** | The review type id. |
1011
**reviewerId** | **Integer or String** | The reviewer id. |
1112
**scoreCardId** | **Integer or String** | The review's scorecard id. |
1213
**submissionId** | **String** | The submission id. |
13-
**metadata** | **Object** | The review's metadata. |
14+
**status** | **String** | The review's status. Can be one of `queued` and `completed`. |
15+
**metadata** | [**ReviewMetadata**](ReviewMetadata.md) | The review's metadata. |
1416
**created** | **String** | The ISO date string of created date. |
1517
**updated** | **String** | The ISO date string of updated date. |
1618
**createdBy** | **String** | The created by user. |

‎docs/ReviewData.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**score** | **Number** | The review score. |
8+
**legacyReviewId** | **Number** | The review id in the legacy system. |
89
**typeId** | **String** | The review type id. |
910
**reviewerId** | **Integer or String** | The reviewer id. |
1011
**scoreCardId** | **Integer or String** | The review's scorecard id. |
1112
**submissionId** | **String** | The submission id. |
12-
**metadata** | **Object** | The review's metadata. |
13+
**status** | **String** | The review's status. Can be one of `queued` and `completed`. |
14+
**metadata** | [**ReviewMetadata**](ReviewMetadata.md) | The review's metadata. |

‎docs/ReviewMetadata.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Review Metadata
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**testType** | **String** | The review metadata type. |
8+
**public** | **Object** | The review metadata info that is available to user roles along with admin and copilot. |
9+
**private** | **Object** | The review metadata info that is only available to admin and copilot roles. |

‎docs/ReviewsApi.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,17 @@ const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION
177177

178178
const reqBody = {
179179
score: 89,
180+
legacyReviewId: 1234567879,
180181
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
181182
submissionId: 'e328821a-6829-4214-b0d4-d7f7bf44dc98',
182183
scoreCardId: 30001850,
183184
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
184-
metadata: { abc: 'def' }
185+
status: 'queued',
186+
metadata: {
187+
testType: 'provisional',
188+
public: { abc: 123 },
189+
private: { xyz: 789 }
190+
}
185191
}
186192

187193
// Promise model
@@ -383,11 +389,17 @@ const submissionApiJwtMethodArg = submissionApi(_.pick(config, 'SUBMISSION_API_U
383389
const reviewId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
384390
const reqBody = {
385391
score: 100,
392+
legacyReviewId: 123456789,
386393
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
387394
submissionId: 'e328821a-6829-4214-b0d4-d7f7bf44dc98',
388395
scoreCardId: 30001850,
389396
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
390-
metadata: { abc: 'xyz' }
397+
status: 'completed',
398+
metadata: {
399+
testType: 'provisional',
400+
public: { abc: 123 },
401+
private: { xyz: 789 }
402+
}
391403
}
392404

393405
// Promise model
@@ -460,7 +472,11 @@ const reqBody = {
460472
score: 99,
461473
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
462474
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
463-
metadata: { abc: 'def' }
475+
metadata: {
476+
testType: 'provisional',
477+
public: { abc: 123 },
478+
private: { xyz: 789 }
479+
}
464480
}
465481

466482
// Promise model

‎docs/SearchReviewSummationsCriteria.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**page** | **Integer** | The page number. | Default value is 1
88
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
9+
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review summation.
10+
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
911
**submissionId** | **String** | The submission id filter for review summations. |
1012
**aggregateScore** | **Number** | Theaggregate score filter for review summations. |Double
1113
**scoreCardId** | **Number or String** | The score card id filter for review summations. |GUID string in swagger but integer in implementation

‎docs/SearchReviewsCriteria.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**page** | **Integer** | The page number. | Default value is 1
88
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
9+
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review.
10+
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
911
**score** | **Number** | The score filter for reviews. |
12+
**legacyReviewId** | **Number** | The filter for review id in the legacy system. |
1013
**typeId** | **String** | The review type id filter for reviews. |
1114
**reviewerId** | **Integer or String** | The reviewer id filter for reviews. |
1215
**scoreCardId** | **Integer or String** | The scorecard id filter for reviews. |
1316
**submissionId** | **String** | The submission id filter for reviews. |
17+
**status** | **String** | The review status filter. Can be one of `queued` and `completed`. |

‎docs/SearchSubmissionsCriteria.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**page** | **Integer** | The page number. | Default value is 1
88
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
9+
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of submission.
10+
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
911
**type** | **String** | The type filter for submissions. |
1012
**url** | **String** | The url filter for submissions. |
1113
**memberId** | **Integer or String** | The member id filter for submissions. |
@@ -14,10 +16,12 @@ Name | Type | Description | Notes
1416
**legacyUploadId** | **Integer or String** | The legacy upload id filter for submissions. |
1517
**submissionPhaseId** | **Integer or String** | The submission phase id filter for submissions. |
1618
**review.score** | **Number** | The review score filter for submissions. | Double
19+
**review.legacyReviewId** | **Number** | The review legacy review id filter for submissions. |
1720
**review.typeId** | **String** | The review type id filter for submissions. |
1821
**review.reviewerId** | **String** | The reviewer id filter for submissions. |
1922
**review.scoreCardId** | **String** | The review score card id filter for submissions. |
2023
**review.submissionId** | **String** | The review submission id filter for submissions. |
24+
**review.status** | **String** | The review status filter for submissions. |
2125
**reviewSummation.scoreCardId** | **String** | The review summation score card id filter for submissions. |
2226
**reviewSummation.submissionId** | **String** | The review summation submission id filter for submissions. |
2327
**reviewSummation.aggregateScore** | **Number** | The review summation aggregate score filter for submissions. | Double

0 commit comments

Comments
 (0)