Changing api path

14 views
Skip to first unread message

Christian Muise

unread,
Jun 22, 2015, 3:14:00 AM6/22/15
to planning...@googlegroups.com
To keep things a little general, I was considering changing the api to the following url format:
  • api.planning.domains/classical/... : Allows us to use the same service for multiple formalisms (classical, fond, pond, rddl, etc)
  • api.planning.domains/json/[fond|classical|...]/... : Allows us to use the standard urls for a web-friendly view (with wiki editing features) that is currently under development. Also means we can replace json with xml or anything else appropriate.
Any objections, thoughts, feedback?

  Cheers

Florian Pommerening

unread,
Jun 22, 2015, 7:55:37 AM6/22/15
to planning...@googlegroups.com
I like the idea of making "json" explicit and use the standard urls for
a web-friendly view.

Making classical part of the url doesn't hurt too much either, even if
there are no non-classical tasks in the near future.

On 22.06.2015 09:14, Christian Muise wrote:
> To keep things a little general, I was considering changing the api to
> the following url format:
>
> * api.planning.domains/*classical*/... : Allows us to use the same
> service for multiple formalisms (classical, fond, pond, rddl, etc)
> * api.planning.domains/*json*/[fond|classical|...]/... : Allows us to
> use the standard urls for a web-friendly view (with wiki editing
> features) that is currently under development. Also means we can
> replace *json* with *xml* or anything else appropriate.
>
> Any objections, thoughts, feedback?
>
> Cheers
>
> --
> http://planning.domains/
> https://bitbucket.org/planning-tools/
> ---
> You received this message because you are subscribed to the Google
> Groups "Planning.Domains" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to planning-domai...@googlegroups.com
> <mailto:planning-domai...@googlegroups.com>.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/planning-domains/b736979a-45fe-45df-9d22-42ac20ceb246%40googlegroups.com
> <https://groups.google.com/d/msgid/planning-domains/b736979a-45fe-45df-9d22-42ac20ceb246%40googlegroups.com?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/d/optout.

Christian Muise

unread,
Jun 22, 2015, 9:11:12 AM6/22/15
to Florian Pommerening, planning...@googlegroups.com
I like it!

So what about a compromise? Standard urls for the view, explicit "edit" for the wiki, and format keywords for the api? Examples:
- api.planning.domains/classical/problem/1313
- api.planning.domains/edit/classical/problem/1313
- api.planning.domains/json/classical/problem/1313
- api.planning.domains/xml/classical/problem/1313

I'd say either that, or have the first one be api.planning.domains/view/classical/problem/1313. I'm kind of on the fence between the two options.

  Cheers

To unsubscribe from this group and stop receiving emails from it, send an email to planning-domai...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/planning-domains/5587F7B8.5090908%40unibas.ch.

Guillem Francès

unread,
Jun 22, 2015, 10:59:36 AM6/22/15
to Christian Muise, planning...@googlegroups.com

Just as an additional note, a while ago it was kind of standard to specify the format as an extension, e.g. 

api.planning.domains/classical/problem/1313.json
api.planning.domains/classical/problem/1313.xml
api.planning.domains/classical/problem/1313  [visualization mode, maybe with extension ".html"]

Not sure however if I like the idea of having a full wiki under the same API domain?
Depending on the type of wiki you're considering, this might end up creating unnecessary complications wrt the routing? (e.g. I imagine certain wiki packages will come with their own routing schemes, etc). Server-side, decoupling the projects might be a good idea?

G.



To view this discussion on the web visit https://groups.google.com/d/msgid/planning-domains/CAB%2B_qfVfzxRRH7cuzuSk8rCFTdadkhXsraADpJL-diKDt%2Bf_eQ%40mail.gmail.com.

Jendrik Seipp

unread,
Jun 22, 2015, 6:11:01 PM6/22/15
to Christian Muise, planning...@googlegroups.com
I'm not aware of the general current layout, but should we maybe name the first one api.planning.domains/wiki/classical/... (or similar) to have the same hierarchy in all URLs?

Cheers,
Jendrik

Christian Muise

unread,
Jun 22, 2015, 6:26:40 PM6/22/15
to planning...@googlegroups.com, guillem...@gmail.com, christi...@gmail.com
[preface: sorry for the mis-order in messages -- Jendrik was marked as spam for some reason :p]

I always had an aversion to dot-extensions for some reason :p. I think the recent trend is either including the format in the url (.../json/...) or adding it as a get (...?format=json). Latter looks a little clunky too...

I should clarify that "wiki" should read "wiki-like". Everything will be custom built stuff. Edits will be approved (or rejected) by any planning folk willing to donate their time to filter out spam that gets past the planning-specific captcha (e.g., "what does FD stand for?" or something). We don't really have a need for massive history integration. Etc.

So essentially, we get to control all the urls that make up the service.

Polled some folks locally -- looks like the option is leaning towards api.p.d/<format>/classical/... for API access, api.p.d/edit/classical/... for editing, and api.p.d/classical/... for web display. Unless there's any major objections, I'll throw those into the backend / libraries later today...

Thanks for the advice!
To unsubscribe from this group and stop receiving emails from it, send an email to planning-domains+unsubscribe@googlegroups.com.

--
http://planning.domains/
https://bitbucket.org/planning-tools/
---
You received this message because you are subscribed to the Google Groups "Planning.Domains" group.
To unsubscribe from this group and stop receiving emails from it, send an email to planning-domains+unsubscribe@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages