Skip to content

Fix issues found during submission api wrapper contest #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
callmekatootie opened this issue Jun 3, 2019 · 6 comments
Closed

Fix issues found during submission api wrapper contest #113

callmekatootie opened this issue Jun 3, 2019 · 6 comments

Comments

@callmekatootie
Copy link
Contributor

Two issues reported during submission api wrapper contest:

  • Missing definitions:
# request headers
    - $ref: '#/parameters/IfNoneMatchParamHeader'
    - $ref: '#/parameters/IfModifiedSinceParamHeader'
  • For review type creation, id field is marked as a required input in swagger, when in fact, it is auto generated.
@callmekatootie
Copy link
Contributor Author

callmekatootie commented Jun 4, 2019

Issues reported during wrapper contest (Reviews)

  • POST /reviews returns 200 as status code. Swagger says 201. Swagger needs correction.
  • For reviews resource, swagger specification says that scorecardId can be an integer or string. Code also says so, but since we did not specify the schema when interfacing with ES, ES has taken the schema to be that of an integer. Update the code and the swagger specification to indicate that scorecardId needs to be an integer
  • ReviewerId needs to be either number or string. However, when a non number and non string value is passed (for example a boolean value), the error received is that reviewerId should be a number. It should be reviewerId should be either a number or a string instead

@callmekatootie
Copy link
Contributor Author

Review Summations:

  • isFinal field exists in code but not in swagger

@callmekatootie
Copy link
Contributor Author

callmekatootie commented Jun 20, 2019

Submission:

  • PUT /submissions/{submissionId} says type field is required. Code does not. Update swagger
  • GET /submissions does not talk about filter query parameters related to review (such as review.score and review.typeId). Code supports it
  • GET /submission does not document that the response might contain legacySubmissionId, legacyUploadId and submissionPhaseId

cwdcwd added a commit that referenced this issue Jun 24, 2019
#113 - Remove invalid references and wrong required field
@callmekatootie
Copy link
Contributor Author

Contest Launched for remaining fixes: http://www.topcoder.com/challenge-details/30098900/?type=develop

callmekatootie added a commit that referenced this issue Aug 18, 2019
2. Provide sortyBy parameter when querying #124
3. Change which attribute is used to name artifacts in submissions #125
@callmekatootie
Copy link
Contributor Author

PR ready: #127

@callmekatootie
Copy link
Contributor Author

PR merged. Closing ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant