asu-ke-web-services / search-api

Search API for documents, data, research, people, etc
MIT License
2 stars 1 forks source link

Search Request validation #71

Closed rraub closed 8 years ago

rraub commented 8 years ago

Where should the request get validated?

rraub commented 8 years ago

Lets make a sequence diagram!

kenprice commented 8 years ago

An idea for validating user input: Since SearchRequest contains all of the user input, we could have a SearchRequestBuilder which will be in charge of validating user input, and either return a SearchRequest object or an error.

kenprice commented 8 years ago

@rraub As for the sequence diagram, I made a diagram here. I'm just learning UML, so it's basic. But I think I put enough information in the models I made.

rraub commented 8 years ago

@kenprice looks good, these diagrams illustrate nicely the basic flow of the application. One of the nice features of these diagrams is the discussions they can bring out: For example when should the execution not follow this exact path? (validation errors)