Foreman API docs on our site

Development
1

Hey,

I noticed we still have v1 API there. How do we generate that?

LZ

··· -- Later,

Lukas “lzap” Zapletal
irc: lzap #theforeman

2

If you are development, it will automatically generate the docs if you go to URL /apidoc

In production, I think the static doc files need to be first be generated by a rake task from apipie and then go to /apidoc

rake apipie:static

Joseph

··· ----- Original Message ----- From: "Lukas Zapletal" To: foreman-dev@googlegroups.com Sent: Monday, July 15, 2013 12:05:08 PM Subject: [foreman-dev] Foreman API docs on our site

Hey,

I noticed we still have v1 API there. How do we generate that?

LZ

–
Later,

Lukas “lzap” Zapletal
irc: lzap #theforeman

–
You received this message because you are subscribed to the Google Groups “foreman-dev” group.
To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

3

Sorry Joseph for not being verbose :smiley:

I mean this: Foreman

Do we have a Jenkins job for generating this?

LZ

··· On Mon, Jul 15, 2013 at 05:18:42AM -0400, Joseph Magen wrote: > If you are development, it will automatically generate the docs if you go to URL /apidoc > > In production, I think the static doc files need to be first be generated by a rake task from apipie and then go to /apidoc > > rake apipie:static > > Joseph > > > > > ----- Original Message ----- > From: "Lukas Zapletal" > To: foreman-dev@googlegroups.com > Sent: Monday, July 15, 2013 12:05:08 PM > Subject: [foreman-dev] Foreman API docs on our site > > Hey, > > I noticed we still have v1 API there. How do we generate that? > > LZ > > -- > Later, > > Lukas "lzap" Zapletal > irc: lzap #theforeman > > -- > You received this message because you are subscribed to the Google Groups "foreman-dev" group. > To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com. > For more options, visit https://groups.google.com/groups/opt_out. > > -- > You received this message because you are subscribed to the Google Groups "foreman-dev" group. > To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com. > For more options, visit https://groups.google.com/groups/opt_out. > >

–
Later,

Lukas “lzap” Zapletal
irc: lzap #theforeman

4

No, it needs updating in the web site repo, theforeman.org.

When I briefly looked while doing 1.2, I could generate static
documentation for a single version, so was thinking to generate it once
for v1, again for v2 and then add a dropdown menu to the site (like the
manuals link) to select the one you want.

The dynamic documentation has a link though between the two, so is this
just a limitation of the static docs?

··· On 15/07/13 10:59, Lukas Zapletal wrote: > Sorry Joseph for not being verbose :-D > > I mean this: http://theforeman.org/api.html > > Do we have a Jenkins job for generating this?

–
Dominic Cleal
Red Hat Engineering