Skip to content
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

Move Relations location in some responses #222

Open
evillemez opened this issue May 8, 2014 · 3 comments
Open

Move Relations location in some responses #222

evillemez opened this issue May 8, 2014 · 3 comments

Comments

@evillemez
Copy link
Contributor

At the moment, if you hit GET /resources/{id}, there will be a field called resource.relations - but it will only contain relations created by the owner of the Resource in question.

All other uses of Relations require using the actual /relations api, which returns the top-level field relations, which is an array of Relations.

I think that, for consistency, relations should be removed as a possible field for resource, and that GET /resources/{id} should just return an extra relations property instead.

Having it exposed in the API in some places as a sub property of resource implies that a Resource "owns" a Relation, which is not true, since they are bidirectional.

I'm not sure how big of a break this would be for everyone.

@gliese1337, @DavidMikeSimon, @cmac1000 Any thoughts?

@DavidMikeSimon
Copy link
Contributor

I think this is probably sensible. It also reduces the amount of work that Resource index has to do, which is good.

@gliese1337
Copy link

This will require some changes to our client code, but it shouldn't be too horrible. I agree it is a sensible change. Please give us a transition period where both versions are active, though, so that we can avoid downtime on videos being used in classes..

@evillemez
Copy link
Contributor Author

We'll let you know. We probably won't be able to get to this for a little while as it is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants