Endpoint definitions

[paulohesilva]

Hi all, In attachment the initial definitions for API Endpoint.. What do you think?

Endpoints - Pimp.xlsx

[fernandobalm]

I don't know Django, so discard comments that doesn't make sense:
Considering just the coherence of endpoints worksheet and diagram class published by Lucas follow a few comments:

• will not exist a possibility of a user to update his/her comment or rating? if so, should exist a put method for {URL}/catador/{ID}/rating?
• permissions for methods applied to profile, rating and photo shouldn't be for all?
• will not exist post and get methods for historic entity? I could be used If there will exist admin screens for historic, tracking or audit, for example.
• line 19({URL}/catador/{ID}/photo), column method, shouldn't be GET?

[paulohesilva]

1. I think useful, I will update the document

2. I have doubt in it, The user not authenticated can manage photo or rating?

3. There is a requirement to manage the historical?

[fernandobalm]

2. Sorry for my imprecision. When I said all, I was meaning any authenticated user. So It would be available not only for catador and admin, but any user of system (users that discard material too).
3. I think there isn't a requirement. This is a point to be asked for PIMP. If they need administrative screens for historic, tracking or audit, for example.

[paulohesilva]

1. I guess that we may allow authenticated users make commentaries about others users but, manage photo i believe that is bad approach. Maybe there are business rules that i don't know.

2. I agree

In attachment a second version
Endpoints.-.Pimp.xlsx

[fernandobalm]

1. By what I understood, it was suggested a different approach for this software. A kind of wiki approach. This way, any authenticated use could manage profile of any catador. But just a specific catador himself/herself can claim his/her profile and lock it. I guess the same behaviour would be used for photos. But, if you agree, let's do this question for Lucas and Pimp too.