###################### Products - `/products` ###################### The ``/products/`` API allows you to list Products, create new Products, and update Products (including adding new :doc:`Builds ` and :doc:`Editions `). In LTD Keeper, a Product is the root entity associated with a documentation project. Generally, a single Sphinx documentation repository maps to a Product. LTD Keeper can host documentation for several products. The actual documentation associated with a Product is manifested by :doc:`Builds `. In turn, :doc:`Builds ` are the source of :doc:`Editions `, which are published versions of the Product's documentation. Method summary ============== - :http:get:`/products/` --- list all documentation products. - :http:get:`/products/(slug)` --- show a single product. - :http:post:`/products/` --- create a new product. - :http:patch:`/products/(slug)` --- update a product's metadata. - :http:post:`/products/(slug)/builds/` --- create a new build for a product. - :http:get:`/products/(slug)/builds/` --- list all builds for a product. - :http:post:`/products/(slug)/editions/` --- create a new edition for a product. - :http:get:`/products/(slug)/editions/` --- list all editions for a product. - :http:post:`/products/(slug)/dashboard` --- manually rebuild the dashboards for a product. *See also:* - :doc:`/builds/ ` - :doc:`/editions/ ` Reference ========= .. autoflask:: keeper:flask_app :endpoints: api.get_products, api.get_product, api.new_product, api.edit_product, api.post_products_builds_v1, api.get_product_builds, api.new_edition, api.get_product_editions, api.rebuild_product_dashboard