Apipie generated docs

Two questions

  1. I generated new api docs to upload to theforeman.org, however, .html is missing in the all the files
  • <td><a href='./apidoc/v1/architectures/index.html'>GET /api/architectures</a></td>
  • <td><a href='./apidoc/v1/architectures/index'>GET /api/architectures</a></td>
  1. When using param groups, where would I moved :action_aware => true if I remove param :config_template, Hash from the group, so that it doesn't show the root node.

    def_param_group :config_template do
    param :config_template, Hash, :action_aware => true do
    param :name, String, :required => true, :desc => "template name"
    param :template, String, :required => true
    param :snippet, :bool, :allow_nil => true
    param :audit_comment, String, :allow_nil => true
    param :template_kind_id, :number, :allow_nil => true, :desc => "not relevant for snippet"
    param :template_combinations_attributes, Array,
    :desc => "Array of template combinations (hostgroup_id, environment_id)"
    param :operatingsystem_ids, Array, :desc => "Array of operating systems ID to associate the template with"
    end
    end

Thanks,

Joseph

> Two questions
>
> 1) I generated new api docs to upload to theforeman.org, however, .html is
> missing in the all the files
>
> - <td><a href='./apidoc/v1/architectures/index.html'>GET
> /api/architectures</a></td>
> + <td><a href='./apidoc/v1/architectures/index'>GET
> /api/architectures</a></td>
>
> 2) When using param groups, where would I moved :action_aware => true if I
> remove param :config_template, Hash from the group, so that it doesn't show
> the root node.
>
> def_param_group :config_template do
> param :config_template, Hash, :action_aware => true do
> param :name, String, :required => true, :desc => "template name"
> param :template, String, :required => true
> param :snippet, :bool, :allow_nil => true
> param :audit_comment, String, :allow_nil => true
> param :template_kind_id, :number, :allow_nil => true, :desc => "not
> relevant for snippet"
> param :template_combinations_attributes, Array,
> :desc => "Array of template combinations (hostgroup_id,
> environment_id)"
> param :operatingsystem_ids, Array, :desc => "Array of operating
> systems ID to associate the template with"
> end
> end
>
> Thanks,
>
> Joseph

i think you'd want to add :action_aware =&gt; true for every one of the params

··· ----- Original Message -----


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/d/optout.

  • adam price