Project

General

Profile

Bug #14693

subscription and content facet attributes not included in apipie docs

Added by Thomas McKay about 3 years ago. Updated 12 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
API doc
Target version:
Difficulty:
Triaged:
Yes
Bugzilla link:
Pull request:
Team Backlog:
Fixed in Releases:
Found in Releases:

Description

At time of apipie runs, the facets are not loaded so they are not included in the PUT /api/hosts docs.

engine.rb
      Facets.register(Katello::Host::SubscriptionFacet, :subscription_facet) do
        api_view :list => 'katello/api/v2/subscription_facet/base_with_root', :single => 'katello/api/v2/subscription_facet/show'
        api_docs(:subscription_facet_attributes, ::Katello::Api::V2::HostSubscriptionsController,
            _("Host subscription facet attributes"))
      end

host_subscriptions_controller.rb
    def_param_group :subscription_facet_attributes do
      param :installed_products, Array, :desc => N_("List of products installed on the host") do
        param :product_id, String, :desc => N_("Product id as listed from a host's installed products, \
          this is not the same product id as the products api returns")
        param :product_name, String, :desc => N_("Product name as listed from a host's installed products")
        param :arch, String, :desc => N_("Product architecture")
        param :version, String, :desc => N_("Product version")
      end
    end

History

#1 Updated by Eric Helms about 3 years ago

  • Legacy Backlogs Release (now unused) set to 114

Also available in: Atom PDF