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

API Wiki update #34

Closed
jlaustill opened this issue Aug 15, 2016 · 7 comments
Closed

API Wiki update #34

jlaustill opened this issue Aug 15, 2016 · 7 comments

Comments

@jlaustill
Copy link
Contributor

I don't have update permissions on the wiki, so here's what I added this morning, you can review and post to your liking :)
API.zip

@psolom
Copy link
Owner

psolom commented Aug 16, 2016

Thank you. I have added most of your notes, and extended the API with new examples, specified request method (GET|POST) and so on. Check it out.

@jlaustill
Copy link
Contributor Author

That looks great! We all hate documenting, but it's sure nice to have moving forward.

@psolom
Copy link
Owner

psolom commented Aug 16, 2016

Right. And the API should be modified after you manage with #37
By the way we don't need to put time param for each request. It was initially added to prevent images from caching, so I believe we have to revise time and config params. Take a look on that while you work on #37, please.

@jlaustill
Copy link
Contributor Author

I was wondering what the purpose was of the time, I completely ignored it so far in my nodejs api :) I also ignored the config param and used a local copy for now assuming we would move towards separated config for api/ui.

We will have to work through each endpoint for #37 , and I think updating the documentation should probably be done in the repo until that version ships, or we should clearly label each section with current version looks like this, next version looks like this. I'm good either way. I'd like to hear your thoughts on that.

@psolom
Copy link
Owner

psolom commented Aug 16, 2016

Sure it will work without these params in the basic implementation, but it doesn't mean that they are useless. FM is a powerful plugin which can change it behaviour depending on configuration. So if time and config params exists I strongly believe they can take an effect in some case. As I said above time is definetely prevent images from caching. Don't ignore those params.

@jlaustill
Copy link
Contributor Author

I won't ignore them once I understand their purpose, I promise :)

@psolom
Copy link
Owner

psolom commented Oct 25, 2016

Done. For any following questions and discussions go to #37

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

2 participants