API | Standardize View Definitions - Githubissues

SynaptitudeBrainHealth / synap-epics

For ZenHub this serves as the default repository containing all issues. This is the "default repository".

1 stars 0 forks source link

API | Standardize View Definitions #37

Closed russellwjoel closed 4 years ago

russellwjoel commented 5 years ago

Endpoints:

URLS

Pluralise Resources to be standard across all urls.

[ ] user -> users
[x] questionnaire -> questionnaires

Response Bodies

- questionnaire questions:

[x] questionnaire -> questionnaireName
[x] section_name -> sectionName
[x] section_title -> sectionTitle
[x] positional_id -> positionalId
[x] section_instructions -> sectionInstructions
[x] section_required -> sectionRequired
[x] dependent_outcome -> dependentOutcome
[x] dependent_section -> dependentSection
[x] reference_name -> questionId
[x] questionId
[x] positionalId
[x] questionText
[x] questionSubtext
[x] question_required -> questionRequired
[x] answer_required -> answerRequired
[x] allow_multiple_answers -> allowMultipleAnswers
[x] dependent_question -> dependentQuestion
[x] dependent_answer_value -> dependentAnswerValue
[x] response_group -> responseGroup
[x] input_type -> inputType
[x] questionnaire_section -> questionnaireSection
[x] response_options -> responseOptions
[x] default_answer -> defaultAnswer

- questionnaire answers:

[x] questionnaire -> questionnaireName
[x] reference_name -> questionId

error body.

[x] message -> error

Method views:

QuestionnaireView Flatten the main post body. Add class methods to raise errors.

Base View:

Subsume the constructor into the base view.

russellwjoel commented 5 years ago

[ ] Change Input Type return to be a KEY formatted: KEY_STRING

russellwjoel commented 5 years ago

Decide on a success response:

{ "success": "true"} . ?

russellwjoel commented 5 years ago

user endpoint can remove the username parameter as instead all of the data for a user is taken from the token,

russellwjoel commented 5 years ago

add is_active check to all user action endpoints.

russellwjoel commented 5 years ago

add logging on all endpoints

russellwjoel commented 5 years ago

cognifit view .. ErrorMessage =. User has not recorded enough Cognifit Skill Results . -> . NO Cognifit Results

russellwjoel commented 5 years ago

remove auto genrate of json for all questionnaires.

russellwjoel commented 5 years ago

change user/profile . resource to somehting else? - fitbitprofile?

russellwjoel commented 5 years ago

'/user/consent/', methods=['POST']) . should be different.

PUT request not post

resource /user/consent