[API] Visit patch request to start next stage

[laemtl]

Patch request url: /candidates/CandID/Visit
Patch request format:

{
    "CandID"  : 317604,
    "Visit"   : 'Visit 01',
    "Site"    : 'DCC',
    "Battery" : 'Stale',
    "Project" : 'Pumpernickel',
    "Stages" : {
        "Visit" : {
            "Date" : "YYYY-MM-DD",
            "Status" : "In Progress"
        }
    }
}

This will only 'start next stage' when 1. the payload contains a "Visit" stage with "In Progress" as Status 2. The current status of the Visit stage is "Not Started".

[xlecours]

I think we should find a solution that will allow to go from "Not started" to"In Progress" and also from "In Progress" to "Pass" or any other valid status. The get request returns a "Stages" with a property fro each stages.

"Stages": {
    "Screening": {
      "Date": "string",
      "Status": "Pass"
    }
  }

I think that a PATCH request with a similar object in the body could handle more types of transitions. Also, the frontend ask if scans were acquired, maybe we should add that.

[laemtl]

@xlecours My intuition is that implementing a solution to switch from In Progress to Pass implies some checks that I'm not familiar with. It's probably the same for Withdrawal and maybe Failure. This PR covers the functionality I need for a particular project, I may not have time to address your suggestion before a while.

[driusan]

I agree with Xavier that it would be better to infer it from the same structure based on what stages are set in

    "Stages" : {
              "Screening" :  {
                  "Date" : "YYYY-MM-DD",
                  "Status" : "Pass|Failure|Withdrawal|In Progress"
              },
              "Visit" : {
                  "Date" : "YYYY-MM-DD",
                  "Status" : "Pass|Failure|Withdrawal|In Progress"
              },
              "Approval" : {
                  "Date" : "YYYY-MM-DD",
                  "Status" : "Pass|Failure|Withdrawal|In Progress"
              }

For the sake of starting a next stage, handling a PATCH request that sets the Status of Visit to In Progress is all that's really needed to handle starting a visit stage. The rest of the transitions can either return a "Not Implemented" or "Bad Request" result as appropriate.

[laemtl]

@driusan Leaving some cases Not Implemented is a really good idea to address Xavier's suggestion in a limited time frame. I will do that shortly.

[xlecours]

I have a bad feeling about using inheritance to solve the versioning problem. I understand that both endpoints are sharing code but, when we will move 0.0.4 from dev to prod, everything that is not in the subclass will need to be merge anyway.
@laemtl @driusan ?

[xlecours]

This should also modify modules/api/static/schema.yml. I can push a contribution if you would like me to.

[laemtl]

This should also modify modules/api/static/schema.yml. I can push a contribution if you would like me to.

I am not modifying v0.0.3 so do we need to change anything?

[xlecours]

This should also modify modules/api/static/schema.yml. I can push a contribution if you would like me to.

I am not modifying v0.0.3 so do we need to change anything?

You are right. Let's add a new file then.

[laemtl]

@driusan @xlecours Comments addressed.

[laemtl]

@driusan @xlecours Ready for re-review.

[driusan]

It's not clear to me what this means for the other fields. Should they be left out of the request? Included with garbage data?

[laemtl]

I removed Approval and Screening from the request.

Re-review requested a week ago.

[xlecours]

I have tested it. It works all right. It's just that an empty array as a response is not ideal. I will approve this in its current state but it should return and empty response with a 204 status code.

[xlecours]

laemtl#34 sent

I contributed to this PR

[ridz1208]

@xlecours @driusan does this need change to the MD API documentation ?

[xlecours]

@xlecours @driusan does this need change to the MD API documentation ?

yes. and it's already there.