Add Foreman 3.16 apidocs

[ogajduse]

No description provided.

[evgeni]

This is missing the examples, I think this is fine if generating those is failing right now, but I wanted to point it out to check whether this was intentional.

[evgeni]

We decided on IRC to wait.

[evgeni]

apipie-rails 1.5.0 is released and you should be able to generate examples again

[ogajduse]

@evgeni Huge thank you for your effort around this. Appreciate it! Would you please quickly go through the diff that the update caused? I am unsure about some changes in there. The one below is one of them - shouldn't we list all locales we ship? Does anyone even care? 🤔

diff --git a/foreman/3.16/apidoc/v2/users/create.html b/foreman/3.16/apidoc/v2/users/create.html
index e9273ff..1d6b41e 100644
--- a/foreman/3.16/apidoc/v2/users/create.html
+++ b/foreman/3.16/apidoc/v2/users/create.html
@@ -476,7 +476,7 @@
         <p><strong>Validations:</strong></p>
         <ul>
             <li>
-<p>Must be one of: <code>ca</code>, <code>cs_CZ</code>, <code>de</code>, <code>en</code>, <code>en_GB</code>, <code>es</code>, <code>fr</code>, <code>it</code>, <code>ja</code>, <code>ka</code>, <code>ko</code>, <code>pl</code>, <code>pt_BR</code>, <code>ru</code>, <code>zh_CN</code>, <code>zh_TW</code>.</p>
+<p>Must be one of: <code>en</code>.</p>
 </li>
         </ul>

Edit: I've downloaded the artifacts using gh CLI as you noted in the README.

[evgeni]

@evgeni Huge thank you for your effort around this. Appreciate it! Would you please quickly go through the diff that the update caused? I am unsure about some changes in there. The one below is one of them - shouldn't we list all locales we ship? Does anyone even care? 🤔

diff --git a/foreman/3.16/apidoc/v2/users/create.html b/foreman/3.16/apidoc/v2/users/create.html
index e9273ff..1d6b41e 100644
--- a/foreman/3.16/apidoc/v2/users/create.html
+++ b/foreman/3.16/apidoc/v2/users/create.html
@@ -476,7 +476,7 @@
         <p><strong>Validations:</strong></p>
         <ul>
             <li>
-<p>Must be one of: <code>ca</code>, <code>cs_CZ</code>, <code>de</code>, <code>en</code>, <code>en_GB</code>, <code>es</code>, <code>fr</code>, <code>it</code>, <code>ja</code>, <code>ka</code>, <code>ko</code>, <code>pl</code>, <code>pt_BR</code>, <code>ru</code>, <code>zh_CN</code>, <code>zh_TW</code>.</p>
+<p>Must be one of: <code>en</code>.</p>
 </li>
         </ul>

We only generate docs for EN, so this seems consistent, as the code underneath uses FastGettext.available_locales and only en is available.

I think that's fine for now, but surely could be improved.

[ogajduse]

Nice! Now we need someone to review the PR and merge it 🙂

[evgeni]

Another funny one:

- <p>Must be one of: <code>interface</code>, <code>bmc</code>, <code>bond</code>, <code>bridge</code>.</p>
+ <p>Must be one of: <code>interface</code>, <code>bmc</code>, <code>bond</code>, <code>bridge</code>, <code>interface</code>, <code>bmc</code>, <code>bond</code>, <code>bridge</code>, <code>interface</code>, <code>bmc</code>, <code>bond</code>, <code>bridge</code>.</p>

app/controllers/api/v2/interfaces_controller.rb:        param :type, InterfaceTypeMapper::ALLOWED_TYPE_NAMES, :desc => N_("Interface type, e.g. bmc. Default is %{default_nic_type}")

ALLOWED_TYPE_NAMES needs a uniq somewhere.

then we miss a sort here:

- <p>Template kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init, host_init_config, registration, kexec, Bootdisk, public</p>
+ <p>Template kinds, available values: iPXE, provision, PXELinux, script, finish, PXEGrub, PXEGrub2, host_init_config, registration, public</p>

(and I think your setup had more than pure foreman installed)