-
Notifications
You must be signed in to change notification settings - Fork 1
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
Deprecate school names api method #18
Comments
I'm keen to keep discussions about the API more discussional than My first goal of any discussion is to try to reach a common understanding. Let's say (for sake of this example), that we have data on the server that schools With this data, as I understand things, you're proposing an API method "schoolNames": [ I can do everything I need to on this sprint with this (if I refactor), and Note, however, that the only information needed on this sprint from the Before I go on, I think it's worthwhile pausing here and getting Please confirm! :) On 9 July 2013 11:07, villarin notifications@github.com wrote:
|
I think that the only important bit for this sprint would be to keep the Adding the "ID" to schools - is not really required at this stage - but I From: Ryan Randall [mailto:notifications@github.com] I'm keen to keep discussions about the API more discussional than My first goal of any discussion is to try to reach a common understanding. Let's say (for sake of this example), that we have data on the server that schools With this data, as I understand things, you're proposing an API method "schoolNames": [ I can do everything I need to on this sprint with this (if I refactor), and Note, however, that the only information needed on this sprint from the Before I go on, I think it's worthwhile pausing here and getting Please confirm! :) On 9 July 2013 11:07, villarin notifications@github.com wrote:
Reply to this email directly or view |
It's still not clear to me from your reply that you understand what I'm Can you please confirm that you understand that the difference between $ On 9 July 2013 14:51, villarin notifications@github.com wrote:
|
Yes I understand that - but this is why id is a unique identifier for each As far as the names are concerned a list of unique names can be derived from Or maybe the school name should just have the location appended to it - so From: Ryan Randall [mailto:notifications@github.com] It's still not clear to me from your reply that you understand what I'm Can you please confirm that you understand that the difference between $ On 9 July 2013 14:51, villarin notifications@github.com wrote:
Reply to this email directly or view |
Okay - it seems we have that firm base I was striving for. I'll now You've confirmed that I understand your proposal. I'm definitely not averse to having an API method exactly as you describe. My concern is that if I use it for this sprint then it goes against another With this proposal we're getting $ when we need only $$. Can you confirm that my understanding is correct - i.e. that this proposal If this is the case, then we have a similar situation to issue #17. How about you have a go at proposing a replacement rule / guideline / set On 9 July 2013 15:17, villarin notifications@github.com wrote:
|
Ok I can see that changing the format of the schoolNames schema at this So I think we should probably stick to Rule C on this one - and only change Issue #17 is different because it causes code duplication and other |
Understood. I've just created #20 as a reminder to document whatever general API design rules / guidelines we come to an agreement on. I think this is a great thing to come out of this discussion (and the one on issue 17). I think I'm happy on this exact issue as long as we stick to Rule C - so please go with whatever works best for you. Let me know what you decide and I'll refactor things at my end accordingly. |
Api method: http://pythondave.github.io/th-admin/2/0.4/scaffolding/api/default.html#/school-names
Please deprecate this method and include the school names data as a new property of: /admin/service/basic-lists.
School names records can be kept pretty much as they are now - but would be good to add the id attribute as well.
See proposed format for the school names property below:
"schoolNames": [
{
"id": 1,
"name": "School of Manuel"
},
{
"id": 2,
"name": "Ecole de Marissa"
}]
The text was updated successfully, but these errors were encountered: