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

Sync wrapper with changes to api #9

Merged
merged 1 commit into from
Sep 25, 2019
Merged

Sync wrapper with changes to api #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/ArtifactData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ It is a form data

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**typeId** | **String** | The type id. |
**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)
2 changes: 2 additions & 0 deletions docs/Criteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **Integer** | The page number. | Default value is 1
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review type.
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
**name** | **String** | The name filter for review types. |
**isActive** | **Boolean** | The active boolean flag filter for review types. |
4 changes: 3 additions & 1 deletion docs/Review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | The review id. |
**score** | **Number** | The review score. |
**legacyReviewId** | **Number** | The review id in the legacy system. |
**typeId** | **String** | The review type id. |
**reviewerId** | **Integer or String** | The reviewer id. |
**scoreCardId** | **Integer or String** | The review's scorecard id. |
**submissionId** | **String** | The submission id. |
**metadata** | **Object** | The review's metadata. |
**status** | **String** | The review's status. Can be one of `queued` and `completed`. |
**metadata** | [**ReviewMetadata**](ReviewMetadata.md) | The review's metadata. |
**created** | **String** | The ISO date string of created date. |
**updated** | **String** | The ISO date string of updated date. |
**createdBy** | **String** | The created by user. |
Expand Down
4 changes: 3 additions & 1 deletion docs/ReviewData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**score** | **Number** | The review score. |
**legacyReviewId** | **Number** | The review id in the legacy system. |
**typeId** | **String** | The review type id. |
**reviewerId** | **Integer or String** | The reviewer id. |
**scoreCardId** | **Integer or String** | The review's scorecard id. |
**submissionId** | **String** | The submission id. |
**metadata** | **Object** | The review's metadata. |
**status** | **String** | The review's status. Can be one of `queued` and `completed`. |
**metadata** | [**ReviewMetadata**](ReviewMetadata.md) | The review's metadata. |
9 changes: 9 additions & 0 deletions docs/ReviewMetadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Review Metadata

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**testType** | **String** | The review metadata type. |
**public** | **Object** | The review metadata info that is available to user roles along with admin and copilot. |
**private** | **Object** | The review metadata info that is only available to admin and copilot roles. |
22 changes: 19 additions & 3 deletions docs/ReviewsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,17 @@ const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION

const reqBody = {
score: 89,
legacyReviewId: 1234567879,
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
submissionId: 'e328821a-6829-4214-b0d4-d7f7bf44dc98',
scoreCardId: 30001850,
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
metadata: { abc: 'def' }
status: 'queued',
metadata: {
testType: 'provisional',
public: { abc: 123 },
private: { xyz: 789 }
}
}

// Promise model
Expand Down Expand Up @@ -383,11 +389,17 @@ const submissionApiJwtMethodArg = submissionApi(_.pick(config, 'SUBMISSION_API_U
const reviewId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
const reqBody = {
score: 100,
legacyReviewId: 123456789,
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
submissionId: 'e328821a-6829-4214-b0d4-d7f7bf44dc98',
scoreCardId: 30001850,
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
metadata: { abc: 'xyz' }
status: 'completed',
metadata: {
testType: 'provisional',
public: { abc: 123 },
private: { xyz: 789 }
}
}

// Promise model
Expand Down Expand Up @@ -460,7 +472,11 @@ const reqBody = {
score: 99,
reviewerId: 'a3d891ef-4002-48fc-ae35-e8623e6bd4b9',
typeId: '68c5a381-c8ab-48af-92a7-7a869a4ee6c3',
metadata: { abc: 'def' }
metadata: {
testType: 'provisional',
public: { abc: 123 },
private: { xyz: 789 }
}
}

// Promise model
Expand Down
2 changes: 2 additions & 0 deletions docs/SearchReviewSummationsCriteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **Integer** | The page number. | Default value is 1
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review summation.
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
**submissionId** | **String** | The submission id filter for review summations. |
**aggregateScore** | **Number** | Theaggregate score filter for review summations. |Double
**scoreCardId** | **Number or String** | The score card id filter for review summations. |GUID string in swagger but integer in implementation
Expand Down
4 changes: 4 additions & 0 deletions docs/SearchReviewsCriteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **Integer** | The page number. | Default value is 1
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of review.
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
**score** | **Number** | The score filter for reviews. |
**legacyReviewId** | **Number** | The filter for review id in the legacy system. |
**typeId** | **String** | The review type id filter for reviews. |
**reviewerId** | **Integer or String** | The reviewer id filter for reviews. |
**scoreCardId** | **Integer or String** | The scorecard id filter for reviews. |
**submissionId** | **String** | The submission id filter for reviews. |
**status** | **String** | The review status filter. Can be one of `queued` and `completed`. |
4 changes: 4 additions & 0 deletions docs/SearchSubmissionsCriteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **Integer** | The page number. | Default value is 1
**perPage** | **Integer** | The number of items to list per page. | Default value is 20
**sortBy** | **String** | The property by which to sort the result list. | Should be one of the properties of submission.
**orderBy** | **String** | The order by which to sort. | One of [`asc`, `desc`, `ASC`, `DESC`]
**type** | **String** | The type filter for submissions. |
**url** | **String** | The url filter for submissions. |
**memberId** | **Integer or String** | The member id filter for submissions. |
Expand All @@ -14,10 +16,12 @@ Name | Type | Description | Notes
**legacyUploadId** | **Integer or String** | The legacy upload id filter for submissions. |
**submissionPhaseId** | **Integer or String** | The submission phase id filter for submissions. |
**review.score** | **Number** | The review score filter for submissions. | Double
**review.legacyReviewId** | **Number** | The review legacy review id filter for submissions. |
**review.typeId** | **String** | The review type id filter for submissions. |
**review.reviewerId** | **String** | The reviewer id filter for submissions. |
**review.scoreCardId** | **String** | The review score card id filter for submissions. |
**review.submissionId** | **String** | The review submission id filter for submissions. |
**review.status** | **String** | The review status filter for submissions. |
**reviewSummation.scoreCardId** | **String** | The review summation score card id filter for submissions. |
**reviewSummation.submissionId** | **String** | The review summation submission id filter for submissions. |
**reviewSummation.aggregateScore** | **Number** | The review summation aggregate score filter for submissions. | Double
Expand Down
Loading