About this service

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>About this service</title> <style type="text/css"> body { font-family: sans-serif; font-size: 0.85em; margin: 2em 8em; } .methods { background-color: #eef; padding: 1em; margin-bottom: 0.5em; } .method { padding-left: 4em; } h1 { font-size: 2.5em; } h2 { border-bottom: 1px solid black; margin-top: 1em; margin-bottom: 0.5em; font-size: 2em; } h3 { color: orange; font-size: 1.75em; margin-top: 1.25em; margin-bottom: 0em; } h4 { font-size: 1.50em; margin: 0em; padding: 0em; border-bottom: 2px solid white; } h5 { font-size: 1.25em; margin-left: -3em; } h6 { font-size: 1.1em; color: #99a; margin: 0.5em 0em 0.25em 0em; } dd { margin-left: 1em; } tt, code { font-size: 1.2em; } table { margin-bottom: 0.5em; } th { text-align: left; font-weight: normal; color: black; border-bottom: 1px solid black; padding: 3px 6px; } td { padding: 3px 6px; vertical-align: top; background-color: #f6f6ff; font-size: 0.85em; } td p { margin: 0px; } ul { padding-left: 1.75em; } p + ul, p + ol, p + dl { margin-top: 0em; } label { font-weight: bold; } .optional { font-weight: normal; opacity: 0.75; } .toc-link { font-size: 0.85em; } </style> </head> <body> <h1>About this service</h1> <p>The Launchpad web service allows automated clients to access most of the functionality available on the Launchpad web site. For help getting started, see <a href="https://help.launchpad.net/API/">the help wiki.</a></p> <p>This version of the web service reflects the most recent changes made. It may abruptly change without warning. Periodically, these changes are bundled up and given a permanent version number.</p> <div id="toc" title="toc"> <h2>Table of Contents</h2> <h3>Top-level collections</h3> <ul> <li> <a href="#archives">archives</a> </li> <li> <a href="#branches">branches</a> </li> <li> <a href="#bug_trackers">bug_trackers</a> </li> <li> <a href="#bugs">bugs</a> </li> <li> <a href="#builders">builders</a> </li> <li> <a href="#charm_bases">charm_bases</a> </li> <li> <a href="#charm_recipes">charm_recipes</a> </li> <li> <a href="#countries">countries</a> </li> <li> <a href="#craft_recipes">craft_recipes</a> </li> <li> <a href="#cves">cves</a> </li> <li> <a href="#distributions">distributions</a> </li> <li> <a href="#git_repositories">git_repositories</a> </li> <li> <a href="#languages">languages</a> </li> <li> <a href="#livefses">livefses</a> </li> <li> <a href="#packagesets">packagesets</a> </li> <li> <a href="#people">people</a> </li> <li> <a href="#polls">polls</a> </li> <li> <a href="#processors">processors</a> </li> <li> <a href="#project_groups">project_groups</a> </li> <li> <a href="#projects">projects</a> </li> <li> <a href="#questions">questions</a> </li> <li> <a href="#rock_bases">rock_bases</a> </li> <li> <a href="#rock_recipes">rock_recipes</a> </li> <li> <a href="#snap_bases">snap_bases</a> </li> <li> <a href="#snappy_serieses">snappy_serieses</a> </li> <li> <a href="#snaps">snaps</a> </li> <li> <a href="#specifications">specifications</a> </li> <li> <a href="#temporary_blobs">temporary_blobs</a> </li> <li> <a href="#translation_groups">translation_groups</a> </li> <li> <a href="#translation_import_queue_entries">translation_import_queue_entries</a> </li> </ul> <h3>Entry types</h3> <ul> <li> <a href="#access_token">access_token</a> </li> <li> <a href="#access_token_target">access_token_target</a> </li> <li> <a href="#archive">archive</a> </li> <li> <a href="#archive_dependency">archive_dependency</a> </li> <li> <a href="#archive_permission">archive_permission</a> </li> <li> <a href="#archive_subscriber">archive_subscriber</a> </li> <li> <a href="#binary_package_publishing_history">binary_package_publishing_history</a> </li> <li> <a href="#binary_package_release_download_count">binary_package_release_download_count</a> </li> <li> <a href="#branch">branch</a> </li> <li> <a href="#branch_merge_proposal">branch_merge_proposal</a> </li> <li> <a href="#branch_subscription">branch_subscription</a> </li> <li> <a href="#bug">bug</a> </li> <li> <a href="#bug_activity">bug_activity</a> </li> <li> <a href="#bug_attachment">bug_attachment</a> </li> <li> <a href="#bug_branch">bug_branch</a> </li> <li> <a href="#bug_link_target">bug_link_target</a> </li> <li> <a href="#bug_nomination">bug_nomination</a> </li> <li> <a href="#bug_subscription">bug_subscription</a> </li> <li> <a href="#bug_subscription_filter">bug_subscription_filter</a> </li> <li> <a href="#bug_target">bug_target</a> </li> <li> <a href="#bug_task">bug_task</a> </li> <li> <a href="#bug_tracker">bug_tracker</a> </li> <li> <a href="#bug_tracker_component">bug_tracker_component</a> </li> <li> <a href="#bug_tracker_component_group">bug_tracker_component_group</a> </li> <li> <a href="#bug_watch">bug_watch</a> </li> <li> <a href="#build">build</a> </li> <li> <a href="#build_farm_job">build_farm_job</a> </li> <li> <a href="#builder">builder</a> </li> <li> <a href="#charm_base">charm_base</a> </li> <li> <a href="#charm_recipe">charm_recipe</a> </li> <li> <a href="#charm_recipe_build">charm_recipe_build</a> </li> <li> <a href="#charm_recipe_build_request">charm_recipe_build_request</a> </li> <li> <a href="#ci_build">ci_build</a> </li> <li> <a href="#code_import">code_import</a> </li> <li> <a href="#code_review_comment">code_review_comment</a> </li> <li> <a href="#code_review_vote_reference">code_review_vote_reference</a> </li> <li> <a href="#commercial_subscription">commercial_subscription</a> </li> <li> <a href="#country">country</a> </li> <li> <a href="#craft_recipe">craft_recipe</a> </li> <li> <a href="#craft_recipe_build">craft_recipe_build</a> </li> <li> <a href="#craft_recipe_build_request">craft_recipe_build_request</a> </li> <li> <a href="#cve">cve</a> </li> <li> <a href="#distribution">distribution</a> </li> <li> <a href="#distribution_mirror">distribution_mirror</a> </li> <li> <a href="#distribution_source_package">distribution_source_package</a> </li> <li> <a href="#distro_arch_series">distro_arch_series</a> </li> <li> <a href="#distro_arch_series_filter">distro_arch_series_filter</a> </li> <li> <a href="#distro_series">distro_series</a> </li> <li> <a href="#distro_series_difference">distro_series_difference</a> </li> <li> <a href="#distro_series_difference_comment">distro_series_difference_comment</a> </li> <li> <a href="#email_address">email_address</a> </li> <li> <a href="#faq">faq</a> </li> <li> <a href="#faq_target">faq_target</a> </li> <li> <a href="#git_ref">git_ref</a> </li> <li> <a href="#git_repository">git_repository</a> </li> <li> <a href="#git_subscription">git_subscription</a> </li> <li> <a href="#git_target">git_target</a> </li> <li> <a href="#gpg_key">gpg_key</a> </li> <li> <a href="#has_bugs">has_bugs</a> </li> <li> <a href="#has_milestones">has_milestones</a> </li> <li> <a href="#irc_id">irc_id</a> </li> <li> <a href="#jabber_id">jabber_id</a> </li> <li> <a href="#language">language</a> </li> <li> <a href="#livefs">livefs</a> </li> <li> <a href="#livefs_build">livefs_build</a> </li> <li> <a href="#message">message</a> </li> <li> <a href="#message_revision">message_revision</a> </li> <li> <a href="#milestone">milestone</a> </li> <li> <a href="#object_with_translation_imports">object_with_translation_imports</a> </li> <li> <a href="#oci_project">oci_project</a> </li> <li> <a href="#oci_project_series">oci_project_series</a> </li> <li> <a href="#oci_push_rule">oci_push_rule</a> </li> <li> <a href="#oci_recipe">oci_recipe</a> </li> <li> <a href="#oci_recipe_build">oci_recipe_build</a> </li> <li> <a href="#oci_recipe_build_request">oci_recipe_build_request</a> </li> <li> <a href="#package_upload">package_upload</a> </li> <li> <a href="#package_upload_log">package_upload_log</a> </li> <li> <a href="#packageset">packageset</a> </li> <li> <a href="#person">person</a> </li> <li> <a href="#pillar">pillar</a> </li> <li> <a href="#pillars">pillars</a> </li> <li> <a href="#poll">poll</a> </li> <li> <a href="#preview_diff">preview_diff</a> </li> <li> <a href="#processor">processor</a> </li> <li> <a href="#project">project</a> </li> <li> <a href="#project_group">project_group</a> </li> <li> <a href="#project_group_milestone">project_group_milestone</a> </li> <li> <a href="#project_release">project_release</a> </li> <li> <a href="#project_release_file">project_release_file</a> </li> <li> <a href="#project_series">project_series</a> </li> <li> <a href="#question">question</a> </li> <li> <a href="#question_message">question_message</a> </li> <li> <a href="#question_subscription">question_subscription</a> </li> <li> <a href="#question_target">question_target</a> </li> <li> <a href="#revision_status_report">revision_status_report</a> </li> <li> <a href="#rock_base">rock_base</a> </li> <li> <a href="#rock_recipe">rock_recipe</a> </li> <li> <a href="#rock_recipe_build">rock_recipe_build</a> </li> <li> <a href="#rock_recipe_build_request">rock_recipe_build_request</a> </li> <li> <a href="#service_factory">service_factory</a> </li> <li> <a href="#sharing_service">sharing_service</a> </li> <li> <a href="#snap">snap</a> </li> <li> <a href="#snap_base">snap_base</a> </li> <li> <a href="#snap_build">snap_build</a> </li> <li> <a href="#snap_build_request">snap_build_request</a> </li> <li> <a href="#snappy_series">snappy_series</a> </li> <li> <a href="#social_account">social_account</a> </li> <li> <a href="#source_package">source_package</a> </li> <li> <a href="#source_package_publishing_history">source_package_publishing_history</a> </li> <li> <a href="#source_package_recipe">source_package_recipe</a> </li> <li> <a href="#source_package_recipe_build">source_package_recipe_build</a> </li> <li> <a href="#specification">specification</a> </li> <li> <a href="#specification_branch">specification_branch</a> </li> <li> <a href="#specification_subscription">specification_subscription</a> </li> <li> <a href="#specification_target">specification_target</a> </li> <li> <a href="#ssh_key">ssh_key</a> </li> <li> <a href="#structural_subscription">structural_subscription</a> </li> <li> <a href="#structural_subscription_target">structural_subscription_target</a> </li> <li> <a href="#team">team</a> </li> <li> <a href="#team_membership">team_membership</a> </li> <li> <a href="#temporary_blob">temporary_blob</a> </li> <li> <a href="#timeline_project_series">timeline_project_series</a> </li> <li> <a href="#translation_file">translation_file</a> </li> <li> <a href="#translation_group">translation_group</a> </li> <li> <a href="#translation_import_queue_entry">translation_import_queue_entry</a> </li> <li> <a href="#translation_template">translation_template</a> </li> <li> <a href="#vulnerability">vulnerability</a> </li> <li> <a href="#webhook">webhook</a> </li> <li> <a href="#webhook_delivery">webhook_delivery</a> </li> <li> <a href="#webhook_target">webhook_target</a> </li> <li> <a href="#wiki_name">wiki_name</a> </li> </ul> </div> <div id="top-level-objects" title="top-level-objects"> <h2>Top-level collections</h2> <div id="archives" title="archives" class="top-level-object"> <h3>archives</h3> <p> Interface for ArchiveSet </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/archives</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#archive">archive</a> collection.</dd> </dl> </div> <div id="archives-custom-GETs" title="archives-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="archives-getByReference" title="archives-getByReference">getByReference</h5><p> Return the IArchive with the given archive reference. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByReference</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>reference</strong></p></td><td><p><small>(required)</small></p></td><td><p> Archive reference string </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive">archive</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="branches" title="branches" class="top-level-object"> <h3>branches</h3> <p> Interface representing the set of branches. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/branches</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#branch">branch</a> collection.</dd> </dl> </div> <div id="branches-custom-GETs" title="branches-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="branches-getBranchVisibilityInfo" title="branches-getBranchVisibilityInfo">getBranchVisibilityInfo</h5> <div> <p>Return the named branches visible to both user and person.</p> <p>Anonymous requesters don't get any information.</p> <p>Return a dict with the following values: person_name: the displayname of the person. visible_branches: a list of the unique names of the branches which the requester and specified person can both see.</p> <p>This API call is provided for use by the client Javascript. It is not designed to efficiently scale to handle requests for large numbers of branches.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBranchVisibilityInfo</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>branch_names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> List of branch unique names </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person whose branch visibility is being checked. </p> </td> </tr> </table> </div> <div class="method"><h5 id="branches-getBranches" title="branches-getBranches">getBranches</h5><div> <p>Return a collection of branches.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>modified_since_date</strong></p></td><td><p></p></td><td><div> <p>Modified since date</p> <p>Return only branches whose date_last_modified is greater than or equal to this date.</p> </div></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by most interesting</tt></li><li><tt>by project name</tt></li><li><tt>by status</tt></li><li><tt>by branch name</tt></li><li><tt>by owner name</tt></li><li><tt>most recently changed first</tt></li><li><tt>most neglected first</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li></ul></td><td><p> Sort order </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="branches-getByPath" title="branches-getByPath">getByPath</h5><div> <p>Find a branch by its path.</p> <p>The path is the same as its lp: URL, but without the leading lp:, so it may be in any of these forms:</p> <pre class="rst-literal-block"> Unique names: ~OWNER/PROJECT/NAME ~OWNER/DISTRO/SERIES/SOURCE/NAME ~OWNER/+junk/NAME Aliases linked to other objects: PROJECT PROJECT/SERIES DISTRO/SOURCE DISTRO/SUITE/SOURCE </pre> <p>Return None if no match was found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByPath</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>path</strong></p></td><td><p><small>(required)</small></p></td><td><p> Branch path </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a>. </p> </div> <div class="method"><h5 id="branches-getByUniqueName" title="branches-getByUniqueName">getByUniqueName</h5><div> <p>Find a branch by its ~owner/product/name unique name.</p> <p>Return None if no match was found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByUniqueName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>unique_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Branch unique name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a>. </p> </div> <div class="method"><h5 id="branches-getByUrl" title="branches-getByUrl">getByUrl</h5><div> <p>Find a branch by URL.</p> <p>Either from the external specified in Branch.url, from the URL on <a class="rst-reference external" href="http://bazaar.launchpad.net/" target="_top">http://bazaar.launchpad.net/</a> or the lp: URL.</p> <p>This is a frontend shim to IBranchLookup.getByUrl to allow it to be exported over the API. If you want to call this from within the Launchpad app, use the IBranchLookup version instead.</p> <p>Return None if no match was found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByUrl</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Branch URL </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a>. </p> </div> <div class="method"> <h5 id="branches-getByUrls" title="branches-getByUrls">getByUrls</h5> <div> <p>Finds branches by URL.</p> <p>Either from the external specified in Branch.url, from the URL on <a class="rst-reference external" href="http://bazaar.launchpad.net/" target="_top">http://bazaar.launchpad.net/</a>, or from the lp: URL.</p> <p>This is a frontend shim to IBranchLookup.getByUrls to allow it to be exported over the API. If you want to call this from within the Launchpad app, use the IBranchLookup version instead.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getByUrls</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>urls</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>A list of URLs of branches</p> <p>These can be URLs external to Launchpad, lp: URLs, or <a class="rst-reference external" href="http://bazaar.launchpad.net/" target="_top">http://bazaar.launchpad.net/</a> URLs, or any mix of all these different kinds.</p> </div> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A dictionary mapping URLs to branches. If the URL has no associated branch, the URL will map to None.</td> </p> </div> <div class="method"><h5 id="branches-getMergeProposals" title="branches-getMergeProposals">getMergeProposals</h5><div> <p>Return the merge proposals that resulted in this revision.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>merged_revision</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="bug_trackers" title="bug_trackers" class="top-level-object"> <h3>bug_trackers</h3> <div> <p>A set of IBugTracker's.</p> <p>Each BugTracker is a distinct instance of a bug tracking tool. For example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bug_trackers</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#bug_tracker">bug_tracker</a> collection.</dd> </dl> </div> <div id="bug_trackers-custom-GETs" title="bug_trackers-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="bug_trackers-getByName" title="bug_trackers-getByName">getByName</h5><div> <p>Get a BugTracker by its name.</p> <p>If no tracker with the given name exists, return default.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The bug tracker name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker">bug_tracker</a>. </p> </div> <div class="method"><h5 id="bug_trackers-queryByBaseURL" title="bug_trackers-queryByBaseURL">queryByBaseURL</h5><p> Return one or None BugTracker's by baseurl </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>queryByBaseURL</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>base_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> The base URL of the bug tracker </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker">bug_tracker</a>. </p> </div> </div> <div id="bug_trackers-custom-POSTs" title="bug_trackers-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="bug_trackers-ensureBugTracker" title="bug_trackers-ensureBugTracker">ensureBugTracker</h5><div> <p>Make sure that there is a bugtracker for the given base url.</p> <p>If not, create one using the given attributes.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>ensureBugTracker</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>base_url</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Location</p> <p>The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.</p> </div></td></tr><tr><td><p><strong>bug_tracker_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Bugzilla</tt></li><li><tt>Debbugs</tt></li><li><tt>Roundup</tt></li><li><tt>Trac</tt></li><li><tt>SourceForge or SourceForge derivative</tt></li><li><tt>Mantis</tt></li><li><tt>Request Tracker (RT)</tt></li><li><tt>Email Address</tt></li><li><tt>Savane</tt></li><li><tt>PHP Project Bugtracker</tt></li><li><tt>Google Code</tt></li><li><tt>GitHub Issues</tt></li><li><tt>GitLab Issues</tt></li></ul></td><td><p> Bug Tracker Type </p></td></tr><tr><td><p><strong>contact_details</strong></p></td><td><p></p></td><td><div> <p>Contact details</p> <p>The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p></p></td><td><div> <p>Name</p> <p>A URL-friendly name for the bug tracker, such as "mozilla-bugs".</p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p></p></td><td><div> <p>Summary</p> <p>A brief introduction or overview of this bug tracker instance.</p> </div></td></tr><tr><td><p><strong>title</strong></p></td><td><p></p></td><td><div> <p>Title</p> <p>A descriptive label for this tracker to show in listings.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_tracker">bug_tracker</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="bugs" title="bugs" class="top-level-object"> <h3>bugs</h3> <p> Application root for malone. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#bug">bug</a> collection.</dd> </dl> </div> <div id="bugs-custom-GETs" title="bugs-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="bugs-getBugData" title="bugs-getBugData">getBugData</h5> <div> <p>Search bugtasks matching the specified criteria.</p> <p>The only criteria currently supported is to search for a bugtask with the specified bug id.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBugData</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>bug_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Bug ID </p> </td> </tr> <tr> <td> <p> <strong>related_bug</strong> </p> </td> <td><p></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">a list of matching bugs represented as json data</td> </p> </div> <div class="method"><h5 id="bugs-searchTasks" title="bugs-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <div id="bugs-custom-POSTs" title="bugs-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="bugs-createBug" title="bugs-createBug">createBug</h5><div> <p>Create a bug (with an appropriate bugtask) and return it.</p> <p>Things to note when using this factory:</p> <blockquote> <ul class="rst-simple"> <li>The reporter will be subscribed to the bug.</li> <li>Only people that the project shares with will see the bug when the bug's information type is Proprietary, Private, or Private Security.</li> </ul> </blockquote> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createBug</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>description</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Description</p> <p>A detailed description of the problem, including the steps required to reproduce it.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information Type</p> <p>The type of information contained in this bug report.</p> </div></td></tr><tr><td><p><strong>private</strong></p></td><td><p></p></td><td><div> <p>This bug report should be private</p> <p>Private bug reports are visible only to their subscribers.</p> </div></td></tr><tr><td><p><strong>security_related</strong></p></td><td><p></p></td><td><p> This bug is a security vulnerability. </p></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>Space-separated keywords for classifying this bug report.</p> </div></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td><td><p> The project, distribution or source package that has this bug. </p></td></tr><tr><td><p><strong>title</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Summary</p> <p>A one-line summary of the problem.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug">bug</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="builders" title="builders" class="top-level-object"> <h3>builders</h3> <div> <p>Collections of builders.</p> <p>IBuilderSet provides access to all Builders in the system, and also acts as a Factory to allow the creation of new Builders. Methods on this interface should deal with the set of Builders: methods that affect a single Builder should be on IBuilder.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/builders</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#builder">builder</a> collection.</dd> </dl> </div> <div id="builders-custom-GETs" title="builders-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="builders-getBuildQueueSizes" title="builders-getBuildQueueSizes">getBuildQueueSizes</h5> <div> <p>Return the number of pending builds for each processor.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBuildQueueSizes</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body"><p class="rst-first">a dict of tuples with the queue size and duration for each processor and virtualisation. For example:</p> <pre class="rst-literal-block"> { 'virt': { '386': (1, datetime.timedelta(0, 60)), 'amd64': (2, datetime.timedelta(0, 30)), }, 'nonvirt':... } </pre> <p class="rst-last">The tuple contains the size of the queue, as an integer, and the sum of the jobs 'estimated_duration' in queue, as a timedelta or None for empty queues.</p> </td> </p> </div> <div class="method"><h5 id="builders-getBuildersForQueue" title="builders-getBuildersForQueue">getBuildersForQueue</h5><p> Return all builders with the given properties. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildersForQueue</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>processor</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#processor">processor</a>. </td><td><p> Processor </p></td></tr><tr><td><p><strong>virtualized</strong></p></td><td><p></p></td><td><p> Virtualized </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#builder">builder</a> collection. </p> </div> <div class="method"><h5 id="builders-getByName" title="builders-getByName">getByName</h5><p> Retrieve a builder by name </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Builder name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#builder">builder</a>. </p> </div> </div> <div id="builders-custom-POSTs" title="builders-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="builders-new" title="builders-new">new</h5><div> <p>Create a new builder.</p> <p>The builder will be set to manual. An admin needs to verify its configuration and set it to automatic before jobs will be dispatched.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Publicly Visible</p> <p>Whether or not to present the builder publicly.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>The builder name used for reference purposes</p> </div></td></tr><tr><td><p><strong>open_resources</strong></p></td><td><p></p></td><td><div> <p>Open resources</p> <p>Resource tags offered by this builder, that can be required by a build and if required must match.</p> </div></td></tr><tr><td><p><strong>processors</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Processors</p> <p>Processors identifying jobs which can be built by this device.</p> </div></td></tr><tr><td><p><strong>restricted_resources</strong></p></td><td><p></p></td><td><div> <p>Restricted resources</p> <p>Resource tags offered by this builder, indicating that the builder may only be used by builds that explicitly require these tags.</p> </div></td></tr><tr><td><p><strong>title</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Title</p> <p>The builder title. Should be just a few words.</p> </div></td></tr><tr><td><p><strong>url</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>URL</p> <p>The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: <a class="rst-reference external" href="http://farm.com:8221/" target="_top">http://farm.com:8221/</a></p> </div></td></tr><tr><td><p><strong>virtualized</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Virtualized</p> <p>Whether or not the builder is a virtual Xen instance.</p> </div></td></tr><tr><td><p><strong>vm_host</strong></p></td><td><p></p></td><td><div> <p>VM host</p> <p>The machine hostname hosting the virtual buildd-worker, e.g.: foobar-host.ppa</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#builder">builder</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="charm_bases" title="charm_bases" class="top-level-object"> <h3>charm_bases</h3> <p> Interface representing the set of bases for charms. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+charm-bases</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#charm_base">charm_base</a> collection.</dd> </dl> </div> <div id="charm_bases-custom-GETs" title="charm_bases-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="charm_bases-getByDistroSeries" title="charm_bases-getByDistroSeries">getByDistroSeries</h5><div> <p>Return the ICharmBase for this distro series.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByDistroSeries</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#charm_base">charm_base</a>. </p> </div> </div> <div id="charm_bases-custom-POSTs" title="charm_bases-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="charm_bases-new" title="charm_bases-new">new</h5><p> Create an ICharmBase. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>build_snap_channels</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building charm recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr><tr><td><p><strong>processors</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#charm_base">charm_base</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="charm_recipes" title="charm_recipes" class="top-level-object"> <h3>charm_recipes</h3> <p> A utility to create and access charm recipes. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+charm-recipes</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#charm_recipe">charm_recipe</a> collection.</dd> </dl> </div> <div id="charm_recipes-custom-GETs" title="charm_recipes-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="charm_recipes-findByOwner" title="charm_recipes-findByOwner">findByOwner</h5><p> Return all charm recipes with the given owner. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByOwner</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#charm_recipe">charm_recipe</a> collection. </p> </div> <div class="method"><h5 id="charm_recipes-getByName" title="charm_recipes-getByName">getByName</h5><p> Returns the appropriate ICharmRecipe for the given objects. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Recipe name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> Project </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#charm_recipe">charm_recipe</a>. </p> </div> </div> <div id="charm_recipes-custom-POSTs" title="charm_recipes-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="charm_recipes-new" title="charm_recipes-new">new</h5><p> Create an ICharmRecipe. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>auto_build</strong></p></td><td><p></p></td><td><div> <p>Automatically build when branch changes</p> <p>Whether this charm recipe is built automatically when its branch changes.</p> </div></td></tr><tr><td><p><strong>auto_build_channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this charm recipe. Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'</p> </div></td></tr><tr><td><p><strong>build_path</strong></p></td><td><p></p></td><td><div> <p>Build path</p> <p>Subdirectory within the branch containing metadata.yaml.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>A description of the charm recipe.</p> </div></td></tr><tr><td><p><strong>git_ref</strong></p></td><td><p></p> Link to a <a href="#git_ref">git_ref</a>. </td><td><div> <p>Git branch</p> <p>The Git branch containing a charm recipe.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information type</p> <p>The type of information contained in this charm recipe.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Charm recipe name</p> <p>The name of the charm recipe.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this charm recipe.</p> </div></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> The project that this charm recipe is associated with </p></td></tr><tr><td><p><strong>store_channels</strong></p></td><td><p></p></td><td><div> <p>Store channels</p> <p>Channels to release this charm to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div></td></tr><tr><td><p><strong>store_name</strong></p></td><td><p></p></td><td><div> <p>Registered store name</p> <p>The registered name of this charm in the store.</p> </div></td></tr><tr><td><p><strong>store_upload</strong></p></td><td><p></p></td><td><div> <p>Automatically upload to store</p> <p>Whether builds of this charm recipe are automatically uploaded to the store.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#charm_recipe">charm_recipe</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="countries" title="countries" class="top-level-object"> <h3>countries</h3> <p> A container for countries. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/countries</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#country">country</a> collection.</dd> </dl> </div> <div id="countries-custom-GETs" title="countries-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="countries-getByCode" title="countries-getByCode">getByCode</h5><p> Return a country by its code. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByCode</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>code</strong></p></td><td><p><small>(required)</small></p></td><td><p> Code </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#country">country</a>. </p> </div> <div class="method"><h5 id="countries-getByName" title="countries-getByName">getByName</h5><p> Return a country by its name. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#country">country</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="craft_recipes" title="craft_recipes" class="top-level-object"> <h3>craft_recipes</h3> <p> A utility to create and access craft recipes. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/craft_recipes</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#craft_recipe">craft_recipe</a> collection.</dd> </dl> </div> <div id="craft_recipes-custom-GETs" title="craft_recipes-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="craft_recipes-findByOwner" title="craft_recipes-findByOwner">findByOwner</h5><p> Return all craft recipes for the given owner. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByOwner</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#craft_recipe">craft_recipe</a> collection. </p> </div> <div class="method"><h5 id="craft_recipes-getByName" title="craft_recipes-getByName">getByName</h5><p> Returns the appropriate ICraftRecipe for the given objects. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Recipe name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> Project </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#craft_recipe">craft_recipe</a>. </p> </div> </div> <div id="craft_recipes-custom-POSTs" title="craft_recipes-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="craft_recipes-new" title="craft_recipes-new">new</h5><p> Create an ICraftRecipe. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>auto_build</strong></p></td><td><p></p></td><td><div> <p>Automatically build when branch changes</p> <p>Whether this craft recipe is built automatically when the branch containing its craft.yaml recipe changes.</p> </div></td></tr><tr><td><p><strong>auto_build_channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this craft recipe. Currently only 'core', 'core18', 'core20', and 'sourcecraft' keys are supported.</p> </div></td></tr><tr><td><p><strong>build_path</strong></p></td><td><p></p></td><td><div> <p>Build path</p> <p>Subdirectory within the branch containing craft.yaml.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>A description of the craft recipe.</p> </div></td></tr><tr><td><p><strong>git_path</strong></p></td><td><p></p></td><td><div> <p>Git branch path</p> <p>The path of the Git branch containing a sourcecraft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_ref</strong></p></td><td><p></p> Link to a <a href="#git_ref">git_ref</a>. </td><td><div> <p>Git branch</p> <p>The Git branch containing a craft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_repository</strong></p></td><td><p></p> Link to a <a href="#git_repository">git_repository</a>. </td><td><div> <p>Git repository</p> <p>A Git repository with a branch containing a sourcecraft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_repository_url</strong></p></td><td><p></p></td><td><div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a sourcecraft.yaml at the top level.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information type</p> <p>The type of information contained in this craft recipe.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Craft recipe name</p> <p>The name of the craft recipe.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this craft recipe.</p> </div></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> The project that this craft recipe is associated with </p></td></tr><tr><td><p><strong>store_channels</strong></p></td><td><p></p></td><td><div> <p>Store channels</p> <p>Channels to release this craft to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div></td></tr><tr><td><p><strong>store_name</strong></p></td><td><p></p></td><td><div> <p>Registered store name</p> <p>The registered name of this craft in the store.</p> </div></td></tr><tr><td><p><strong>store_upload</strong></p></td><td><p></p></td><td><div> <p>Automatically upload to store</p> <p>Whether builds of this craft recipe are automatically uploaded to the store.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#craft_recipe">craft_recipe</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="cves" title="cves" class="top-level-object"> <h3>cves</h3> <p> The set of ICve objects. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/cves</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#cve">cve</a> collection.</dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="distributions" title="distributions" class="top-level-object"> <h3>distributions</h3> <p> Interface for DistrosSet </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/distributions</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#distribution">distribution</a> collection.</dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="git_repositories" title="git_repositories" class="top-level-object"> <h3>git_repositories</h3> <p> Interface representing the set of Git repositories. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+git</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#git_repository">git_repository</a> collection.</dd> </dl> </div> <div id="git_repositories-custom-GETs" title="git_repositories-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="git_repositories-countRepositoriesForRepack" title="git_repositories-countRepositoriesForRepack">countRepositoriesForRepack</h5> <div> <p>Get number of repositories qualifying for a repack.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>countRepositoriesForRepack</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The number of IGitRepository objects qualifying for a repack.</td> </p> </div> <div class="method"><h5 id="git_repositories-getByID" title="git_repositories-getByID">getByID</h5><div> <p>Find a repository by its ID.</p> <p>Return None if no match was found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByID</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>id</strong></p></td><td><p><small>(required)</small></p></td><td><p> Repository ID </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"><h5 id="git_repositories-getByPath" title="git_repositories-getByPath">getByPath</h5><div> <p>Find a repository by its path.</p> <p>Any of these forms may be used:</p> <pre class="rst-literal-block"> Unique names: ~OWNER/PROJECT/+git/NAME ~OWNER/DISTRO/+source/SOURCE/+git/NAME ~OWNER/+git/NAME Owner-target default aliases: ~OWNER/PROJECT ~OWNER/DISTRO/+source/SOURCE Official aliases: PROJECT DISTRO/+source/SOURCE </pre> <p>Return None if no match was found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByPath</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>path</strong></p></td><td><p><small>(required)</small></p></td><td><p> Repository path </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"><h5 id="git_repositories-getDefaultRepository" title="git_repositories-getDefaultRepository">getDefaultRepository</h5><div> <p>Get the default repository for a target.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDefaultRepository</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#git_target">git_target</a>. </td><td><p> Target </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"><h5 id="git_repositories-getDefaultRepositoryForOwner" title="git_repositories-getDefaultRepositoryForOwner">getDefaultRepositoryForOwner</h5><div> <p>Get a person's default repository for a target.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDefaultRepositoryForOwner</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#git_target">git_target</a>. </td><td><p> Target </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"><h5 id="git_repositories-getRepositories" title="git_repositories-getRepositories">getRepositories</h5><div> <p>Get all repositories for a target.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRepositories</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>modified_since_date</strong></p></td><td><p></p></td><td><div> <p>Modified since date</p> <p>Return only repositories whose date_last_modified is greater than or equal to this date.</p> </div></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by most interesting</tt></li><li><tt>by repository name</tt></li><li><tt>most recently changed first</tt></li><li><tt>most neglected first</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li></ul></td><td><p> Sort order </p></td></tr><tr><td><p><strong>target</strong></p></td><td><p></p> Link to a <a href="#git_target">git_target</a>. </td><td><p> Target </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a> collection. </p> </div> <div class="method"> <h5 id="git_repositories-getRepositoriesForRepack" title="git_repositories-getRepositoriesForRepack">getRepositoriesForRepack</h5> <div> <p>Get the top badly packed repositories.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getRepositoriesForRepack</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>limit</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A list of the worst badly packed repositories.</td> </p> </div> <div class="method"> <h5 id="git_repositories-getRepositoryVisibilityInfo" title="git_repositories-getRepositoryVisibilityInfo">getRepositoryVisibilityInfo</h5> <div> <p>Return the named repositories visible to both user and person.</p> <p>Anonymous requesters don't get any information.</p> <p>Return a dict with the following values: person_name: the displayname of the person. visible_repositories: a list of the unique names of the repositories which the requester and specified person can both see.</p> <p>This API call is provided for use by the client Javascript. It is not designed to efficiently scale to handle requests for large numbers of repositories.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getRepositoryVisibilityInfo</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person whose repository visibility is being checked. </p> </td> </tr> <tr> <td> <p> <strong>repository_names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> List of repository unique names </p> </td> </tr> </table> </div> </div> <div id="git_repositories-custom-POSTs" title="git_repositories-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="git_repositories-new" title="git_repositories-new">new</h5><div> <p>Create a Git repository and return it.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information type</p> <p>The type of information contained in this repository.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>The repository name. Keep very short, unique, and descriptive, because it will be used in URLs.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this Git repository. This controls who can modify the repository.</p> </div></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#git_target">git_target</a>. </td><td><div> <p>Target</p> <p>The target of the repository.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"> <h5 id="git_repositories-setDefaultRepository" title="git_repositories-setDefaultRepository">setDefaultRepository</h5> <div> <p>Set the default repository for a target.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setDefaultRepository</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>repository</strong> </p> </td> <td><p></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> Git repository </p> </td> </tr> <tr> <td> <p> <strong>target</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#git_target">git_target</a>. </td> <td> <p> Target </p> </td> </tr> </table> </div> <div class="method"> <h5 id="git_repositories-setDefaultRepositoryForOwner" title="git_repositories-setDefaultRepositoryForOwner">setDefaultRepositoryForOwner</h5> <div> <p>Set a person's default repository for a target.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setDefaultRepositoryForOwner</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>owner</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>repository</strong> </p> </td> <td><p></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> Git repository </p> </td> </tr> <tr> <td> <p> <strong>target</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#git_target">git_target</a>. </td> <td> <p> Target </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="languages" title="languages" class="top-level-object"> <h3>languages</h3> <div> <p>The collection of languages.</p> <p>The standard get method will return only the visible languages. If you want to access all languages known to Launchpad, use the getAllLanguages method.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/languages</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#language">language</a> collection.</dd> </dl> </div> <div id="languages-custom-GETs" title="languages-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="languages-getAllLanguages" title="languages-getAllLanguages">getAllLanguages</h5><p> Return a result set of all ILanguages from Launchpad. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAllLanguages</var></p></td><td><p>The name of the operation being invoked.</p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#language">language</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="livefses" title="livefses" class="top-level-object"> <h3>livefses</h3> <p> A utility to create and access live filesystems. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/livefses</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#livefs">livefs</a> collection.</dd> </dl> </div> <div id="livefses-custom-GETs" title="livefses-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="livefses-getByName" title="livefses-getByName">getByName</h5><p> Return the appropriate ILiveFS for the given objects. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distroseries </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Live filesystem name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#livefs">livefs</a>. </p> </div> </div> <div id="livefses-custom-POSTs" title="livefses-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="livefses-new" title="livefses-new">new</h5><p> Create an ILiveFS. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distro Series</p> <p>The series for which the image should be built.</p> </div></td></tr><tr><td><p><strong>metadata</strong></p></td><td><p><small>(required)</small></p></td><td><p> A dict of data about the image. Entries here will be passed to the builder. </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>The name of the live filesystem image.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this live filesystem image.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#livefs">livefs</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="packagesets" title="packagesets" class="top-level-object"> <h3>packagesets</h3> <p> An interface for multiple package sets. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/packagesets</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#packageset">packageset</a> collection.</dd> </dl> </div> <div id="packagesets-custom-GETs" title="packagesets-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="packagesets-getByName" title="packagesets-getByName">getByName</h5><div> <p>Return the single package set with the given name (if any).</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distribution series</p> <p>The distroseries to which this package set is related.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Valid package set name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a>. </p> </div> <div class="method"><h5 id="packagesets-getBySeries" title="packagesets-getBySeries">getBySeries</h5><div> <p>Return the package sets associated with the given distroseries.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBySeries</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distribution series</p> <p>The distroseries to which this package set is related.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a> collection. </p> </div> <div class="method"><h5 id="packagesets-setsIncludingSource" title="packagesets-setsIncludingSource">setsIncludingSource</h5><div> <p>Get the package sets that include this source package.</p> <p>Return all package sets that directly or indirectly include the given source package name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>setsIncludingSource</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>direct_inclusion</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distribution series</p> <p>The distroseries to which this package set is related.</p> </div></td></tr><tr><td><p><strong>sourcepackagename</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a> collection. </p> </div> </div> <div id="packagesets-custom-POSTs" title="packagesets-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="packagesets-new" title="packagesets-new">new</h5><div> <p>Create a new package set.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>description</strong></p></td><td><p><small>(required)</small></p></td><td><p> Package set description </p></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distroseries</p> <p>The distribution series to which the packageset is related.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Valid package set name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Person</p> <p>The person who owns this package set.</p> </div></td></tr><tr><td><p><strong>related_set</strong></p></td><td><p></p> Link to a <a href="#packageset">packageset</a>. </td><td><div> <p>Related package set</p> <p>The new package set will share the package set group with this one.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#packageset">packageset</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="people" title="people" class="top-level-object"> <h3>people</h3> <p> Combined schema for operations on a group of Persons. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/people</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#person">person</a> collection.</dd> </dl> </div> <div id="people-custom-GETs" title="people-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="people-find" title="people-find">find</h5><div> <p>Return all non-merged Persons and Teams whose name, displayname or email address match <text>.</p> <p>The results will be ordered using the default ordering specified in Person._defaultOrder.</p> <p>While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>find</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>text</strong></p></td><td><p><small>(required)</small></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="people-findPerson" title="people-findPerson">findPerson</h5><div> <p>Return all non-merged Persons with at least one email address whose name, displayname or email address match <text>.</p> <p>If text is an empty string, all persons with at least one email address will be returned.</p> <p>The results will be ordered using the default ordering specified in Person._defaultOrder.</p> <p>If exclude_inactive_accounts is True, any accounts whose account_status is any of INACTIVE_ACCOUNT_STATUSES will not be in the returned set.</p> <p>If must_have_email is True, only people with one or more email addresses are returned.</p> <p>While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.</p> <p>If created_before or created_after are not None, they are used to restrict the search to the dates provided.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findPerson</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>created_after</strong></p></td><td><p></p></td><td><p> Created after </p></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Created before </p></td></tr><tr><td><p><strong>text</strong></p></td><td><p><small>(required)</small></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="people-findTeam" title="people-findTeam">findTeam</h5><div> <p>Return all Teams whose name, displayname or email address match <text>.</p> <p>The results will be ordered using the default ordering specified in Person._defaultOrder.</p> <p>While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findTeam</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>text</strong></p></td><td><p><small>(required)</small></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="people-getByEmail" title="people-getByEmail">getByEmail</h5><div> <p>Return the person with the given email address.</p> <p>Return None if there is no person with the given email address.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByEmail</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>email</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a>. </p> </div> <div class="method"><h5 id="people-getByOpenIDIdentifier" title="people-getByOpenIDIdentifier">getByOpenIDIdentifier</h5><div> <p>Get the person for a given OpenID identifier.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByOpenIDIdentifier</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>identifier</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a>. </p> </div> <div class="method"> <h5 id="people-getSSHKeysForSSO" title="people-getSSHKeysForSSO">getSSHKeysForSSO</h5> <div> <p>Restricted SSH key creation API for SSO.</p> <p>This method can only be called by the Ubuntu SSO service. It finds and returns all the SSH keys belonging to the account identified by the openid_identifier parameter.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSSHKeysForSSO</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>openid_identifier</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> OpenID identifier suffix </p> </td> </tr> </table> </div> <div class="method"> <h5 id="people-getUserData" title="people-getUserData">getUserData</h5> <p> Get GDPR-related data for a user from their email address. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getUserData</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>email</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="people-getUsernameForSSO" title="people-getUsernameForSSO">getUsernameForSSO</h5> <div> <p>Restricted person creation API for SSO.</p> <p>This method can only be called by the Ubuntu SSO service. It finds the username for an account by OpenID identifier.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getUsernameForSSO</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>openid_identifier</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> OpenID identifier suffix </p> </td> </tr> </table> </div> </div> <div id="people-custom-POSTs" title="people-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="people-addSSHKeyFromSSO" title="people-addSSHKeyFromSSO">addSSHKeyFromSSO</h5> <div> <p>Restricted SSH key creation API for SSO.</p> <p>This method can only be called by the Ubuntu SSO service. It adds a new SSH key to the account identified by 'openid_identifier' based on the 'key_text' parameter.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addSSHKeyFromSSO</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>dry_run</strong> </p> </td> <td> <p></p> </td> <td> <p> Don't save changes </p> </td> </tr> <tr> <td> <p> <strong>key_text</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> SSH key text </p> </td> </tr> <tr> <td> <p> <strong>openid_identifier</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> OpenID identifier suffix </p> </td> </tr> </table> </div> <div class="method"> <h5 id="people-deleteSSHKeyFromSSO" title="people-deleteSSHKeyFromSSO">deleteSSHKeyFromSSO</h5> <div> <p>Restricted SSH key deletion API for SSO.</p> <p>This method can only be called by the Ubuntu SSO service. It deletes an SSH key from the account identified by 'openid_identifier' based on the 'key_text' parameter.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteSSHKeyFromSSO</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>dry_run</strong> </p> </td> <td> <p></p> </td> <td> <p> Don't save changes </p> </td> </tr> <tr> <td> <p> <strong>key_text</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> SSH key text </p> </td> </tr> <tr> <td> <p> <strong>openid_identifier</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> OpenID identifier suffix </p> </td> </tr> </table> </div> <div class="method"><h5 id="people-getOrCreateSoftwareCenterCustomer" title="people-getOrCreateSoftwareCenterCustomer">getOrCreateSoftwareCenterCustomer</h5><div> <p>Restricted person creation API for Software Center Agent.</p> <p>This method can only be called by Software Center Agent. It gets a person by OpenID identifier or creates a new Launchpad person from the OpenID identifier, email address and display name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOrCreateSoftwareCenterCustomer</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>display_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Display name </p></td></tr><tr><td><p><strong>email_address</strong></p></td><td><p><small>(required)</small></p></td><td><p> Email address </p></td></tr><tr><td><p><strong>openid_identifier</strong></p></td><td><p><small>(required)</small></p></td><td><p> OpenID identifier suffix </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a>. </p> </div> <div class="method"><h5 id="people-newTeam" title="people-newTeam">newTeam</h5><p> Create and return a new Team with given arguments. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newTeam</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>default_membership_period</strong></p></td><td><p></p></td><td><div> <p>Subscription period</p> <p>Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.</p> </div></td></tr><tr><td><p><strong>default_renewal_period</strong></p></td><td><p></p></td><td><div> <p>Self renewal period</p> <p>Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).</p> </div></td></tr><tr><td><p><strong>display_name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Display Name</p> <p>Your name as you would like it displayed throughout Launchpad. Most people use their full name here.</p> </div></td></tr><tr><td><p><strong>membership_policy</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Open Team</tt></li><li><tt>Delegated Team</tt></li><li><tt>Moderated Team</tt></li><li><tt>Restricted Team</tt></li></ul></td><td><p> Membership policy </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> </div></td></tr><tr><td><p><strong>subscription_policy</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Open Team</tt></li><li><tt>Delegated Team</tt></li><li><tt>Moderated Team</tt></li><li><tt>Restricted Team</tt></li></ul></td><td><div> <p>Membership policy</p> <p>Obsolete: use membership_policy</p> </div></td></tr><tr><td><p><strong>team_description</strong></p></td><td><p></p></td><td><div> <p>Team Description</p> <p>Obsolete. Use description.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#team">team</a>. </p> </div> <div class="method"> <h5 id="people-setUsernameFromSSO" title="people-setUsernameFromSSO">setUsernameFromSSO</h5> <div> <p>Restricted person creation API for SSO.</p> <p>This method can only be called by the Ubuntu SSO service. It reserves a username for an account by OpenID identifier, as long as the user has no Launchpad account.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setUsernameFromSSO</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>dry_run</strong> </p> </td> <td> <p></p> </td> <td> <p> Don't save changes </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Name</p> <p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> </div> </td> </tr> <tr> <td> <p> <strong>openid_identifier</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> OpenID identifier suffix </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="polls" title="polls" class="top-level-object"> <h3>polls</h3> <p> The set of Poll objects. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+polls</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#poll">poll</a> collection.</dd> </dl> </div> <div id="polls-custom-GETs" title="polls-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="polls-find" title="polls-find">find</h5><div> <p>Search for polls.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>find</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>oldest first</tt></li><li><tt>newest first</tt></li><li><tt>by opening date</tt></li><li><tt>by closing date</tt></li></ul></td><td><p> Sort order </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Poll statuses</p> <p>A list of one or more of 'open', 'closed', or 'not-yet-opened'. Defaults to all statuses.</p> </div></td></tr><tr><td><p><strong>team</strong></p></td><td><p></p> Link to a <a href="#team">team</a>. </td><td><p> Team </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#poll">poll</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="processors" title="processors" class="top-level-object"> <h3>processors</h3> <p> Operations related to Processor instances. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/processors</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#processor">processor</a> collection.</dd> </dl> </div> <div id="processors-custom-GETs" title="processors-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="processors-getByName" title="processors-getByName">getByName</h5><div> <p>Return the IProcessor instance with the matching name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#processor">processor</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="project_groups" title="project_groups" class="top-level-object"> <h3>project_groups</h3> <p> The collection of projects. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/project_groups</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#project_group">project_group</a> collection.</dd> </dl> </div> <div id="project_groups-custom-GETs" title="project_groups-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="project_groups-search" title="project_groups-search">search</h5><p> Search through the Registry database for projects that match the query terms. text is a piece of text in the title / summary / description fields of project (and possibly product). soyuz, bazaar, malone etc are hints as to whether the search should be limited to projects that are active in those Launchpad applications. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>search</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project_group">project_group</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="projects" title="projects" class="top-level-object"> <h3>projects</h3> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/projects</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#project">project</a> collection.</dd> </dl> </div> <div id="projects-custom-GETs" title="projects-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="projects-latest" title="projects-latest">latest</h5><div> <p>Return the latest projects registered in Launchpad.</p> <p>The supplied user determines which objects are visible.</p> <p>If the quantity is not specified or is a value that is not 'None' then the set of projects returned is limited to that value (the default quantity is 5). If quantity is 'None' then all projects are returned. For the web service it is not possible to specify the quantity, so all projects are returned, latest first.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>latest</var></p></td><td><p>The name of the operation being invoked.</p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> <div class="method"><h5 id="projects-licensing_search" title="projects-licensing_search">licensing_search</h5><p> Return an iterator over products that need to be reviewed. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>licensing_search</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><p> Is the project active </p></td></tr><tr><td><p><strong>created_after</strong></p></td><td><p></p></td><td><p> Created after date </p></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Created before date </p></td></tr><tr><td><p><strong>has_subscription</strong></p></td><td><p></p></td><td><p> Has a commercial subscription </p></td></tr><tr><td><p><strong>licenses</strong></p></td><td><p></p></td><td><p> Licenses </p></td></tr><tr><td><p><strong>project_reviewed</strong></p></td><td><p></p></td><td><p> Is the project licence reviewed </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>subscription_expires_after</strong></p></td><td><p></p></td><td><p> Subscription expires after </p></td></tr><tr><td><p><strong>subscription_expires_before</strong></p></td><td><p></p></td><td><p> Subscription expired before </p></td></tr><tr><td><p><strong>subscription_modified_after</strong></p></td><td><p></p></td><td><p> Subscription modified after </p></td></tr><tr><td><p><strong>subscription_modified_before</strong></p></td><td><p></p></td><td><p> Subscription modified before </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> <div class="method"><h5 id="projects-search" title="projects-search">search</h5><div> <p>Search through the Registry database for products that match the query terms. text is a piece of text in the title / summary / description fields of product.</p> <p>This call eager loads data appropriate for web API; caution may be needed for other callers.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>search</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> </div> <div id="projects-custom-POSTs" title="projects-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="projects-new_project" title="projects-new_project">new_project</h5><div> <p>Create and return a brand new Product.</p> <p>See IProduct for a description of the parameters.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new_project</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Bug Supervisor</p> <p>The Launchpad id of the person or team (preferred) responsible for bug management.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> </div></td></tr><tr><td><p><strong>display_name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Display Name</p> <p>The name of the project as it would appear in a paragraph.</p> </div></td></tr><tr><td><p><strong>download_url</strong></p></td><td><p></p></td><td><div> <p>Download URL</p> <p>The full URL where downloads for this project are located, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div></td></tr><tr><td><p><strong>driver</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Driver</p> <p>This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.</p> </div></td></tr><tr><td><p><strong>freshmeat_project</strong></p></td><td><p></p></td><td><div> <p>Freshmeat Project</p> <p>The Freshmeat project name for this project, if it is in freshmeat. [DEPRECATED]</p> </div></td></tr><tr><td><p><strong>home_page_url</strong></p></td><td><p></p></td><td><div> <p>Homepage URL</p> <p>The project home page. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div></td></tr><tr><td><p><strong>license_info</strong></p></td><td><p></p></td><td><div> <p>Description of additional licences</p> <p>Description of licences that do not appear in the list above.</p> </div></td></tr><tr><td><p><strong>licenses</strong></p></td><td><p></p></td><td><p> Licences </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.</p> </div></td></tr><tr><td><p><strong>programming_lang</strong></p></td><td><p></p></td><td><div> <p>Programming Languages</p> <p>A comma delimited list of programming languages used for this project.</p> </div></td></tr><tr><td><p><strong>project_group</strong></p></td><td><p></p> Link to a <a href="#project_group">project_group</a>. </td><td><div> <p>Part of</p> <p>Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.</p> </div></td></tr><tr><td><p><strong>project_reviewed</strong></p></td><td><p></p></td><td><div> <p>Project reviewed</p> <p>Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.</p> </div></td></tr><tr><td><p><strong>registrant</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Registrant</p> <p>This person registered the project in Launchpad.</p> </div></td></tr><tr><td><p><strong>screenshots_url</strong></p></td><td><p></p></td><td><div> <p>Screenshots URL</p> <p>The full URL for screenshots of this project, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div></td></tr><tr><td><p><strong>sourceforge_project</strong></p></td><td><p></p></td><td><div> <p>Sourceforge Project</p> <p>The SourceForge project name for this project, if it is in sourceforge.</p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Summary</p> <p>A short paragraph to introduce the project's work.</p> </div></td></tr><tr><td><p><strong>title</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Title</p> <p>The project title. Should be just a few words.</p> </div></td></tr><tr><td><p><strong>wiki_url</strong></p></td><td><p></p></td><td><div> <p>Wiki URL</p> <p>The full URL of this project's wiki, if it has one. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#project">project</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="questions" title="questions" class="top-level-object"> <h3>questions</h3> <p> A utility that contain all the questions published in Launchpad. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/questions</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#question">question</a> collection.</dd> </dl> </div> <div id="questions-custom-GETs" title="questions-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="questions-getByID" title="questions-getByID">getByID</h5><div> <p>Return the question with the given id.</p> <p>Return :default: if no such question exists.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByID</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>question_id</strong></p></td><td><p><small>(required)</small></p></td><td><p> The id of the question to get </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a>. </p> </div> <div class="method"><h5 id="questions-searchQuestions" title="questions-searchQuestions">searchQuestions</h5><div> <p>Return the questions from the collection matching search criteria.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="rock_bases" title="rock_bases" class="top-level-object"> <h3>rock_bases</h3> <p> Interface representing the set of bases for rocks. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/rock_bases</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#rock_base">rock_base</a> collection.</dd> </dl> </div> <div id="rock_bases-custom-GETs" title="rock_bases-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="rock_bases-getByDistroSeries" title="rock_bases-getByDistroSeries">getByDistroSeries</h5><div> <p>Return the IRockBase for this distro series.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByDistroSeries</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#rock_base">rock_base</a>. </p> </div> </div> <div id="rock_bases-custom-POSTs" title="rock_bases-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="rock_bases-new" title="rock_bases-new">new</h5><p> Create an IRockBase. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>build_channels</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building rock recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr><tr><td><p><strong>processors</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#rock_base">rock_base</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="rock_recipes" title="rock_recipes" class="top-level-object"> <h3>rock_recipes</h3> <p> A utility to create and access rock recipes. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+rock-recipes</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#rock_recipe">rock_recipe</a> collection.</dd> </dl> </div> <div id="rock_recipes-custom-GETs" title="rock_recipes-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="rock_recipes-findByOwner" title="rock_recipes-findByOwner">findByOwner</h5><p> Return all rock recipes with the given owner. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByOwner</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#rock_recipe">rock_recipe</a> collection. </p> </div> <div class="method"><h5 id="rock_recipes-getByName" title="rock_recipes-getByName">getByName</h5><p> Returns the appropriate IRockRecipe for the given objects. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Recipe name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> Project </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#rock_recipe">rock_recipe</a>. </p> </div> </div> <div id="rock_recipes-custom-POSTs" title="rock_recipes-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="rock_recipes-new" title="rock_recipes-new">new</h5><p> Create an IRockRecipe. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>auto_build</strong></p></td><td><p></p></td><td><div> <p>Automatically build when branch changes</p> <p>Whether this rock recipe is built automatically when the branch containing its rockcraft.yaml recipe changes.</p> </div></td></tr><tr><td><p><strong>auto_build_channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this rock recipe. Currently only 'core', 'core18', 'core20', and 'rockcraft' keys are supported.</p> </div></td></tr><tr><td><p><strong>build_path</strong></p></td><td><p></p></td><td><div> <p>Build path</p> <p>Subdirectory within the branch containing rockcraft.yaml.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>A description of the rock recipe.</p> </div></td></tr><tr><td><p><strong>git_path</strong></p></td><td><p></p></td><td><div> <p>Git branch path</p> <p>The path of the Git branch containing a rockcraft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_ref</strong></p></td><td><p></p> Link to a <a href="#git_ref">git_ref</a>. </td><td><div> <p>Git branch</p> <p>The Git branch containing a rockcraft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_repository</strong></p></td><td><p></p> Link to a <a href="#git_repository">git_repository</a>. </td><td><div> <p>Git repository</p> <p>A Git repository with a branch containing a rockcraft.yaml recipe.</p> </div></td></tr><tr><td><p><strong>git_repository_url</strong></p></td><td><p></p></td><td><div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a rockcraft.yaml at the top level.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information type</p> <p>The type of information contained in this rock recipe.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Rock recipe name</p> <p>The name of the rock recipe.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this rock recipe.</p> </div></td></tr><tr><td><p><strong>project</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#project">project</a>. </td><td><p> The project that this rock recipe is associated with </p></td></tr><tr><td><p><strong>store_channels</strong></p></td><td><p></p></td><td><div> <p>Store channels</p> <p>Channels to release this rock to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div></td></tr><tr><td><p><strong>store_name</strong></p></td><td><p></p></td><td><div> <p>Registered store name</p> <p>The registered name of this rock in the store.</p> </div></td></tr><tr><td><p><strong>store_upload</strong></p></td><td><p></p></td><td><div> <p>Automatically upload to store</p> <p>Whether builds of this rock recipe are automatically uploaded to the store.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#rock_recipe">rock_recipe</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="snap_bases" title="snap_bases" class="top-level-object"> <h3>snap_bases</h3> <p> Interface representing the set of bases for snaps. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+snap-bases</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#snap_base">snap_base</a> collection.</dd> </dl> </div> <div id="snap_bases-custom-GETs" title="snap_bases-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="snap_bases-getByName" title="snap_bases-getByName">getByName</h5><div> <p>Return the ISnapBase with this name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Base name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap_base">snap_base</a>. </p> </div> <div class="method"><h5 id="snap_bases-getDefault" title="snap_bases-getDefault">getDefault</h5><div> <p>Get the default base.</p> <p>This will be used to pick the default distro series for snaps that do not specify a base.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDefault</var></p></td><td><p>The name of the operation being invoked.</p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap_base">snap_base</a>. </p> </div> </div> <div id="snap_bases-custom-POSTs" title="snap_bases-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="snap_bases-new" title="snap_bases-new">new</h5><p> Create an ISnapBase. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>build_channels</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building snaps that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div></td></tr><tr><td><p><strong>display_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Display name </p></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr><tr><td><p><strong>features</strong></p></td><td><p></p></td><td><div> <p>Features supported by this base</p> <p>A dictionary designating the features supported by the base. Key is the name of a feature, value is a boolean indicating whether the feature is supported or not.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr><tr><td><p><strong>processors</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#snap_base">snap_base</a>. </p> </div> <div class="method"> <h5 id="snap_bases-setDefault" title="snap_bases-setDefault">setDefault</h5> <div> <p>Set the default base.</p> <p>This will be used to pick the default distro series for snaps that do not specify a base.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setDefault</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>snap_base</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#snap_base">snap_base</a>. </td> <td> <p> Base </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="snappy_serieses" title="snappy_serieses" class="top-level-object"> <h3>snappy_serieses</h3> <p> Interface representing the set of snappy series. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+snappy-series</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#snappy_series">snappy_series</a> collection.</dd> </dl> </div> <div id="snappy_serieses-custom-GETs" title="snappy_serieses-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="snappy_serieses-getByName" title="snappy_serieses-getByName">getByName</h5><div> <p>Return the ISnappySeries with this name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Snappy series name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snappy_series">snappy_series</a>. </p> </div> </div> <div id="snappy_serieses-custom-POSTs" title="snappy_serieses-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="snappy_serieses-new" title="snappy_serieses-new">new</h5><p> Create an ISnappySeries. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>display_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Display name </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Experimental</tt></li><li><tt>Active Development</tt></li><li><tt>Pre-release Freeze</tt></li><li><tt>Current Stable Release</tt></li><li><tt>Supported</tt></li><li><tt>Obsolete</tt></li><li><tt>Future</tt></li></ul></td><td><p> Status </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#snappy_series">snappy_series</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="snaps" title="snaps" class="top-level-object"> <h3>snaps</h3> <p> A utility to create and access snap packages. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+snaps</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#snap">snap</a> collection.</dd> </dl> </div> <div id="snaps-custom-GETs" title="snaps-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="snaps-findByOwner" title="snaps-findByOwner">findByOwner</h5><p> Return all snap packages with the given owner. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByOwner</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a> collection. </p> </div> <div class="method"><h5 id="snaps-findByStoreName" title="snaps-findByStoreName">findByStoreName</h5><div> <p>Return all snap packages with the given store package name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByStoreName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>store_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The registered store package name to search for. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a> collection. </p> </div> <div class="method"><h5 id="snaps-findByURL" title="snaps-findByURL">findByURL</h5><div> <p>Return all snap packages that build from the given URL.</p> <p>This currently only works for packages that build directly from a URL, rather than being linked to a Bazaar branch or Git repository hosted in Launchpad.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByURL</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>url</strong></p></td><td><p><small>(required)</small></p></td><td><p> The URL to search for. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a> collection. </p> </div> <div class="method"><h5 id="snaps-findByURLPrefix" title="snaps-findByURLPrefix">findByURLPrefix</h5><div> <p>Return all snap packages that build from a URL with this prefix.</p> <p>This currently only works for packages that build directly from a URL, rather than being linked to a Bazaar branch or Git repository hosted in Launchpad.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByURLPrefix</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>url_prefix</strong></p></td><td><p><small>(required)</small></p></td><td><p> The URL prefix to search for. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a> collection. </p> </div> <div class="method"><h5 id="snaps-findByURLPrefixes" title="snaps-findByURLPrefixes">findByURLPrefixes</h5><div> <p>Return all snap packages that build from a URL with any of these prefixes.</p> <p>This currently only works for packages that build directly from a URL, rather than being linked to a Bazaar branch or Git repository hosted in Launchpad.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findByURLPrefixes</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>url_prefixes</strong></p></td><td><p><small>(required)</small></p></td><td><p> The URL prefixes to search for. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a> collection. </p> </div> <div class="method"><h5 id="snaps-getByName" title="snaps-getByName">getByName</h5><p> Return the appropriate ISnap for the given objects. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Snap name </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap">snap</a>. </p> </div> </div> <div id="snaps-custom-POSTs" title="snaps-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="snaps-new" title="snaps-new">new</h5><p> Create an ISnap. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>new</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>auto_build</strong></p></td><td><p></p></td><td><div> <p>Automatically build when branch changes</p> <p>Whether this snap package is built automatically when the branch containing its snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe changes.</p> </div></td></tr><tr><td><p><strong>auto_build_archive</strong></p></td><td><p></p> Link to a <a href="#archive">archive</a>. </td><td><div> <p>Source archive for automatic builds</p> <p>The archive from which automatic builds of this snap package should be built.</p> </div></td></tr><tr><td><p><strong>auto_build_pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket for automatic builds</p> <p>The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.</p> </div></td></tr><tr><td><p><strong>branch</strong></p></td><td><p></p> Link to a <a href="#branch">branch</a>. </td><td><div> <p>Bazaar branch</p> <p>A Bazaar branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>A description of the snap package.</p> </div></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><div> <p>Distro Series</p> <p>The series for which the snap package should be built. If not set, Launchpad will infer an appropriate series from snapcraft.yaml.</p> </div></td></tr><tr><td><p><strong>git_path</strong></p></td><td><p></p></td><td><div> <p>Git branch path</p> <p>The path of the Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div></td></tr><tr><td><p><strong>git_ref</strong></p></td><td><p></p> Link to a <a href="#git_ref">git_ref</a>. </td><td><div> <p>Git branch</p> <p>The Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div></td></tr><tr><td><p><strong>git_repository</strong></p></td><td><p></p> Link to a <a href="#git_repository">git_repository</a>. </td><td><div> <p>Git repository</p> <p>A Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div></td></tr><tr><td><p><strong>git_repository_url</strong></p></td><td><p></p></td><td><div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Public</tt></li><li><tt>Public Security</tt></li><li><tt>Private Security</tt></li><li><tt>Private</tt></li><li><tt>Proprietary</tt></li><li><tt>Embargoed</tt></li></ul></td><td><div> <p>Information type</p> <p>The type of information contained in this Snap recipe.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Snap recipe name</p> <p>The name of the snap build recipe.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Owner</p> <p>The owner of this snap package.</p> </div></td></tr><tr><td><p><strong>processors</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>project</strong></p></td><td><p></p> Link to a <a href="#project">project</a>. </td><td><p> The project that this Snap is associated with </p></td></tr><tr><td><p><strong>store_channels</strong></p></td><td><p></p></td><td><div> <p>Store channels</p> <p>Channels to release this snap package to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div></td></tr><tr><td><p><strong>store_name</strong></p></td><td><p></p></td><td><div> <p>Registered store package name</p> <p>The registered name of this snap package in the store.</p> </div></td></tr><tr><td><p><strong>store_series</strong></p></td><td><p></p> Link to a <a href="#snappy_series">snappy_series</a>. </td><td><div> <p>Store series</p> <p>The series in which this snap package should be published in the store.</p> </div></td></tr><tr><td><p><strong>store_upload</strong></p></td><td><p></p></td><td><div> <p>Automatically upload to store</p> <p>Whether builds of this snap package are automatically uploaded to the store.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#snap">snap</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="specifications" title="specifications" class="top-level-object"> <h3>specifications</h3> <p> A container for specifications. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/specifications</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#specification">specification</a> collection.</dd> </dl> </div> <div id="specifications-custom-POSTs" title="specifications-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="specifications-createSpecification" title="specifications-createSpecification">createSpecification</h5><p> Create a new specification. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createSpecification</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Assignee</p> <p>The person responsible for implementing the feature.</p> </div></td></tr><tr><td><p><strong>definition_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Pending Approval</tt></li><li><tt>Review</tt></li><li><tt>Drafting</tt></li><li><tt>Discussion</tt></li><li><tt>New</tt></li><li><tt>Superseded</tt></li><li><tt>Obsolete</tt></li></ul></td><td><div> <p>Definition Status</p> <p>The current status of the process to define the feature and get approval for the implementation plan.</p> </div></td></tr><tr><td><p><strong>drafter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Drafter</p> <p>The person responsible for drafting the specification.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>May contain lower-case letters, numbers, and dashes. It will be used in the specification url. Examples: mozilla-type-ahead-find, postgres-smart-serial.</p> </div></td></tr><tr><td><p><strong>specurl</strong></p></td><td><p></p></td><td><div> <p>Specification URL</p> <p>The URL of the specification. This is usually a wiki page.</p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Summary</p> <p>A single-paragraph description of the feature. This will also be displayed in most feature listings.</p> </div></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#specification_target">specification_target</a>. </td><td><p> The product or distribution context of this specification. </p></td></tr><tr><td><p><strong>title</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Title</p> <p>Describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.</p> </div></td></tr><tr><td><p><strong>whiteboard</strong></p></td><td><p></p></td><td><div> <p>Status Whiteboard</p> <p>Any notes on the status of this spec you would like to make. Your changes will override the current text.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#specification">specification</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="temporary_blobs" title="temporary_blobs" class="top-level-object"> <h3>temporary_blobs</h3> <p> A tool to create temporary blobs. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/temporary_blobs</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#temporary_blob">temporary_blob</a> collection.</dd> </dl> </div> <div id="temporary_blobs-custom-GETs" title="temporary_blobs-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="temporary_blobs-fetch" title="temporary_blobs-fetch">fetch</h5> <p> Retrieve a TemporaryBlobStorage by uuid. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>fetch</var></p> </td> <td> <p>The name of the operation being invoked.</p> </td> </tr> <tr> <td> <p> <strong>token</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> UUID </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="translation_groups" title="translation_groups" class="top-level-object"> <h3>translation_groups</h3> <p> A container for translation groups. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/translation_groups</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#translation_group">translation_group</a> collection.</dd> </dl> </div> <div id="translation_groups-custom-GETs" title="translation_groups-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="translation_groups-getByName" title="translation_groups-getByName">getByName</h5><p> Get a translation group by name. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getByName</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name of the translation group </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_group">translation_group</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> <div id="translation_import_queue_entries" title="translation_import_queue_entries" class="top-level-object"> <h3>translation_import_queue_entries</h3> <p> A set of files to be imported into Rosetta. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/translation_import_queue_entries</code> </p> <div class="methods standard"> <h4>Standard method</h4> <dl> <dt>GET</dt> <dd>Response contains a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection.</dd> </dl> </div> <div id="translation_import_queue_entries-custom-GETs" title="translation_import_queue_entries-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="translation_import_queue_entries-getAllEntries" title="translation_import_queue_entries-getAllEntries">getAllEntries</h5><div> <p>Return all entries this import queue has.</p> <p>If any of target, status or file_extension are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAllEntries</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><p> The status of the import. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="translation_import_queue_entries-getFirstEntryToImport" title="translation_import_queue_entries-getFirstEntryToImport">getFirstEntryToImport</h5><div> <p>Return the first entry of the queue ready to be imported.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getFirstEntryToImport</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>target</strong></p></td><td><p></p> Link to a <a href="#object_with_translation_imports">object_with_translation_imports</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a>. </p> </div> <div class="method"><h5 id="translation_import_queue_entries-getRequestTargets" title="translation_import_queue_entries-getRequestTargets">getRequestTargets</h5><div> <p>List Product`s and `DistroSeries with pending imports.</p> <p>All returned items will implement IHasTranslationImports.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRequestTargets</var></p></td><td><p>The name of the operation being invoked.</p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><p> The status of the import. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#object_with_translation_imports">object_with_translation_imports</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </div> </div> <h2 id="entry-types" title="entry-types">Entry types</h2> <h3 id="access_token" title="access_token">access_token</h3> <p> A personal access token for the webservice API. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/[target URL]/+access-token/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Creation date</p> <p>When the token was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Expiry date</p> <p>When the token should expire or was revoked.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_used</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date last used</p> <p>When the token was last used.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of the token.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The person who created the token.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revoked_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Revoked by</p> <p>The person who revoked the token, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>scopes</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Scopes</p> <p>A list of scopes granted by the token.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#access_token_target">access_token_target</a>. </td> <td> <div> <p>Target</p> <p>The target for which the token was issued.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="access_token-standard-methods" title="access_token-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="access_token-custom-POSTs" title="access_token-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="access_token-revoke" title="access_token-revoke">revoke</h5> <p> Revoke this token. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>revoke</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="access_token_target" title="access_token_target">access_token_target</h3> <p> An object that can be a target for access tokens. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="access_token_target-standard-methods" title="access_token_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="access_token_target-custom-POSTs" title="access_token_target-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="access_token_target-issueAccessToken" title="access_token_target-issueAccessToken">issueAccessToken</h5> <div> <p>Issue a personal access token for this target.</p> <p>Access tokens can be used to push to repositories over HTTPS. These may be used in webservice API requests for certain methods in the target's repositories.</p> <p>They are either non-expiring or with an expiry time given by date_expires.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>issueAccessToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p></p> </td> <td> <p> When the token should expire. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A short description of the token. </p> </td> </tr> <tr> <td> <p> <strong>scopes</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of scopes to be granted by this token. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The secret for a new personal access token (Launchpad only records the hash of this secret and not the secret itself, so the caller must be careful to save this).</td> </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="archive" title="archive">archive</h3> <p> Main Archive interface. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution></var>/+archive/<var><archive.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>authorized_size</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Authorized size</p> <p>Maximum size, in MiB, allowed for the archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_debug_symbols</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build debug symbols</p> <p>Create debug symbol packages for builds in the archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive_dependency">archive_dependency</a> collection. </td> <td> <p> Archive dependencies recorded for this archive. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of the archive. URLs are allowed and will be rendered as links.</p> </div> </td> </tr> <tr> <td> <p> <strong>displayname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display name</p> <p>A short title for the archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <p> The distribution that uses or is used by this archive. </p> </td> </tr> <tr> <td> <p> <strong>enabled_restricted_processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Enabled restricted processors</p> <p>DEPRECATED. Use processors instead.</p> </div> </td> </tr> <tr> <td> <p> <strong>external_dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>External dependencies</p> <p>Newline-separated list of repositories to be used to retrieve any external build-dependencies when building packages in the archive, in the format: deb http[s]://[user:pass@]<host>[/path] %(series)s[-pocket] [components] The series variable is replaced with the series name of the context build. NOTE: This is for migration of OEM PPAs only!</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>metadata_overrides</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>A JSON object containing metadata overrides for this archive.</p> <p>Accepted keys are Origin, Label, Suite and Snapshots.The values for all these keys should be a string and can use a {series} placeholder, which will get substituted by the name of the series that is currently being published.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The archive owner.</p> </div> </td> </tr> <tr> <td> <p> <strong>permit_obsolete_series_uploads</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Permit uploads to obsolete series</p> <p>Allow uploads targeted to obsolete series.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Private</p> <p>Restrict access to the archive to its owner and subscribers. This can only be changed if the archive has never had any sources published.</p> </div> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures on which the archive can build.</p> </div> </td> </tr> <tr> <td> <p> <strong>publish</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Publishing enabled</p> <p>Whether or not to update the apt repository. If disabled, nothing will be published. If the archive is private then additionally no builds will be dispatched.</p> </div> </td> </tr> <tr> <td> <p> <strong>publish_debug_symbols</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Publish debug symbols</p> <p>Publish debug symbol packages in the apt repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>publishing_method</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Local</tt> </li> <li> <tt>Artifactory</tt> </li> </ul> </td> <td> <p> Publishing method </p> </td> </tr> <tr> <td> <p> <strong>reference</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Reference</p> <p>A string to uniquely identify the archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>relative_build_score</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Relative build score</p> <p>A delta to apply to all build scores for the archive. Builds with a higher score will build sooner.</p> </div> </td> </tr> <tr> <td> <p> <strong>repository_format</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Debian</tt> </li> <li> <tt>Python</tt> </li> <li> <tt>Conda</tt> </li> <li> <tt>Go</tt> </li> <li> <tt>Generic</tt> </li> <li> <tt>Rust</tt> </li> </ul> </td> <td> <p> Repository format </p> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build the archive's packages on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>signing_key_fingerprint</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Archive signing key fingerprint</p> <p>A OpenPGP signing key fingerprint (40 chars) for this PPA or None if there is no signing key available.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Status of archive. </p> </td> </tr> <tr> <td> <p> <strong>suppress_subscription_notifications</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Suppress subscription notifications</p> <p>Whether subscribers to private PPAs get emails about their subscriptions. Has no effect on a public PPA.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="archive-standard-methods" title="archive-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="archive-custom-GETs" title="archive-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="archive-checkUpload" title="archive-checkUpload">checkUpload</h5> <p> Wrapper around checkUpload for the web service API. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>checkUpload</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>component</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Component </p> </td> </tr> <tr> <td> <p> <strong>distroseries</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> The distro series </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div> </td> </tr> <tr> <td> <p> <strong>sourcepackagename</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package name </p> </td> </tr> <tr> <td> <p> <strong>strict_component</strong> </p> </td> <td> <p></p> </td> <td> <p> Strict component </p> </td> </tr> </table> </div> <div class="method"><h5 id="archive-getAllPermissions" title="archive-getAllPermissions">getAllPermissions</h5><div> <p>Return all IArchivePermission records for this archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAllPermissions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getArchiveDependency" title="archive-getArchiveDependency">getArchiveDependency</h5><div> <p>Return the IArchiveDependency object for the given dependency.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getArchiveDependency</var></p></td><td></td></tr><tr><td><p><strong>dependency</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_dependency">archive_dependency</a>. </p> </div> <div class="method"> <h5 id="archive-getBuildCounters" title="archive-getBuildCounters">getBuildCounters</h5> <div> <p>Return a dictionary containing the build counters for an archive.</p> <p>This is necessary currently because the IArchive.failed_builds etc. counters are not in use.</p> <p>The returned dictionary contains the following keys and values:</p> <blockquote> <ul class="rst-simple"> <li>'total': total number of builds (includes SUPERSEDED);</li> <li>'pending': number of builds in BUILDING or NEEDSBUILD state;</li> <li>'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, CHROOTWAIT and FAILEDTOUPLOAD state;</li> <li>'succeeded': number of SUCCESSFULLYBUILT builds.</li> <li>'superseded': number of SUPERSEDED builds.</li> </ul> </blockquote> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBuildCounters</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>include_needsbuild</strong> </p> </td> <td> <p></p> </td> <td> <p> Include builds with state NEEDSBUILD </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">a dictionary with the 4 keys specified above.</td> </p> </div> <div class="method"><h5 id="archive-getBuildRecords" title="archive-getBuildRecords">getBuildRecords</h5><div> <p>Return build records in the context it is implemented.</p> <p>It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.</p> <p>The result is simply not filtered if the optional filters are omitted by call sites.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildRecords</var></p></td><td></td></tr><tr><td><p><strong>build_state</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs building</tt></li><li><tt>Successfully built</tt></li><li><tt>Failed to build</tt></li><li><tt>Dependency wait</tt></li><li><tt>Chroot problem</tt></li><li><tt>Build for superseded Source</tt></li><li><tt>Currently building</tt></li><li><tt>Failed to upload</tt></li><li><tt>Uploading build</tt></li><li><tt>Cancelling build</tt></li><li><tt>Cancelled build</tt></li><li><tt>Gathering build output</tt></li></ul></td><td><div> <p>Build status</p> <p>The status of this build record</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> <div class="method"> <h5 id="archive-getBuildSummariesForSourceIds" title="archive-getBuildSummariesForSourceIds">getBuildSummariesForSourceIds</h5> <div> <p>Return a dictionary containing a summary of the build statuses.</p> <p>Only information for sources belonging to the current archive will be returned. See IPublishingSet.getBuildStatusSummariesForSourceIdsAndArchive() for details.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBuildSummariesForSourceIds</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>source_ids</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of source publishing history record ids. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A dict consisting of the overall status summaries for the given ids that belong in the archive.</td> </p> </div> <div class="method"><h5 id="archive-getComponentsForQueueAdmin" title="archive-getComponentsForQueueAdmin">getComponentsForQueueAdmin</h5><div> <p>Return IArchivePermission for the person's queue admin components.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getComponentsForQueueAdmin</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"> <h5 id="archive-getNamedAuthToken" title="archive-getNamedAuthToken">getNamedAuthToken</h5> <p> <dl class="rst-docutils"> <dt>Return a named authorization token for the given name in this</dt> <dd>archive.</dd> </dl> </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getNamedAuthToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Authorization token name </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">An ArchiveAuthToken object or a dictionary where the value of token is the secret and the value of archive_url is the externally-usable archive URL including basic auth.</td> </p> </div> <div class="method"> <h5 id="archive-getNamedAuthTokens" title="archive-getNamedAuthTokens">getNamedAuthTokens</h5> <div> <p>Return a subset of active named authorization tokens for this archive if names is specified, or all active named authorization tokens for this archive is names is null.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getNamedAuthTokens</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p></p> </td> <td> <p> Authorization token names </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A list of ArchiveAuthToken objects or a list of dictionaries where token is the secret and archive_url is the externally-usable archive URL including basic auth.</td> </p> </div> <div class="method"><h5 id="archive-getPackagesetsForSource" title="archive-getPackagesetsForSource">getPackagesetsForSource</h5><div> <p>All package set based permissions for the given source.</p> <p>This method is meant to aid the process of "debugging" package set based archive permission since It allows the listing of permissions for the given source package in this archive (irrespective of the principal).</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPackagesetsForSource</var></p></td><td></td></tr><tr><td><p><strong>direct_permissions</strong></p></td><td><p></p></td><td><p> Ignore package set hierarchy </p></td></tr><tr><td><p><strong>sourcepackagename</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPackagesetsForSourceUploader" title="archive-getPackagesetsForSourceUploader">getPackagesetsForSourceUploader</h5><div> <p>The package set based permissions for a given source and uploader.</p> <dl class="rst-docutils"> <dt>Return the IArchivePermission records that</dt> <dd><ul class="rst-first rst-last rst-simple"> <li>apply to this archive</li> <li><dl class="rst-first rst-docutils"> <dt>relate to</dt> <dd><ul class="rst-first rst-last"> <li>package sets that include the given source package name</li> <li>the given person</li> </ul> </dd> </dl> </li> </ul> </dd> </dl> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPackagesetsForSourceUploader</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>sourcepackagename</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPackagesetsForUploader" title="archive-getPackagesetsForUploader">getPackagesetsForUploader</h5><div> <p>The ArchivePermission records for the person's package sets.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPackagesetsForUploader</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPermissionsForPerson" title="archive-getPermissionsForPerson">getPermissionsForPerson</h5><div> <p>Return the IArchivePermission records applicable to the person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPermissionsForPerson</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPocketsForQueueAdmin" title="archive-getPocketsForQueueAdmin">getPocketsForQueueAdmin</h5><div> <p>Return IArchivePermission for the person's queue admin pockets.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPocketsForQueueAdmin</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPocketsForUploader" title="archive-getPocketsForUploader">getPocketsForUploader</h5><div> <p>Return the pockets that 'person' can upload to this archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPocketsForUploader</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getPublishedBinaries" title="archive-getPublishedBinaries">getPublishedBinaries</h5><div> <p>All IBinaryPackagePublishingHistory target to this archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPublishedBinaries</var></p></td><td></td></tr><tr><td><p><strong>binary_name</strong></p></td><td><p></p></td><td><p> Binary Package Name </p></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p></p></td><td><p> Component name </p></td></tr><tr><td><p><strong>created_since_date</strong></p></td><td><p></p></td><td><div> <p>Created Since Date</p> <p>Return entries whose date_created is greater than or equal to this date.</p> </div></td></tr><tr><td><p><strong>distro_arch_series</strong></p></td><td><p></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td><td><p> Distro Arch Series </p></td></tr><tr><td><p><strong>exact_match</strong></p></td><td><p></p></td><td><p> Whether or not to filter binary names by exact matching. </p></td></tr><tr><td><p><strong>order_by_date</strong></p></td><td><p></p></td><td><div> <p>Order by creation date</p> <p>Return newest results first. This is recommended for applications that need to catch up with publications since their last run.</p> </div></td></tr><tr><td><p><strong>order_by_date_ascending</strong></p></td><td><p></p></td><td><div> <p>Order by ascending creation date</p> <p>Return oldest results first.</p> </div></td></tr><tr><td><p><strong>ordered</strong></p></td><td><p></p></td><td><div> <p>Ordered</p> <p>Return ordered results by default, but specifying False will return results more quickly.</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Pending</tt></li><li><tt>Published</tt></li><li><tt>Superseded</tt></li><li><tt>Deleted</tt></li><li><tt>Obsolete</tt></li></ul></td><td><div> <p>Package Publishing Status</p> <p>The status of this publishing record</p> </div></td></tr><tr><td><p><strong>version</strong></p></td><td><p></p></td><td><p> Version </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#binary_package_publishing_history">binary_package_publishing_history</a> collection. </p> </div> <div class="method"><h5 id="archive-getPublishedSources" title="archive-getPublishedSources">getPublishedSources</h5><p> All ISourcePackagePublishingHistory target to this archive. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPublishedSources</var></p></td><td></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p></p></td><td><p> Component name </p></td></tr><tr><td><p><strong>created_since_date</strong></p></td><td><p></p></td><td><div> <p>Created Since Date</p> <p>Return entries whose date_created is greater than or equal to this date.</p> </div></td></tr><tr><td><p><strong>distro_series</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distroseries name </p></td></tr><tr><td><p><strong>exact_match</strong></p></td><td><p></p></td><td><div> <p>Exact Match</p> <p>Whether or not to filter source names by exact matching.</p> </div></td></tr><tr><td><p><strong>order_by_date</strong></p></td><td><p></p></td><td><div> <p>Order by creation date</p> <p>Return newest results first. This is recommended for applications that need to catch up with publications since their last run. If not specified, results are ordered by source package name (lexicographically), then by descending version and then descending ID.</p> </div></td></tr><tr><td><p><strong>order_by_date_ascending</strong></p></td><td><p></p></td><td><div> <p>Order by ascending creation date</p> <p>Return oldest results first.</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Pending</tt></li><li><tt>Published</tt></li><li><tt>Superseded</tt></li><li><tt>Deleted</tt></li><li><tt>Obsolete</tt></li></ul></td><td><div> <p>Package Publishing Status</p> <p>The status of this publishing record</p> </div></td></tr><tr><td><p><strong>version</strong></p></td><td><p></p></td><td><p> Version </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_publishing_history">source_package_publishing_history</a> collection. </p> </div> <div class="method"><h5 id="archive-getQueueAdminsForComponent" title="archive-getQueueAdminsForComponent">getQueueAdminsForComponent</h5><div> <p>Return IArchivePermission records for authorized queue admins.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getQueueAdminsForComponent</var></p></td><td></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Component Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getQueueAdminsForPocket" title="archive-getQueueAdminsForPocket">getQueueAdminsForPocket</h5><div> <p>Return IArchivePermission records for authorized queue admins.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getQueueAdminsForPocket</var></p></td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"> <h5 id="archive-getSigningKeyData" title="archive-getSigningKeyData">getSigningKeyData</h5> <div> <p>Get the public key used to sign this repository.</p> <p>If the repository has a signing key but it cannot be retrieved from the keyserver, then the response will have an appropriate 4xx or 5xx HTTP status code. Otherwise, returns the ASCII-armoured public key material as a text string, or None if the repository has no signing key.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSigningKeyData</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="archive-getUploadersForComponent" title="archive-getUploadersForComponent">getUploadersForComponent</h5><div> <p>Return IArchivePermission records for the component's uploaders.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getUploadersForComponent</var></p></td><td></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p></p></td><td><p> Component Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getUploadersForPackage" title="archive-getUploadersForPackage">getUploadersForPackage</h5><div> <p>Return IArchivePermission records for the package's uploaders.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getUploadersForPackage</var></p></td><td></td></tr><tr><td><p><strong>source_package_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source Package Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getUploadersForPackageset" title="archive-getUploadersForPackageset">getUploadersForPackageset</h5><div> <p>The ArchivePermission records for uploaders to the package set.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getUploadersForPackageset</var></p></td><td></td></tr><tr><td><p><strong>direct_permissions</strong></p></td><td><p></p></td><td><p> Ignore package set hierarchy </p></td></tr><tr><td><p><strong>packageset</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td><td><p> Package set </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"><h5 id="archive-getUploadersForPocket" title="archive-getUploadersForPocket">getUploadersForPocket</h5><div> <p>Return IArchivePermission records for the pocket's uploaders.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getUploadersForPocket</var></p></td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_permission">archive_permission</a> collection. </p> </div> <div class="method"> <h5 id="archive-isSourceUploadAllowed" title="archive-isSourceUploadAllowed">isSourceUploadAllowed</h5> <div> <p>True if the person is allowed to upload the given source package.</p> <dl class="rst-docutils"> <dt>Return True if there exists a permission that combines</dt> <dd><ul class="rst-first rst-last rst-simple"> <li>this archive</li> <li>a package set that includes the given source package name</li> <li>the given person or a team they are a member of</li> </ul> </dd> </dl> <p>If the source package name is included by <em>any</em> package set with an explicit permission then only such explicit permissions will be considered.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isSourceUploadAllowed</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>distroseries</strong> </p> </td> <td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> The distro series </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>sourcepackagename</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package name </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person is allowed to upload the source package.</td> </p> </div> </div> <div id="archive-custom-POSTs" title="archive-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="archive-addArchiveDependency" title="archive-addArchiveDependency">addArchiveDependency</h5><div> <p>Record an archive dependency record for the context archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addArchiveDependency</var></p></td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><p> Component </p></td></tr><tr><td><p><strong>dependency</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_dependency">archive_dependency</a>. </p> <h6>Errors</h6><ul><li><td class="rst-field-body">ArchiveDependencyError if given 'dependency' does not fit the context archive.</td></li></ul></div> <div class="method"> <h5 id="archive-copyPackage" title="archive-copyPackage">copyPackage</h5> <div> <p>Copy a single named source into this archive.</p> <p>Asynchronously copy a specific version of a named source to the destination archive if necessary. Calls to this method will return immediately if the copy passes basic security checks and the copy will happen sometime later with full checking.</p> <p>If the source or target distribution has a development series alias, then it may be used as the source or target distroseries name respectively; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the respective published archives.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>copyPackage</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>auto_approve</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Automatic approval</p> <p>Automatically approve this copy (queue admins only).</p> </div> </td> </tr> <tr> <td> <p> <strong>from_archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>from_pocket</strong> </p> </td> <td> <p></p> </td> <td> <p> Source pocket name </p> </td> </tr> <tr> <td> <p> <strong>from_series</strong> </p> </td> <td> <p></p> </td> <td> <p> Source distroseries name </p> </td> </tr> <tr> <td> <p> <strong>include_binaries</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Include Binaries</p> <p>Whether or not to copy binaries already built for this source</p> </div> </td> </tr> <tr> <td> <p> <strong>move</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Move</p> <p>If true, delete the source publication after copying it to the destination.</p> </div> </td> </tr> <tr> <td> <p> <strong>phased_update_percentage</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Phased update percentage</p> <p>The percentage of users for whom this package should be recommended, or None to publish the update for everyone.</p> </div> </td> </tr> <tr> <td> <p> <strong>silent</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Silent</p> <p>Don't notify anyone about this copy. For use by queue admins only.</p> </div> </td> </tr> <tr> <td> <p> <strong>source_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package name </p> </td> </tr> <tr> <td> <p> <strong>sponsored</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Sponsored Person</p> <p>The person who is being sponsored for this copy.</p> </div> </td> </tr> <tr> <td> <p> <strong>to_pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Target pocket name </p> </td> </tr> <tr> <td> <p> <strong>to_series</strong> </p> </td> <td> <p></p> </td> <td> <p> Target distroseries name </p> </td> </tr> <tr> <td> <p> <strong>unembargo</strong> </p> </td> <td> <p></p> </td> <td> <p> Unembargo restricted files </p> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Version </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-copyPackages" title="archive-copyPackages">copyPackages</h5> <div> <p>Copy multiple named sources into this archive from another.</p> <p>Asynchronously copy the most recent PUBLISHED versions of the named sources to the destination archive if necessary. Calls to this method will return immediately if the copy passes basic security checks and the copy will happen sometime later with full checking.</p> <p>Partial changes of the destination archive can happen because each source is copied in its own transaction.</p> <p>If the source or target distribution has a development series alias, then it may be used as the source or target distroseries name respectively; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the respective published archives.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>copyPackages</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>auto_approve</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Automatic approval</p> <p>Automatically approve this copy (queue admins only).</p> </div> </td> </tr> <tr> <td> <p> <strong>from_archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>from_series</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Distroseries name</p> <p>The distro series to copy packages from.</p> </div> </td> </tr> <tr> <td> <p> <strong>include_binaries</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Include Binaries</p> <p>Whether or not to copy binaries already built for this source</p> </div> </td> </tr> <tr> <td> <p> <strong>silent</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Silent</p> <p>Don't notify anyone about this copy. For use by queue admins only.</p> </div> </td> </tr> <tr> <td> <p> <strong>source_names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package names </p> </td> </tr> <tr> <td> <p> <strong>sponsored</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Sponsored Person</p> <p>The person who is being sponsored for this copy.</p> </div> </td> </tr> <tr> <td> <p> <strong>to_pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Pocket name </p> </td> </tr> <tr> <td> <p> <strong>to_series</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Distroseries name</p> <p>The distro series to copy packages into.</p> </div> </td> </tr> <tr> <td> <p> <strong>unembargo</strong> </p> </td> <td> <p></p> </td> <td> <p> Unembargo restricted files </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-deleteComponentUploader" title="archive-deleteComponentUploader">deleteComponentUploader</h5> <div> <p>Revoke permission for the person to upload to the component.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteComponentUploader</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Component Name </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-deletePackageUploader" title="archive-deletePackageUploader">deletePackageUploader</h5> <div> <p>Revoke permission for the person to upload the package.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePackageUploader</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source Package Name </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-deletePackagesetUploader" title="archive-deletePackagesetUploader">deletePackagesetUploader</h5> <div> <p>Revoke upload permissions for a person.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePackagesetUploader</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>explicit</strong> </p> </td> <td> <p></p> </td> <td> <p> Explicit </p> </td> </tr> <tr> <td> <p> <strong>packageset</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td> <td> <p> Package set </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-deletePocketQueueAdmin" title="archive-deletePocketQueueAdmin">deletePocketQueueAdmin</h5> <div> <p>Revoke permission for the person to administer distroseries queues.</p> <p>The supplied person will lose permission to administer the distroseries queue for packages in the supplied series and pocket.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePocketQueueAdmin</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>distroseries</strong> </p> </td> <td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Distro series </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> Pocket </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-deletePocketUploader" title="archive-deletePocketUploader">deletePocketUploader</h5> <div> <p>Revoke permission for the person to upload to the pocket.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePocketUploader</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> Pocket </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-deleteQueueAdmin" title="archive-deleteQueueAdmin">deleteQueueAdmin</h5> <div> <p>Revoke permission for the person to administer distroseries queues.</p> <p>The supplied person will lose permission to administer the distroseries queue for packages in the supplied component.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteQueueAdmin</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Component Name </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-enableRestrictedProcessor" title="archive-enableRestrictedProcessor">enableRestrictedProcessor</h5> <div> <p>Add the processor to the set of enabled restricted processors.</p> <p>DEPRECATED. Use setProcessors instead.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>enableRestrictedProcessor</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processor</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#processor">processor</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-markSuiteDirty" title="archive-markSuiteDirty">markSuiteDirty</h5> <div> <p>Mark a suite as dirty in this archive.</p> <p>The next publisher run will publish this suite regardless of whether it has any pending publications.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>markSuiteDirty</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>distroseries</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Distro series </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> Pocket </p> </td> </tr> </table> </div> <div class="method"><h5 id="archive-newComponentUploader" title="archive-newComponentUploader">newComponentUploader</h5><div> <p>Add permission for a person to upload to a component.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newComponentUploader</var></p></td><td></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Component Name </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"> <h5 id="archive-newNamedAuthToken" title="archive-newNamedAuthToken">newNamedAuthToken</h5> <div> <p>Create a new named authorization token.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>newNamedAuthToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Authorization token name </p> </td> </tr> <tr> <td> <p> <strong>token</strong> </p> </td> <td> <p></p> </td> <td> <p> Optional secret for this named token </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">An ArchiveAuthToken object or a dictionary where the value of token is the secret and the value of archive_url is the externally-usable archive URL including basic auth.</td> </p> </div> <div class="method"> <h5 id="archive-newNamedAuthTokens" title="archive-newNamedAuthTokens">newNamedAuthTokens</h5> <div> <p>Create named authorization tokens in bulk.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>newNamedAuthTokens</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Authorization token names </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A list of ArchiveAuthToken objects or a dictionary of {name: {token, archive_url} where name is a token name, token is the secret and archive_url is the externally-usable archive URL including basic auth.</td> </p> </div> <div class="method"><h5 id="archive-newPackageUploader" title="archive-newPackageUploader">newPackageUploader</h5><div> <p>Add permission for a person to upload a package to this archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newPackageUploader</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>source_package_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source Package Name </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"><h5 id="archive-newPackagesetUploader" title="archive-newPackagesetUploader">newPackagesetUploader</h5><div> <p>Add a package set based permission for a person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newPackagesetUploader</var></p></td><td></td></tr><tr><td><p><strong>explicit</strong></p></td><td><p></p></td><td><p> Explicit </p></td></tr><tr><td><p><strong>packageset</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td><td><p> Package set </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"><h5 id="archive-newPocketQueueAdmin" title="archive-newPocketQueueAdmin">newPocketQueueAdmin</h5><div> <p>Add permission for a person to administer a distroseries queue.</p> <p>The supplied person will gain permission to administer the distroseries queue for packages in the supplied series and pocket.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newPocketQueueAdmin</var></p></td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> Distro series </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"><h5 id="archive-newPocketUploader" title="archive-newPocketUploader">newPocketUploader</h5><div> <p>Add permission for a person to upload to a pocket.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newPocketUploader</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"><h5 id="archive-newQueueAdmin" title="archive-newQueueAdmin">newQueueAdmin</h5><div> <p>Add permission for a person to administer a distroseries queue.</p> <p>The supplied person will gain permission to administer the distroseries queue for packages in the supplied component.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newQueueAdmin</var></p></td><td></td></tr><tr><td><p><strong>component_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Component Name </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_permission">archive_permission</a>. </p> </div> <div class="method"><h5 id="archive-newSubscription" title="archive-newSubscription">newSubscription</h5><div> <p>Create a new subscription to this archive.</p> <p>Create an ArchiveSubscriber record which allows an IPerson to access a private repository.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newSubscription</var></p></td><td></td></tr><tr><td><p><strong>date_expires</strong></p></td><td><p></p></td><td><div> <p>Date of Expiration</p> <p>The timestamp when the subscription will expire.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>Free text describing this subscription.</p> </div></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><div> <p>Subscriber</p> <p>The person who is subscribed.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_subscriber">archive_subscriber</a>. </p> </div> <div class="method"> <h5 id="archive-removeArchiveDependency" title="archive-removeArchiveDependency">removeArchiveDependency</h5> <div> <p>Remove the IArchiveDependency record for the given dependency.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeArchiveDependency</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>dependency</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-removeCopyNotification" title="archive-removeCopyNotification">removeCopyNotification</h5> <div> <p>Remove a copy notification that's displayed on the +packages page.</p> <p>Copy notifications are shown on the +packages page when a PlainPackageCopyJob is in progress or failed. Calling this method will delete failed jobs so they no longer appear on the page.</p> <p>You need to have upload privileges on the PPA to use this.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeCopyNotification</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>job_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-revokeNamedAuthToken" title="archive-revokeNamedAuthToken">revokeNamedAuthToken</h5> <div> <p>Deactivate a named authorization token.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>revokeNamedAuthToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Authorization token name </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-revokeNamedAuthTokens" title="archive-revokeNamedAuthTokens">revokeNamedAuthTokens</h5> <div> <p>Deactivate named authorization tokens in bulk.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>revokeNamedAuthTokens</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Authorization token names </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-setProcessors" title="archive-setProcessors">setProcessors</h5> <p> Set the architectures on which the archive can build. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="archive-syncSource" title="archive-syncSource">syncSource</h5> <div> <p>Synchronise (copy) a single named source into this archive.</p> <p>DEPRECATED: syncSource and syncSources are deprecated, and will be removed entirely in the future. Use the asynchronous copyPackage method instead, and poll getPublishedSources if you need to await completion.</p> <p>Copy a specific version of a named source to the destination archive if necessary.</p> <p>If the source distribution has a development series alias, then it may be used as the source distroseries name; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the published source archive.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>syncSource</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>from_archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>include_binaries</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Include Binaries</p> <p>Whether or not to copy binaries already built for this source</p> </div> </td> </tr> <tr> <td> <p> <strong>source_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package name </p> </td> </tr> <tr> <td> <p> <strong>to_pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Pocket name </p> </td> </tr> <tr> <td> <p> <strong>to_series</strong> </p> </td> <td> <p></p> </td> <td> <p> Distroseries name </p> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Version </p> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-syncSources" title="archive-syncSources">syncSources</h5> <div> <p>Synchronise (copy) named sources into this archive from another.</p> <p>DEPRECATED: syncSource and syncSources are deprecated, and will be removed entirely in the future. Use the asynchronous copyPackage method instead, and poll getPublishedSources if you need to await completion.</p> <p>It will copy the most recent PUBLISHED versions of the named sources to the destination archive if necessary.</p> <p>This operation will only succeeds when all requested packages are synchronised between the archives. If any of the requested copies cannot be performed, the whole operation will fail. There will be no partial changes of the destination archive.</p> <p>If the source or target distribution has a development series alias, then it may be used as the source or target distroseries name respectively; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the respective published archives.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>syncSources</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>from_archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>from_series</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Distroseries name</p> <p>The distro series to copy packages from.</p> </div> </td> </tr> <tr> <td> <p> <strong>include_binaries</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Include Binaries</p> <p>Whether or not to copy binaries already built for this source</p> </div> </td> </tr> <tr> <td> <p> <strong>source_names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Source package names </p> </td> </tr> <tr> <td> <p> <strong>to_pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Pocket name </p> </td> </tr> <tr> <td> <p> <strong>to_series</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Distroseries name</p> <p>The distro series to copy packages into.</p> </div> </td> </tr> </table> </div> <div class="method"> <h5 id="archive-uploadCIBuild" title="archive-uploadCIBuild">uploadCIBuild</h5> <p> Upload the output of a CI build to this archive. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>uploadCIBuild</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>ci_build</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#ci_build">ci_build</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>to_channel</strong> </p> </td> <td> <p></p> </td> <td> <p> Target channel </p> </td> </tr> <tr> <td> <p> <strong>to_pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Target pocket name </p> </td> </tr> <tr> <td> <p> <strong>to_series</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Target distroseries name </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="archive_dependency" title="archive_dependency">archive_dependency</h3> <p> ArchiveDependency interface. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Target archive</p> <p>The archive that has this dependency.</p> </div> </td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Component name </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Instant when the dependency was created. </p> </td> </tr> <tr> <td> <p> <strong>dependency_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> The archive set as a dependency. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> Pocket </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>snap_base_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_base">snap_base</a>. </td> <td> <div> <p>Target snap base</p> <p>The snap base that has this dependency.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Archive dependency title. </p> </td> </tr> </table> </div> <div id="archive_dependency-standard-methods" title="archive_dependency-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="archive_permission" title="archive_permission">archive_permission</h3> <p> The interface for ArchivePermission. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><archive.distribution></var>/+archive/<var><archive.name></var>/+name/person.name.[component or source package].name</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The archive that this permission is for.</p> </div> </td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Component Name </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The timestamp when the permission was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_series_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The name of the distro series associated with the package set. </p> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distro series</p> <p>The distro series that this permission is for (only for pocket permissions).</p> </div> </td> </tr> <tr> <td> <p> <strong>explicit</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Explicit</p> <p>Set this flag for package sets with high-profile packages requiring specialist skills for proper handling.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>package_set_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Package set name </p> </td> </tr> <tr> <td> <p> <strong>permission</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The permission type being granted. </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person or team being granted the permission.</p> </div> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The pocket that this permission is for.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Source Package Name </p> </td> </tr> </table> </div> <div id="archive_permission-standard-methods" title="archive_permission-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="archive_subscriber" title="archive_subscriber">archive_subscriber</h3> <p> An interface for archive subscribers. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The archive for this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The timestamp when the subscription was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date of Expiration</p> <p>The timestamp when the subscription will expire.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Free text describing this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Active</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Cancelled</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The status of this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>subscriber_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscriber</p> <p>The person who is subscribed.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="archive_subscriber-standard-methods" title="archive_subscriber-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="archive_subscriber-custom-POSTs" title="archive_subscriber-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="archive_subscriber-cancel" title="archive_subscriber-cancel">cancel</h5> <div> <p>Cancel a subscription.</p> <p>Sets cancelled_by to the supplied person and date_cancelled to the current date/time.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="binary_package_publishing_history" title="binary_package_publishing_history">binary_package_publishing_history</h3> <p> A binary package publishing record. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/+archive/<var><binary_package.name></var>/+binarypub/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>architecture_specific</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture Specific </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The context archive for this publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>binary_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Binary Package Name </p> </td> </tr> <tr> <td> <p> <strong>binary_package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Binary Package Version </p> </td> </tr> <tr> <td> <p> <strong>build_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#build">build</a>. </td> <td> <div> <p>Build</p> <p>The build that produced this binary package.</p> </div> </td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Component Name </p> </td> </tr> <tr> <td> <p> <strong>copied_from_archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Original archive ID where this package was copied from. </p> </td> </tr> <tr> <td> <p> <strong>creator_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Publication Creator</p> <p>The IPerson who created this publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date on which this record was created</p> </div> </td> </tr> <tr> <td> <p> <strong>date_made_pending</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Made Pending</p> <p>The date on which this record was set as pending removal</p> </div> </td> </tr> <tr> <td> <p> <strong>date_published</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Published</p> <p>The date on which this record was published</p> </div> </td> </tr> <tr> <td> <p> <strong>date_removed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Removed</p> <p>The date on which this record was removed from the published set</p> </div> </td> </tr> <tr> <td> <p> <strong>date_superseded</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Superseded</p> <p>The date on which this record was marked superseded</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Text representation of the current record.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <div> <p>Distro Arch Series</p> <p>The distroarchseries being published into</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_debug</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Debug Package</p> <p>Is this a debug package publication?</p> </div> </td> </tr> <tr> <td> <p> <strong>phased_update_percentage</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The percentage of users for whom this package should be recommended, or None to publish the update for everyone </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div> </td> </tr> <tr> <td> <p> <strong>priority_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Priority Name </p> </td> </tr> <tr> <td> <p> <strong>removal_comment</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Removal Comment</p> <p>Reason why this publication is going to be removed.</p> </div> </td> </tr> <tr> <td> <p> <strong>removed_by_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Removed By</p> <p>The Person responsible for the removal</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>scheduled_deletion_date</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Scheduled Deletion Date</p> <p>The date on which this record is scheduled for deletion</p> </div> </td> </tr> <tr> <td> <p> <strong>section_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Section Name </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Source Package Name</p> <p>The source package name that built this binary.</p> </div> </td> </tr> <tr> <td> <p> <strong>source_package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Source Package Version</p> <p>The source package version that built this binary.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Published</tt> </li> <li> <tt>Superseded</tt> </li> <li> <tt>Deleted</tt> </li> <li> <tt>Obsolete</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The status of this publishing record</p> </div> </td> </tr> </table> </div> <div id="binary_package_publishing_history-standard-methods" title="binary_package_publishing_history-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="binary_package_publishing_history-custom-GETs" title="binary_package_publishing_history-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="binary_package_publishing_history-binaryFileUrls" title="binary_package_publishing_history-binaryFileUrls">binaryFileUrls</h5> <div> <p>URLs for this binary publication's binary files.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>binaryFileUrls</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>include_meta</strong> </p> </td> <td> <p></p> </td> <td> <p> Include Metadata </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this binary.</td> </p> </div> <div class="method"> <h5 id="binary_package_publishing_history-getDailyDownloadTotals" title="binary_package_publishing_history-getDailyDownloadTotals">getDailyDownloadTotals</h5> <div> <p>Get the daily download counts for this binary.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getDailyDownloadTotals</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>end_date</strong> </p> </td> <td> <p></p> </td> <td> <p> End date </p> </td> </tr> <tr> <td> <p> <strong>start_date</strong> </p> </td> <td> <p></p> </td> <td> <p> Start date </p> </td> </tr> </table> </div> <div class="method"> <h5 id="binary_package_publishing_history-getDownloadCount" title="binary_package_publishing_history-getDownloadCount">getDownloadCount</h5> <div> <p>Get the download count of this binary package in this archive.</p> <p>This is currently only meaningful for PPAs.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getDownloadCount</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="binary_package_publishing_history-getDownloadCounts" title="binary_package_publishing_history-getDownloadCounts">getDownloadCounts</h5><div> <p>Get detailed download counts for this binary.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDownloadCounts</var></p></td><td></td></tr><tr><td><p><strong>end_date</strong></p></td><td><p></p></td><td><p> End date </p></td></tr><tr><td><p><strong>start_date</strong></p></td><td><p></p></td><td><p> Start date </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#binary_package_release_download_count">binary_package_release_download_count</a> collection. </p> </div> </div> <div id="binary_package_publishing_history-custom-POSTs" title="binary_package_publishing_history-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="binary_package_publishing_history-changeOverride" title="binary_package_publishing_history-changeOverride">changeOverride</h5><div> <p>Change the component/section/priority/phase of this publication.</p> <p>It is changed only if the argument is not None.</p> <p>Passing new_phased_update_percentage=100 has the effect of setting the phased update percentage to None (i.e. recommended for all users).</p> <p>Return the overridden publishing record, a IBinaryPackagePublishingHistory.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>changeOverride</var></p></td><td></td></tr><tr><td><p><strong>new_component</strong></p></td><td><p></p></td><td><p> The new component name. </p></td></tr><tr><td><p><strong>new_phased_update_percentage</strong></p></td><td><p></p></td><td><p> The new phased update percentage. </p></td></tr><tr><td><p><strong>new_priority</strong></p></td><td><p></p></td><td><p> The new priority name. </p></td></tr><tr><td><p><strong>new_section</strong></p></td><td><p></p></td><td><p> The new section name. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#binary_package_publishing_history">binary_package_publishing_history</a>. </p> </div> <div class="method"> <h5 id="binary_package_publishing_history-requestDeletion" title="binary_package_publishing_history-requestDeletion">requestDeletion</h5> <div> <p>Delete this source and its binaries.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>requestDeletion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>removal_comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Removal comment </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="binary_package_release_download_count" title="binary_package_release_download_count">binary_package_release_download_count</h3> <p> Daily download count of a binary package release in an archive. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Archive </p> </td> </tr> <tr> <td> <p> <strong>binary_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Binary package name </p> </td> </tr> <tr> <td> <p> <strong>binary_package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Binary package version </p> </td> </tr> <tr> <td> <p> <strong>count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Number of downloads </p> </td> </tr> <tr> <td> <p> <strong>country_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#country">country</a>. </td> <td> <p> Country </p> </td> </tr> <tr> <td> <p> <strong>day</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Day of the downloads </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="binary_package_release_download_count-standard-methods" title="binary_package_release_download_count-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="branch" title="branch">branch</h3> <p> A Bazaar branch. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><author.name></var>/<var><project.name></var>/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_format</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>!Unrecognized!</tt> </li> <li> <tt>Fake Bazaar Branch 4 marker</tt> </li> <li> <tt>Bazaar-NG Branch Reference Format 1 </tt> </li> <li> <tt>Bazaar-NG branch format 5 </tt> </li> <li> <tt>Bazaar Branch Format 6 (bzr 0.15) </tt> </li> <li> <tt>Bazaar Branch Format 7 (needs bzr 1.6) </tt> </li> <li> <tt>Bazaar Branch Format 8 (needs bzr 1.15) </tt> </li> <li> <tt>Bazaar-NG Loom branch format 1 </tt> </li> <li> <tt>Bazaar-NG Loom branch format 6 </tt> </li> <li> <tt>Bazaar-NG Loom branch format 7 </tt> </li> </ul> </td> <td> <p> Branch Format </p> </td> </tr> <tr> <td> <p> <strong>branch_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Hosted</tt> </li> <li> <tt>Mirrored</tt> </li> <li> <tt>Imported</tt> </li> <li> <tt>Remote</tt> </li> </ul> </td> <td> <p> Branch Type </p> </td> </tr> <tr> <td> <p> <strong>bzr_identity</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Bazaar Identity</p> <p>The bzr branch path as accessed by Launchpad. If the branch is associated with a product as the primary development focus, then the result should be lp:product. If the branch is related to a series, then lp:product/series. Otherwise the result is lp:~user/product/branch-name.</p> </div> </td> </tr> <tr> <td> <p> <strong>code_import_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#code_import">code_import</a>. </td> <td> <p> The associated CodeImport, if any. </p> </td> </tr> <tr> <td> <p> <strong>control_format</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>!Unrecognized!</tt> </li> <li> <tt>Bazaar-NG branch, format 0.0.4 </tt> </li> <li> <tt>Bazaar-NG branch, format 5 </tt> </li> <li> <tt>Bazaar-NG branch, format 6 </tt> </li> <li> <tt>Bazaar-NG meta directory, format 1 </tt> </li> <li> <tt>Bazaar meta directory, format 1 (with colocated branches) </tt> </li> </ul> </td> <td> <p> Control Directory </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Date Last Modified </p> </td> </tr> <tr> <td> <p> <strong>dependent_branches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Dependent Branches</p> <p>A collection of the merge proposals that are dependent on this branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of the changes in this branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Display name</p> <p>The branch unique_name.</p> </div> </td> </tr> <tr> <td> <p> <strong>explicitly_private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Keep branch confidential</p> <p>Make this branch visible only to its subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of information contained in this branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>landing_candidates_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing Candidates</p> <p>A collection of the merge proposals where this branch is the target branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>landing_targets_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing Targets</p> <p>A collection of the merge proposals where this branch is the source branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>last_mirror_attempt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Last time a mirror of this branch was attempted. </p> </td> </tr> <tr> <td> <p> <strong>last_mirrored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Last time this branch was successfully mirrored. </p> </td> </tr> <tr> <td> <p> <strong>last_scanned</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Last time this branch was successfully scanned. </p> </td> </tr> <tr> <td> <p> <strong>last_scanned_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Last scanned revision ID</p> <p>The head revision ID of the branch when last successfully scanned.</p> </div> </td> </tr> <tr> <td> <p> <strong>lifecycle_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Development</tt> </li> <li> <tt>Mature</tt> </li> <li> <tt>Merged</tt> </li> <li> <tt>Abandoned</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>linked_bugs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> The bugs linked to this branch. </p> </td> </tr> <tr> <td> <p> <strong>mirror_status_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The last message we got when mirroring this branch. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>Either yourself or an exclusive team you are a member of. This controls who can modify the branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Branch is confidential</p> <p>This branch is visible only to its subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project">project</a>. </td> <td> <div> <p>Project</p> <p>The project this branch belongs to.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user that registered the branch. </p> </td> </tr> <tr> <td> <p> <strong>repository_format</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>!Unrecognized!</tt> </li> <li> <tt>Fake Bazaar repository 4 marker</tt> </li> <li> <tt>Fake Bazaar repository 5 marker</tt> </li> <li> <tt>Fake Bazaar repository 6 marker</tt> </li> <li> <tt>Bazaar-NG Repository format 7</tt> </li> <li> <tt>Bazaar-NG Knit Repository Format 1</tt> </li> <li> <tt>Bazaar Knit Repository Format 3 (bzr 0.15) </tt> </li> <li> <tt>Bazaar Knit Repository Format 4 (bzr 1.0) </tt> </li> <li> <tt>Bazaar pack repository format 1 (needs bzr 0.92) </tt> </li> <li> <tt>Bazaar pack repository format 1 with subtree support (needs bzr 0.92) </tt> </li> <li> <tt>Bazaar pack repository format 1 with rich root (needs bzr 1.0) </tt> </li> <li> <tt>Bazaar RepositoryFormatKnitPack5 (bzr 1.6) </tt> </li> <li> <tt>Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6) </tt> </li> <li> <tt>Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1) </tt> </li> <li> <tt>Bazaar RepositoryFormatKnitPack6 (bzr 1.9) </tt> </li> <li> <tt>Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9) </tt> </li> <li> <tt>Bazaar development format 0 (needs bzr.dev from before 1.3) </tt> </li> <li> <tt>Bazaar development format 0 with subtree support (needs bzr.dev from before 1.3) </tt> </li> <li> <tt>Bazaar development format 1 (needs bzr.dev from before 1.6) </tt> </li> <li> <tt>Bazaar development format 1 with subtree support (needs bzr.dev from before 1.6) </tt> </li> <li> <tt>Bazaar development format 2 (needs bzr.dev from before 1.8) </tt> </li> <li> <tt>Bazaar development format 2 with subtree support (needs bzr.dev from before 1.8) </tt> </li> <li> <tt>Bazaar development format 8 </tt> </li> <li> <tt>Bazaar development format - group compression and chk inventory (needs bzr.dev from 1.14) </tt> </li> <li> <tt>Bazaar development format - chk repository with bencode revision serialization (needs bzr.dev from 1.16) </tt> </li> <li> <tt>Bazaar repository format 2a (needs bzr 1.16 or later) </tt> </li> </ul> </td> <td> <p> Repository Format </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Review Team</p> <p>The reviewer of a branch is the person or exclusive team that is responsible for reviewing proposals and merging into this branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>revision_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Revision count</p> <p>The revision number of the tip of the branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>sourcepackage_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package">source_package</a>. </td> <td> <p> The ISourcePackage that this branch belongs to. None if not a package branch. </p> </td> </tr> <tr> <td> <p> <strong>spec_links_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification_branch">specification_branch</a> collection. </td> <td> <p> Specification linked to this branch. </p> </td> </tr> <tr> <td> <p> <strong>subscribers_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Persons subscribed to this branch. </p> </td> </tr> <tr> <td> <p> <strong>subscriptions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_subscription">branch_subscription</a> collection. </td> <td> <p> BranchSubscriptions associated to this branch. </p> </td> </tr> <tr> <td> <p> <strong>unique_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Unique name</p> <p>Unique name of the branch, including the owner and project names.</p> </div> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Branch URL</p> <p>The external location where the Bazaar branch is hosted. It is None when the branch is hosted by Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> <tr> <td> <p> <strong>whiteboard</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Whiteboard</p> <p>Notes on the current status of the branch.</p> </div> </td> </tr> </table> </div> <div id="branch-standard-methods" title="branch-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="branch-custom-GETs" title="branch-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="branch-canBeDeleted" title="branch-canBeDeleted">canBeDeleted</h5> <div> <p>Can this branch be deleted in its current state.</p> <p>A branch is considered deletable if it has no revisions and is not linked to any bugs, specs, productseries, or code imports.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeDeleted</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-composePublicURL" title="branch-composePublicURL">composePublicURL</h5> <div> <p>Return a public URL for the branch using the given protocol.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>composePublicURL</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>scheme</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> URL scheme </p> </td> </tr> </table> </div> <div class="method"><h5 id="branch-getMergeProposals" title="branch-getMergeProposals">getMergeProposals</h5><p> Return matching BranchMergeProposals. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>merged_revnos</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="branch-getSubscription" title="branch-getSubscription">getSubscription</h5><p> Return the BranchSubscription for this person. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> The person to search for </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_subscription">branch_subscription</a>. </p> </div> <div class="method"> <h5 id="branch-isPersonTrustedReviewer" title="branch-isPersonTrustedReviewer">isPersonTrustedReviewer</h5> <div> <p>Return true if the reviewer is a trusted reviewer.</p> <p>The reviewer is trusted if they are either own the branch, or are in the team that owns the branch, or they are in the review team for the branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isPersonTrustedReviewer</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>reviewer</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> A person for which the reviewer status is in question. </p> </td> </tr> </table> </div> </div> <div id="branch-custom-POSTs" title="branch-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="branch-createMergeProposal" title="branch-createMergeProposal">createMergeProposal</h5><div> <p>Create a new BranchMergeProposal with this branch as the source.</p> <p>Both the target_branch and the prerequisite_branch, if it is there, must be branches with the same target as the source branch.</p> <p>Personal branches (a.k.a. junk branches) cannot specify landing targets.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createMergeProposal</var></p></td><td></td></tr><tr><td><p><strong>commit_message</strong></p></td><td><p></p></td><td><div> <p>Commit message</p> <p>Message to use when committing this merge.</p> </div></td></tr><tr><td><p><strong>initial_comment</strong></p></td><td><p></p></td><td><div> <p>Initial comment</p> <p>Registrant's initial description of proposal.</p> </div></td></tr><tr><td><p><strong>needs_review</strong></p></td><td><p></p></td><td><div> <p>Needs review</p> <p>If True the proposal needs review.Otherwise, it will be work in progress.</p> </div></td></tr><tr><td><p><strong>prerequisite_branch</strong></p></td><td><p></p> Link to a <a href="#branch">branch</a>. </td><td></td></tr><tr><td><p><strong>review_types</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>reviewers</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>target_branch</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#branch">branch</a>. </td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#branch_merge_proposal">branch_merge_proposal</a>. </p> </div> <div class="method"> <h5 id="branch-linkBug" title="branch-linkBug">linkBug</h5> <div> <p>Link a bug to this branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-linkSpecification" title="branch-linkSpecification">linkSpecification</h5> <div> <p>Link an ISpecification to a branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkSpecification</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>spec</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#specification">specification</a>. </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="branch-newWebhook" title="branch-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"> <h5 id="branch-requestMirror" title="branch-requestMirror">requestMirror</h5> <p> Request that this branch be mirrored on the next run of the branch puller. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>requestMirror</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-rescan" title="branch-rescan">rescan</h5> <div> <p>Reset this branch's scan data and request a rescan.</p> <p>A convenience function wrapper around unscan().</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescan</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-setOwner" title="branch-setOwner">setOwner</h5> <p> Set the owner of the branch to be new_owner. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setOwner</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_owner</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The new owner of the branch. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="branch-setTarget" title="branch-setTarget">setTarget</h5> <div> <p>Set the target of the branch to be project or source_package.</p> <p>Only one of project or source_package can be set, and if neither is set, the branch gets moved into the junk namespace of the branch owner.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setTarget</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>project</strong> </p> </td> <td><p></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project the branch belongs to. </p> </td> </tr> <tr> <td> <p> <strong>source_package</strong> </p> </td> <td><p></p> Link to a <a href="#source_package">source_package</a>. </td> <td> <p> The source package the branch belongs to. </p> </td> </tr> </table> <h6>Errors</h6> <ul> <li> <td class="rst-field-body">BranchTargetError if both project and source_package are set, or if either the project or source_package fail to be adapted to an IBranchTarget.</td> </li> </ul> </div> <div class="method"><h5 id="branch-subscribe" title="branch-subscribe">subscribe</h5><div> <p>Subscribe this person to the branch.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>subscribe</var></p></td><td></td></tr><tr><td><p><strong>code_review_level</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>No email</tt></li><li><tt>Status changes only</tt></li><li><tt>Email about all changes</tt></li></ul></td><td><p> The level of code review notification emails. </p></td></tr><tr><td><p><strong>max_diff_lines</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Don't send diffs</tt></li><li><tt>500 lines</tt></li><li><tt>1000 lines</tt></li><li><tt>5000 lines</tt></li><li><tt>Send entire diff</tt></li></ul></td><td><p> The max number of lines for diff email. </p></td></tr><tr><td><p><strong>notification_level</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>No email</tt></li><li><tt>Branch attribute notifications only</tt></li><li><tt>Branch revision notifications only</tt></li><li><tt>Branch attribute and revision notifications</tt></li></ul></td><td><p> The level of notification to subscribe to. </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> The person to subscribe. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_subscription">branch_subscription</a>. </p> </div> <div class="method"> <h5 id="branch-transitionToInformationType" title="branch-transitionToInformationType">transitionToInformationType</h5> <div> <p>Set the information type for this branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>transitionToInformationType</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of information contained in this branch.</p> </div> </td> </tr> </table> </div> <div class="method"> <h5 id="branch-unlinkBug" title="branch-unlinkBug">unlinkBug</h5> <div> <p>Unlink a bug to this branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-unlinkSpecification" title="branch-unlinkSpecification">unlinkSpecification</h5> <div> <p>Unlink an ISpecification to a branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkSpecification</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>spec</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#specification">specification</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch-unscan" title="branch-unscan">unscan</h5> <p> Reset this branch's scan data and optionally request a scan. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unscan</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>rescan</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Scan the branch after resetting its scan data. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="branch-unsubscribe" title="branch-unsubscribe">unsubscribe</h5> <div> <p>Remove the person's subscription to this branch.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person to unsubscribe </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="branch_merge_proposal" title="branch_merge_proposal">branch_merge_proposal</h3> <p> Branch merge proposals show intent of landing one branch on another. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><author.name></var>/<var><project.name></var>/<var><branch.name></var>/+merge/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>address</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>The email address for this proposal.</p> <p>Any emails sent to this address will resultin comments being added.</p> </div> </td> </tr> <tr> <td> <p> <strong>all_comments_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#code_review_comment">code_review_comment</a> collection. </td> <td> <p> All messages discussing this merge proposal </p> </td> </tr> <tr> <td> <p> <strong>bugs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> Bugs related to this object. </p> </td> </tr> <tr> <td> <p> <strong>commit_message</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Commit message</p> <p>The commit message that should be used when merging the source branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_merged</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date merged</p> <p>The date that the source branch was merged into the target branch</p> </div> </td> </tr> <tr> <td> <p> <strong>date_review_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date review requested </p> </td> </tr> <tr> <td> <p> <strong>date_reviewed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date reviewed </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A detailed description of the changes that are being addressed by the branch being proposed to be merged.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>merge_reporter_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Merge reporter</p> <p>The user that marked the branch as merged.</p> </div> </td> </tr> <tr> <td> <p> <strong>merged_revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Merged revision ID</p> <p>The revision ID on the target branch which contains the merge from the source branch (currently Git only).</p> </div> </td> </tr> <tr> <td> <p> <strong>merged_revno</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Merged revision number</p> <p>The revision number on the target branch which contains the merge from the source branch (Bazaar only).</p> </div> </td> </tr> <tr> <td> <p> <strong>prerequisite_branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Prerequisite branch</p> <p>The branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.</p> </div> </td> </tr> <tr> <td> <p> <strong>prerequisite_git_path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Prerequisite Git branch path</p> <p>The path of the Git branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.</p> </div> </td> </tr> <tr> <td> <p> <strong>prerequisite_git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Prerequisite Git repository</p> <p>The Git repository containing the branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.</p> </div> </td> </tr> <tr> <td> <p> <strong>preview_diff_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#preview_diff">preview_diff</a>. </td> <td> <p> The current diff of the source branch against the target branch. </p> </td> </tr> <tr> <td> <p> <strong>preview_diffs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#preview_diff">preview_diff</a> collection. </td> <td> <p> All preview diffs for this merge proposal. </p> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Proposal is confidential</p> <p>If True, this proposal is visible only to subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>queue_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Work in progress</tt> </li> <li> <tt>Needs review</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Rejected</tt> </li> <li> <tt>Merged</tt> </li> <li> <tt>Code failed to merge</tt> </li> <li> <tt>Queued</tt> </li> <li> <tt>Superseded</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current state of the proposal.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person who registered the merge proposal.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewed_revid</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The revision id that has been approved by the reviewer. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Review person or team</p> <p>The person that accepted (or rejected) the code for merging.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Source branch</p> <p>The branch that has code to land.</p> </div> </td> </tr> <tr> <td> <p> <strong>source_git_path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Source Git branch path</p> <p>The path of the Git branch that has code to land.</p> </div> </td> </tr> <tr> <td> <p> <strong>source_git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Source Git repository</p> <p>The Git repository that has code to land.</p> </div> </td> </tr> <tr> <td> <p> <strong>superseded_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <div> <p>Superseded by</p> <p>The branch merge proposal that supersedes this one.</p> </div> </td> </tr> <tr> <td> <p> <strong>supersedes_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <div> <p>Supersedes</p> <p>The branch merge proposal that this one supersedes.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Target branch</p> <p>The branch that the source branch will be merged into.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_git_path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Target Git branch path</p> <p>The path of the Git branch that the source branch will be merged into.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Target Git repository</p> <p>The Git repository that the source branch will be merged into.</p> </div> </td> </tr> <tr> <td> <p> <strong>votes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#code_review_vote_reference">code_review_vote_reference</a> collection. </td> <td> <p> The votes cast or expected for this proposal </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="branch_merge_proposal-standard-methods" title="branch_merge_proposal-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="branch_merge_proposal-custom-GETs" title="branch_merge_proposal-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="branch_merge_proposal-getComment" title="branch_merge_proposal-getComment">getComment</h5><div> <p>Return the CodeReviewComment with the specified ID.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getComment</var></p></td><td></td></tr><tr><td><p><strong>id</strong></p></td><td><p><small>(required)</small></p></td><td><p> A CodeReviewComment ID. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#code_review_comment">code_review_comment</a>. </p> </div> <div class="method"> <h5 id="branch_merge_proposal-getDraftInlineComments" title="branch_merge_proposal-getDraftInlineComments">getDraftInlineComments</h5> <div> <p>Return the draft inline comments related to this MP.</p> <p>The return value is a dictionary (object) where the keys are the diff lines and their values are the actual draft comment created by the given person.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getDraftInlineComments</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>previewdiff_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch_merge_proposal-getInlineComments" title="branch_merge_proposal-getInlineComments">getInlineComments</h5> <div> <p>Return a list of inline comments related to this MP.</p> <p>The return value is an list of dictionaries (objects), each one representing a comment with 'line_number', 'person', 'text' and 'date' attributes.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getInlineComments</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>previewdiff_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="branch_merge_proposal-getRelatedBugTasks" title="branch_merge_proposal-getRelatedBugTasks">getRelatedBugTasks</h5><p> Return the Bug tasks related to this merge proposal. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRelatedBugTasks</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <div id="branch_merge_proposal-custom-POSTs" title="branch_merge_proposal-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="branch_merge_proposal-createComment" title="branch_merge_proposal-createComment">createComment</h5><div> <p>Create an ICodeReviewComment associated with this merge proposal.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createComment</var></p></td><td></td></tr><tr><td><p><strong>content</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>inline_comments</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>parent</strong></p></td><td><p></p> Link to a <a href="#code_review_comment">code_review_comment</a>. </td><td></td></tr><tr><td><p><strong>previewdiff_id</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>review_type</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>subject</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>vote</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approve</tt></li><li><tt>Needs Fixing</tt></li><li><tt>Needs Information</tt></li><li><tt>Abstain</tt></li><li><tt>Disapprove</tt></li><li><tt>Needs Resubmitting</tt></li></ul></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#code_review_comment">code_review_comment</a>. </p> </div> <div class="method"> <h5 id="branch_merge_proposal-linkBug" title="branch_merge_proposal-linkBug">linkBug</h5> <p> Link a bug to this merge proposal. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="branch_merge_proposal-nominateReviewer" title="branch_merge_proposal-nominateReviewer">nominateReviewer</h5><div> <p>Set the specified person as a reviewer.</p> <p>If they are not already a reviewer, a vote is created. Otherwise, the details are updated.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>nominateReviewer</var></p></td><td></td></tr><tr><td><p><strong>review_type</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>reviewer</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> A reviewer. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#code_review_vote_reference">code_review_vote_reference</a>. </p> </div> <div class="method"> <h5 id="branch_merge_proposal-saveDraftInlineComment" title="branch_merge_proposal-saveDraftInlineComment">saveDraftInlineComment</h5> <div> <p>Save ICodeReviewInlineCommentDraft</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>saveDraftInlineComment</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comments</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>previewdiff_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch_merge_proposal-scheduleDiffUpdates" title="branch_merge_proposal-scheduleDiffUpdates">scheduleDiffUpdates</h5> <div> <p>Schedule updates of the diffs for this proposal.</p> <p>This can be used if the previous attempt to generate diffs crashed, or if Launchpad failed to notice that the current diffs are outdated for some reason.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>scheduleDiffUpdates</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="branch_merge_proposal-setCommentVisibility" title="branch_merge_proposal-setCommentVisibility">setCommentVisibility</h5> <div> <p>Set the visible attribute on a code review comment.</p> <p>This is restricted to Launchpad admins, registry experts, and comment authors, and will return a HTTP Error 401: Unauthorized error for non-admin callers.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setCommentVisibility</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment_number</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The comment ID. </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Show this comment? </p> </td> </tr> </table> </div> <div class="method"> <h5 id="branch_merge_proposal-setStatus" title="branch_merge_proposal-setStatus">setStatus</h5> <div> <p>Set the state of the merge proposal to the specified status.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>revid</strong> </p> </td> <td> <p></p> </td> <td> <p> An optional parameter for specifying the revision of the branch for the status change. </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Work in progress</tt> </li> <li> <tt>Needs review</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Rejected</tt> </li> <li> <tt>Merged</tt> </li> <li> <tt>Code failed to merge</tt> </li> <li> <tt>Queued</tt> </li> <li> <tt>Superseded</tt> </li> </ul> </td> <td> <p> The new status of the merge proposal. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="branch_merge_proposal-unlinkBug" title="branch_merge_proposal-unlinkBug">unlinkBug</h5> <p> Unlink a bug from this merge proposal. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="branch_subscription" title="branch_subscription">branch_subscription</h3> <p> The relationship between a person and a branch. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <p> Branch ID </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>max_diff_lines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Don't send diffs</tt> </li> <li> <tt>500 lines</tt> </li> <li> <tt>1000 lines</tt> </li> <li> <tt>5000 lines</tt> </li> <li> <tt>Send entire diff</tt> </li> </ul> </td> <td> <div> <p>Generated Diff Size Limit</p> <p>Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.</p> </div> </td> </tr> <tr> <td> <p> <strong>notification_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>No email</tt> </li> <li> <tt>Branch attribute notifications only</tt> </li> <li> <tt>Branch revision notifications only</tt> </li> <li> <tt>Branch attribute and revision notifications</tt> </li> </ul> </td> <td> <div> <p>Notification Level</p> <p>Attribute notifications are sent when branch details are changed such as lifecycle status and name. Revision notifications are generated when new branch revisions are found due to the branch being updated through either pushes to the hosted branches or the mirrored branches being updated.</p> </div> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>Enter the launchpad id, or email address of the person you wish to subscribe to this branch. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>review_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>No email</tt> </li> <li> <tt>Status changes only</tt> </li> <li> <tt>Email about all changes</tt> </li> </ul> </td> <td> <div> <p>Code review Level</p> <p>Control the kind of review activity that triggers notifications.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscribed_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscribed by</p> <p>The person who created this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="branch_subscription-standard-methods" title="branch_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="branch_subscription-custom-GETs" title="branch_subscription-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="branch_subscription-canBeUnsubscribedByUser" title="branch_subscription-canBeUnsubscribedByUser">canBeUnsubscribedByUser</h5> <p> Can the user unsubscribe the subscriber from the branch? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeUnsubscribedByUser</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug" title="bug">bug</h3> <p> The core bug entry. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>activity_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_activity">bug_activity</a> collection. </td> <td> <p> Log of activity that has occurred on this bug. </p> </td> </tr> <tr> <td> <p> <strong>attachments_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_attachment">bug_attachment</a> collection. </td> <td> <p> List of bug attachments. </p> </td> </tr> <tr> <td> <p> <strong>bug_tasks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_task">bug_task</a> collection. </td> <td> <p> BugTasks on this bug, sorted upstream, then by ubuntu, then by other distroseries. </p> </td> </tr> <tr> <td> <p> <strong>bug_watches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_watch">bug_watch</a> collection. </td> <td> <p> All bug watches associated with this bug. </p> </td> </tr> <tr> <td> <p> <strong>cves_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#cve">cve</a> collection. </td> <td> <p> CVE entries related to this bug. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_last_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date of last bug message </p> </td> </tr> <tr> <td> <p> <strong>date_last_updated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Last Updated </p> </td> </tr> <tr> <td> <p> <strong>date_made_private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Made Private </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A detailed description of the problem, including the steps required to reproduce it.</p> </div> </td> </tr> <tr> <td> <p> <strong>duplicate_of_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Duplicate Of </p> </td> </tr> <tr> <td> <p> <strong>duplicates_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> MultiJoin of bugs which are dupes of this one. </p> </td> </tr> <tr> <td> <p> <strong>heat</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The 'heat' of the bug </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Bug ID </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of information contained in this bug report.</p> </div> </td> </tr> <tr> <td> <p> <strong>latest_patch_uploaded</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date when the most recent patch was uploaded. </p> </td> </tr> <tr> <td> <p> <strong>linked_branches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_branch">bug_branch</a> collection. </td> <td> <p> Bazaar branches associated with this bug, usually branches on which this bug is being fixed. </p> </td> </tr> <tr> <td> <p> <strong>linked_merge_proposals_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <p> Merge proposals associated with this bug (currently only Git-based merge proposals). </p> </td> </tr> <tr> <td> <p> <strong>lock_reason</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Lock Reason</p> <p>The reason for locking this bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>lock_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unlocked</tt> </li> <li> <tt>Comment-only</tt> </li> </ul> </td> <td> <div> <p>Lock Status</p> <p>The lock status of this bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>message_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of comments on this bug </p> </td> </tr> <tr> <td> <p> <strong>messages_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message">message</a> collection. </td> <td> <p> The messages related to this object, in reverse order of creation (so newest first). </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Nickname</p> <p>A short and unique name. Add one only if you often need to retype the URL but have trouble remembering the bug number.</p> </div> </td> </tr> <tr> <td> <p> <strong>number_of_duplicates</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of bugs marked as duplicates of this bug </p> </td> </tr> <tr> <td> <p> <strong>other_users_affected_count_with_dupes</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of users affected by this bug (including duplicates), excluding the current user </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The owner's IPerson </p> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>This bug report should be private</p> <p>Private bug reports are visible only to their subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>security_related</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> This bug is a security vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscriptions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_subscription">bug_subscription</a> collection. </td> <td> <p> Subscriptions </p> </td> </tr> <tr> <td> <p> <strong>tags</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Tags</p> <p>Space-separated keywords for classifying this bug report.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A one-line summary of the problem.</p> </div> </td> </tr> <tr> <td> <p> <strong>users_affected_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> The number of users affected by this bug (not including duplicates) </p> </td> </tr> <tr> <td> <p> <strong>users_affected_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of users affected by this bug (not including duplicates) </p> </td> </tr> <tr> <td> <p> <strong>users_affected_count_with_dupes</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of users affected by this bug (including duplicates) </p> </td> </tr> <tr> <td> <p> <strong>users_affected_with_dupes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Users affected (including duplicates) </p> </td> </tr> <tr> <td> <p> <strong>users_unaffected_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Users explicitly marked as unaffected (not including duplicates) </p> </td> </tr> <tr> <td> <p> <strong>users_unaffected_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of users unaffected by this bug </p> </td> </tr> <tr> <td> <p> <strong>vulnerabilities_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#vulnerability">vulnerability</a> collection. </td> <td> <p> Vulnerability instances related to this bug. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>who_made_private_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Who Made Private</p> <p>The person who set this bug private.</p> </div> </td> </tr> </table> </div> <div id="bug-standard-methods" title="bug-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug-custom-GETs" title="bug-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="bug-canBeNominatedFor" title="bug-canBeNominatedFor">canBeNominatedFor</h5> <div> <p>Can this bug nominated for this target?</p> <p>Returns True or False.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeNominatedFor</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>target</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td> <td> <p> Target </p> </td> </tr> </table> </div> <div class="method"><h5 id="bug-getNominationFor" title="bug-getNominationFor">getNominationFor</h5><div> <p>Return the IBugNomination for the target.</p> <p>If no nomination is found, a NotFoundError is raised.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getNominationFor</var></p></td><td></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td><td><p> Target </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_nomination">bug_nomination</a>. </p> </div> <div class="method"><h5 id="bug-getNominations" title="bug-getNominations">getNominations</h5><div> <p>Return a list of all IBugNominations for this bug.</p> <p>The list is ordered by IBugNominations.target.bugtargetdisplayname.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getNominations</var></p></td><td></td></tr><tr><td><p><strong>nominations</strong></p></td><td><p></p></td><td><p> Nominations to search through. </p></td></tr><tr><td><p><strong>target</strong></p></td><td><p></p> Link to a <a href="#bug_target">bug_target</a>. </td><td><p> Target </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_nomination">bug_nomination</a> collection. </p> </div> <div class="method"> <h5 id="bug-getVisibleLinkedBranches" title="bug-getVisibleLinkedBranches">getVisibleLinkedBranches</h5> <p> Return all the branches linked to the bug that user can see. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getVisibleLinkedBranches</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-getVisibleLinkedMergeProposals" title="bug-getVisibleLinkedMergeProposals">getVisibleLinkedMergeProposals</h5> <p> Return all the MPs linked to the bug that user can see. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getVisibleLinkedMergeProposals</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-isExpirable" title="bug-isExpirable">isExpirable</h5> <div> <p>Is this bug eligible for expiration and was it last updated more than X days ago?</p> <p>If days_old is None the default number of days without activity is used.</p> <p>Returns True or False.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isExpirable</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>days_old</strong> </p> </td> <td> <p></p> </td> <td> <p> Number of days of inactivity for which to check. </p> </td> </tr> </table> </div> </div> <div id="bug-custom-POSTs" title="bug-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="bug-addAttachment" title="bug-addAttachment">addAttachment</h5><div> <p>Attach a file to this bug.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addAttachment</var></p></td><td></td></tr><tr><td><p><strong>comment</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>content_type</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>data</strong></p></td><td><p></p> Link to a file resource. </td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>filename</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>is_patch</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>url</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_attachment">bug_attachment</a>. </p> </div> <div class="method"><h5 id="bug-addNomination" title="bug-addNomination">addNomination</h5><div> <p>Nominate a bug for an IDistroSeries or IProductSeries.</p> <p>This method creates and returns a BugNomination. (See lp.bugs.model.bugnomination.BugNomination.)</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addNomination</var></p></td><td></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td><td><p> Target </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_nomination">bug_nomination</a>. </p> </div> <div class="method"><h5 id="bug-addTask" title="bug-addTask">addTask</h5><div> <p>Create a new bug task on this bug.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addTask</var></p></td><td></td></tr><tr><td><p><strong>target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td><td><div> <p>Target</p> <p>The software in which this bug should be fixed.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_task">bug_task</a>. </p> </div> <div class="method"><h5 id="bug-addWatch" title="bug-addWatch">addWatch</h5><p> Create a new watch for this bug on the given remote bug and bug tracker, owned by the person given as the owner. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addWatch</var></p></td><td></td></tr><tr><td><p><strong>bug_tracker</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#bug_tracker">bug_tracker</a>. </td><td><div> <p>Bug System</p> <p>You can register new bug trackers from the Launchpad Bugs home page.</p> </div></td></tr><tr><td><p><strong>remote_bug</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Remote Bug</p> <p>The bug number of this bug in the remote bug tracker.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_watch">bug_watch</a>. </p> </div> <div class="method"> <h5 id="bug-isUserAffected" title="bug-isUserAffected">isUserAffected</h5> <p> Is :user: marked as affected by this bug? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isUserAffected</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-linkBranch" title="bug-linkBranch">linkBranch</h5> <div> <p>Associate a branch with this bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkBranch</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch">branch</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-linkCVE" title="bug-linkCVE">linkCVE</h5> <p> Ensure that this CVE is linked to this bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkCVE</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>cve</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#cve">cve</a>. </td> <td> <p> CVE </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-linkMergeProposal" title="bug-linkMergeProposal">linkMergeProposal</h5> <p> Ensure that this MP is linked to this bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkMergeProposal</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>merge_proposal</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <p> Merge proposal </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-lock" title="bug-lock">lock</h5> <div> <p>Lock the bug metadata edits to the relevant roles.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>lock</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>reason</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Lock Reason</p> <p>The reason for locking this bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Comment-only</tt> </li> </ul> </td> <td> <div> <p>Lock Status</p> <p>The lock status of this bug.</p> </div> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-markUserAffected" title="bug-markUserAffected">markUserAffected</h5> <p> Mark :user: as affected by this bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>markUserAffected</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>affected</strong> </p> </td> <td> <p></p> </td> <td> <p> Does this bug affect you? </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-mute" title="bug-mute">mute</h5> <p> Add a muted subscription for person. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>mute</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> <div class="method"><h5 id="bug-newMessage" title="bug-newMessage">newMessage</h5><p> Create a new message, and link it to this object. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newMessage</var></p></td><td></td></tr><tr><td><p><strong>content</strong></p></td><td><p><small>(required)</small></p></td><td><p> Message </p></td></tr><tr><td><p><strong>send_notifications</strong></p></td><td><p></p></td><td><p> Enable email notifications for adding this comment. </p></td></tr><tr><td><p><strong>subject</strong></p></td><td><p></p></td><td><p> Subject </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#message">message</a>. </p> </div> <div class="method"> <h5 id="bug-setCommentVisibility" title="bug-setCommentVisibility">setCommentVisibility</h5> <p> Set the visible attribute on a bug comment. This is restricted to Launchpad admins, and will return a HTTP Error 401: Unauthorized error for non-admin callers. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setCommentVisibility</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment_number</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The number of the comment in the list of messages. </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Show this comment? </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-subscribe" title="bug-subscribe">subscribe</h5> <div> <p>Subscribe person to the bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>subscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>level</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Lifecycle</tt> </li> <li> <tt>Details</tt> </li> <li> <tt>Discussion</tt> </li> </ul> </td> <td> <p> Level </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">an IBugSubscription.</td> </p> </div> <div class="method"> <h5 id="bug-transitionToInformationType" title="bug-transitionToInformationType">transitionToInformationType</h5> <div> <p>Set the information type for this bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>transitionToInformationType</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of information contained in this bug report.</p> </div> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-unlinkBranch" title="bug-unlinkBranch">unlinkBranch</h5> <div> <p>Unlink a branch from this bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkBranch</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch">branch</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-unlinkCVE" title="bug-unlinkCVE">unlinkCVE</h5> <p> Ensure that any links between this bug and the given CVE are removed. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkCVE</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>cve</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#cve">cve</a>. </td> <td> <p> CVE </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-unlinkMergeProposal" title="bug-unlinkMergeProposal">unlinkMergeProposal</h5> <p> Ensure that any links between this bug and the given MP are removed. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkMergeProposal</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>merge_proposal</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <p> Merge proposal </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-unlock" title="bug-unlock">unlock</h5> <div> <p>Unlock the bug metadata edits to the default roles.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlock</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug-unmute" title="bug-unmute">unmute</h5> <div> <p>Remove a muted subscription for person.</p> <p>Returns previously muted direct subscription, if any.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unmute</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-unsubscribe" title="bug-unsubscribe">unsubscribe</h5> <p> Remove this person's subscription to this bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> <div class="method"> <h5 id="bug-unsubscribeFromDupes" title="bug-unsubscribeFromDupes">unsubscribeFromDupes</h5> <p> Remove this person's subscription from all dupes of this bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribeFromDupes</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_activity" title="bug_activity">bug_activity</h3> <p> A log of all things that have happened to a bug. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Bug </p> </td> </tr> <tr> <td> <p> <strong>datechanged</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Changed</p> <p>The date on which this activity occurred.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Message</p> <p>Additional information about what changed.</p> </div> </td> </tr> <tr> <td> <p> <strong>newvalue</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>New Value</p> <p>The value after the change.</p> </div> </td> </tr> <tr> <td> <p> <strong>oldvalue</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Old Value</p> <p>The value before the change.</p> </div> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person's Launchpad ID or email address.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>whatchanged</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>What Changed</p> <p>The property of the bug that changed.</p> </div> </td> </tr> </table> </div> <div id="bug_activity-standard-methods" title="bug_activity-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_attachment" title="bug_attachment">bug_attachment</h3> <div> <p>A file attachment to an IBug.</p> <p>Launchpadlib example of accessing content of an attachment:</p> <pre class="rst-literal-block"> for attachment in bug.attachments: buffer = attachment.data.open() for line in buffer: print(line) buffer.close() </pre> <p>Launchpadlib example of accessing metadata about an attachment:</p> <pre class="rst-literal-block"> attachment = bug.attachments[0] print("title:", attachment.title) print("ispatch:", attachment.type) </pre> <p>For information about the file-like object returned by attachment.data.open() see lazr.restfulclient's documentation of the HostedFile object.</p> <p>Details about the message associated with an attachment can be found on the "message" attribute:</p> <pre class="rst-literal-block"> message = attachment.message print("subject:", message.subject) print("owner:", message.owner.display_name) print("created:", message.date_created) </pre> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/<var><bug.id></var>/+attachment/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> The bug the attachment belongs to. </p> </td> </tr> <tr> <td> <p> <strong>data_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a file resource. </td> <td> <p> The attachment content. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>message_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#message">message</a>. </td> <td> <p> The message that was created when we added this attachment. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>A short and descriptive description of the attachment</p> </div> </td> </tr> <tr> <td> <p> <strong>type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Patch</tt> </li> <li> <tt>Unspecified</tt> </li> </ul> </td> <td> <div> <p>Attachment Type</p> <p>The type of the attachment, for example Patch or Unspecified.</p> </div> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Attachment URL </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_attachment-standard-methods" title="bug_attachment-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_attachment-custom-POSTs" title="bug_attachment-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="bug_attachment-removeFromBug" title="bug_attachment-removeFromBug">removeFromBug</h5> <p> Remove the attachment from the bug. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeFromBug</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_branch" title="bug_branch">bug_branch</h3> <p> A branch linked to a bug. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <p> Branch </p> </td> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Bug # </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_branch-standard-methods" title="bug_branch-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_link_target" title="bug_link_target">bug_link_target</h3> <div> <p>An entity which can be linked to bugs.</p> <p>Examples include an ISpecification.</p> </div> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bugs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> Bugs related to this object. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_link_target-standard-methods" title="bug_link_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_nomination" title="bug_nomination">bug_nomination</h3> <div> <p>A nomination for a bug to be fixed in a specific series.</p> <p>A nomination can apply to an IDistroSeries or an IProductSeries.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Submitted</p> <p>The date on which this nomination was submitted.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_decided</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Decided</p> <p>The date on which this nomination was approved or declined.</p> </div> </td> </tr> <tr> <td> <p> <strong>decider_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Decided By </p> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Series </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Submitter </p> </td> </tr> <tr> <td> <p> <strong>productseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td> <p> Series </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Nominated</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Declined</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td> <td> <p> The IProductSeries or IDistroSeries of this nomination. </p> </td> </tr> </table> </div> <div id="bug_nomination-standard-methods" title="bug_nomination-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_nomination-custom-GETs" title="bug_nomination-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="bug_nomination-canApprove" title="bug_nomination-canApprove">canApprove</h5> <p> Is this person allowed to approve the nomination? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canApprove</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="bug_nomination-custom-POSTs" title="bug_nomination-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="bug_nomination-approve" title="bug_nomination-approve">approve</h5> <div> <p>Approve this bug for fixing in a series.</p> <p>The status is set to APPROVED and the appropriate IBugTask(s) are created for the nomination target.</p> <p>A nomination in any state can be approved. If the nomination is /already/ approved, this method is a noop.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>approve</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug_nomination-decline" title="bug_nomination-decline">decline</h5> <div> <p>Decline this bug for fixing in a series.</p> <p>The status is set to DECLINED.</p> <p>If called on a nomination that is in APPROVED state, a BugNominationStatusError is raised. If the nomination was already DECLINED, this method is a noop.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>decline</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_subscription" title="bug_subscription">bug_subscription</h3> <p> The relationship between a person and a bug. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/<var><bug.id></var>/subscriptions/<var><subscriber.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Bug </p> </td> </tr> <tr> <td> <p> <strong>bug_notification_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Lifecycle</tt> </li> <li> <tt>Details</tt> </li> <li> <tt>Discussion</tt> </li> </ul> </td> <td> <div> <p>Bug notification level</p> <p>The volume and type of bug notifications this subscription will generate.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date subscribed </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person's Launchpad ID or email address.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscribed_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscribed by</p> <p>The person who created this subscription.</p> </div> </td> </tr> </table> </div> <div id="bug_subscription-standard-methods" title="bug_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_subscription-custom-GETs" title="bug_subscription-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="bug_subscription-canBeUnsubscribedByUser" title="bug_subscription-canBeUnsubscribedByUser">canBeUnsubscribedByUser</h5> <p> Can the user unsubscribe the subscriber from the bug? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeUnsubscribedByUser</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_subscription_filter" title="bug_subscription_filter">bug_subscription_filter</h3> <p> A bug subscription filter. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_notification_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Lifecycle</tt> </li> <li> <tt>Details</tt> </li> <li> <tt>Discussion</tt> </li> </ul> </td> <td> <div> <p>Bug notification level</p> <p>The volume and type of bug notifications this subscription will generate.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A short description of this filter </p> </td> </tr> <tr> <td> <p> <strong>find_all_tags</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Find all tags</p> <p>If enabled, all tags must match, else at least one tag must match.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>importances</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The importances interested in (empty for all) </p> </td> </tr> <tr> <td> <p> <strong>information_types</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The information types interested in (empty for all) </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>statuses</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The statuses interested in (empty for all) </p> </td> </tr> <tr> <td> <p> <strong>structural_subscription_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#structural_subscription">structural_subscription</a>. </td> <td> <p> Structural subscription </p> </td> </tr> <tr> <td> <p> <strong>tags</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The tags interested in </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_subscription_filter-standard-methods" title="bug_subscription_filter-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_subscription_filter-custom-GETs" title="bug_subscription_filter-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="bug_subscription_filter-isMuteAllowed" title="bug_subscription_filter-isMuteAllowed">isMuteAllowed</h5> <p> Return True if this filter can be muted for person. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isMuteAllowed</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug_subscription_filter-muted" title="bug_subscription_filter-muted">muted</h5> <p> Return date muted if this filter was muted for person, or None. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>muted</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="bug_subscription_filter-custom-POSTs" title="bug_subscription_filter-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="bug_subscription_filter-mute" title="bug_subscription_filter-mute">mute</h5> <p> Add a mute for person to this filter. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>mute</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="bug_subscription_filter-unmute" title="bug_subscription_filter-unmute">unmute</h5> <p> Remove any mute for person to this filter. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unmute</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_target" title="bug_target">bug_target</h3> <div> <p>An entity on which a bug can be reported.</p> <p>Examples include an IDistribution, an IDistroSeries and an IProduct.</p> </div> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_target-standard-methods" title="bug_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_target-custom-GETs" title="bug_target-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="bug_target-searchTasks" title="bug_target-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_task" title="bug_task">bug_task</h3> <p> A bug needing fixing in a particular product or package. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+bug/<var><bug.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>assignee_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Assigned to </p> </td> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Bug </p> </td> </tr> <tr> <td> <p> <strong>bug_target_display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The short, descriptive name of the target </p> </td> </tr> <tr> <td> <p> <strong>bug_target_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The target as presented in mail notifications </p> </td> </tr> <tr> <td> <p> <strong>bug_watch_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_watch">bug_watch</a>. </td> <td> <div> <p>Remote Bug Details</p> <p>Select the bug watch that represents this task in the relevant bug tracker. If none of the bug watches represents this particular bug task, leave it as (None). Linking the remote bug watch with the task in this way means that a change in the remote bug status will change the status of this bug task in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_assigned</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Assigned</p> <p>The date on which this task was assigned to someone.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_closed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Closed</p> <p>The date on which this task was marked Fix Released, Invalid, Won't Fix, Expired or Opinion.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_confirmed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Confirmed</p> <p>The date on which this task was marked Confirmed.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date on which this task was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_fix_committed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Fix Committed</p> <p>The date on which this task was marked Fix Committed.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_fix_released</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Fix Released</p> <p>The date on which this task was marked Fix Released.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_in_progress</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date In Progress</p> <p>The date on which this task was marked In Progress.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_incomplete</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Incomplete</p> <p>The date on which this task was marked Incomplete.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_left_closed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date left closed</p> <p>The date on which this task was last reopened.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_left_new</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date left new</p> <p>The date on which this task was marked with a status higher than New.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_triaged</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Triaged</p> <p>The date on which this task was marked Triaged.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>importance</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Undecided</tt> </li> <li> <tt>Critical</tt> </li> <li> <tt>High</tt> </li> <li> <tt>Medium</tt> </li> <li> <tt>Low</tt> </li> <li> <tt>Wishlist</tt> </li> </ul> </td> <td> <p> Importance </p> </td> </tr> <tr> <td> <p> <strong>importance_explanation</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Importance explanation</p> <p>The explanation for the current importance of this bugtask.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_complete</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> True or False depending on whether or not there is more work required on this bug task. </p> </td> </tr> <tr> <td> <p> <strong>milestone_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#milestone">milestone</a>. </td> <td> <p> Milestone </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The owner </p> </td> </tr> <tr> <td> <p> <strong>related_tasks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_task">bug_task</a> collection. </td> <td> <p> IBugTasks related to this one, namely other IBugTasks on the same IBug. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>New</tt> </li> <li> <tt>Incomplete</tt> </li> <li> <tt>Opinion</tt> </li> <li> <tt>Invalid</tt> </li> <li> <tt>Won't Fix</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Confirmed</tt> </li> <li> <tt>Triaged</tt> </li> <li> <tt>In Progress</tt> </li> <li> <tt>Fix Committed</tt> </li> <li> <tt>Fix Released</tt> </li> <li> <tt>Does Not Exist</tt> </li> <li> <tt>Unknown</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>status_explanation</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Status explanation</p> <p>The explanation for the current status of this bugtask.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_target">bug_target</a>. </td> <td> <div> <p>Target</p> <p>The software in which this bug should be fixed.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The title of the bug related to this bugtask </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_task-standard-methods" title="bug_task-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_task-custom-GETs" title="bug_task-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="bug_task-findSimilarBugs" title="bug_task-findSimilarBugs">findSimilarBugs</h5><p> Return the list of possible duplicates for this BugTask. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findSimilarBugs</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug">bug</a> collection. </p> </div> <div class="method"> <h5 id="bug_task-getContributorInfo" title="bug_task-getContributorInfo">getContributorInfo</h5> <div> <p>Is the person a contributor to bugs in this task's pillar?</p> <p>Return a dict with the following values: is_contributor: True if the user has any bugs assigned to them in the context of this bug task's pillar, either directly or by team participation. person_name: the displayname of the person pillar_name: the displayname of the bug task's pillar</p> <p>This API call is provided for use by the client Javascript where the calling context does not have access to the person or pillar names.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getContributorInfo</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Assigned to </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_tracker" title="bug_tracker">bug_tracker</h3> <div> <p>A remote bug system.</p> <p>Launchpadlib example: What bug tracker is used for a distro source package?</p> <pre class="rst-literal-block"> product = source_package.upstream_product if product: tracker = product.bug_tracker if not tracker: project = product.project_group if project: tracker = project.bug_tracker if tracker: print "%s at %s" %(tracker.bug_tracker_type, tracker.base_url) </pre> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/bugtrackers/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Updates for this bug tracker are enabled </p> </td> </tr> <tr> <td> <p> <strong>base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Location</p> <p>The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.</p> </div> </td> </tr> <tr> <td> <p> <strong>base_url_aliases</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Location aliases</p> <p>A list of URLs or email addresses that all lead to the same bug tracker, or commonly seen typos, separated by whitespace.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_tracker_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Bugzilla</tt> </li> <li> <tt>Debbugs</tt> </li> <li> <tt>Roundup</tt> </li> <li> <tt>Trac</tt> </li> <li> <tt>SourceForge or SourceForge derivative</tt> </li> <li> <tt>Mantis</tt> </li> <li> <tt>Request Tracker (RT)</tt> </li> <li> <tt>Email Address</tt> </li> <li> <tt>Savane</tt> </li> <li> <tt>PHP Project Bugtracker</tt> </li> <li> <tt>Google Code</tt> </li> <li> <tt>GitHub Issues</tt> </li> <li> <tt>GitLab Issues</tt> </li> </ul> </td> <td> <p> Bug Tracker Type </p> </td> </tr> <tr> <td> <p> <strong>contact_details</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Contact details</p> <p>The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).</p> </div> </td> </tr> <tr> <td> <p> <strong>has_lp_plugin</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> This bug tracker has a Launchpad plugin installed. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>A URL-friendly name for the bug tracker, such as "mozilla-bugs".</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A brief introduction or overview of this bug tracker instance.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>A descriptive label for this tracker to show in listings.</p> </div> </td> </tr> <tr> <td> <p> <strong>watches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_watch">bug_watch</a> collection. </td> <td> <p> The remote watches on this bug tracker. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_tracker-standard-methods" title="bug_tracker-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_tracker-custom-GETs" title="bug_tracker-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="bug_tracker-getAllRemoteComponentGroups" title="bug_tracker-getAllRemoteComponentGroups">getAllRemoteComponentGroups</h5><p> Return collection of all component groups for this bug tracker </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAllRemoteComponentGroups</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker_component_group">bug_tracker_component_group</a> collection. </p> </div> <div class="method"><h5 id="bug_tracker-getRemoteComponentForDistroSourcePackageName" title="bug_tracker-getRemoteComponentForDistroSourcePackageName">getRemoteComponentForDistroSourcePackageName</h5><div> <p>Returns the component linked to this source package, if any.</p> <p>If no components have been linked, returns value of None.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRemoteComponentForDistroSourcePackageName</var></p></td><td></td></tr><tr><td><p><strong>distribution</strong></p></td><td><p><small>(required)</small></p></td><td><p> The distribution for the source package </p></td></tr><tr><td><p><strong>sourcepackagename</strong></p></td><td><p><small>(required)</small></p></td><td><p> The source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker_component">bug_tracker_component</a>. </p> </div> <div class="method"><h5 id="bug_tracker-getRemoteComponentGroup" title="bug_tracker-getRemoteComponentGroup">getRemoteComponentGroup</h5><div> <p>Retrieve a given component group registered with the bug tracker.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRemoteComponentGroup</var></p></td><td></td></tr><tr><td><p><strong>component_group_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the remote component group </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker_component_group">bug_tracker_component_group</a>. </p> </div> </div> <div id="bug_tracker-custom-POSTs" title="bug_tracker-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="bug_tracker-addRemoteComponentGroup" title="bug_tracker-addRemoteComponentGroup">addRemoteComponentGroup</h5><p> Adds a new component group to the bug tracker </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addRemoteComponentGroup</var></p></td><td></td></tr><tr><td><p><strong>component_group_name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the remote component group </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_tracker_component_group">bug_tracker_component_group</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_tracker_component" title="bug_tracker_component">bug_tracker_component</h3> <div> <p>The software component in the remote bug tracker.</p> <p>Most bug trackers organize bug reports by the software 'component' they affect. This class provides a mapping of this upstream component to the corresponding source package in the distro.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>component_group_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_tracker_component_group">bug_tracker_component_group</a>. </td> <td> <p> Component Group </p> </td> </tr> <tr> <td> <p> <strong>distro_source_package_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution_source_package">distribution_source_package</a>. </td> <td> <div> <p>Distribution Source Package</p> <p>The distribution source package object that should be linked to this component.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_visible</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Is Visible?</p> <p>Should the component be shown in the Launchpad web interface?</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of a software component as shown in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_tracker_component-standard-methods" title="bug_tracker_component-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_tracker_component_group" title="bug_tracker_component_group">bug_tracker_component_group</h3> <div> <p>A collection of components in a remote bug tracker.</p> <p>Some bug trackers organize sets of components into higher level groups, such as Bugzilla's 'product'.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_tracker_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_tracker">bug_tracker</a>. </td> <td> <p> BugTracker </p> </td> </tr> <tr> <td> <p> <strong>components_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_tracker_component">bug_tracker_component</a> collection. </td> <td> <p> Components. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the bug tracker product.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_tracker_component_group-standard-methods" title="bug_tracker_component_group-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="bug_tracker_component_group-custom-POSTs" title="bug_tracker_component_group-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="bug_tracker_component_group-addComponent" title="bug_tracker_component_group-addComponent">addComponent</h5> <p> Adds a component to be tracked as part of this component group </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addComponent</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The name of the remote software component to be added </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="bug_watch" title="bug_watch">bug_watch</h3> <p> A bug on a remote system. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/<var><bug.id></var>/watch/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a>. </td> <td> <p> Bug </p> </td> </tr> <tr> <td> <p> <strong>bug_tasks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_task">bug_task</a> collection. </td> <td> <p> The tasks which this watch will affect. In Launchpad, a bug watch can be linked to one or more tasks, and if it is linked and we notice a status change in the watched bug then we will try to update the Launchpad bug task accordingly. </p> </td> </tr> <tr> <td> <p> <strong>bug_tracker_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_tracker">bug_tracker</a>. </td> <td> <div> <p>Bug System</p> <p>You can register new bug trackers from the Launchpad Bugs home page.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_last_changed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Last Changed </p> </td> </tr> <tr> <td> <p> <strong>date_last_checked</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Last Checked </p> </td> </tr> <tr> <td> <p> <strong>date_next_checked</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Next Check </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>last_error_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Bug Not Found</tt> </li> <li> <tt>Connection Error</tt> </li> <li> <tt>Invalid Bug ID</tt> </li> <li> <tt>Timeout</tt> </li> <li> <tt>Unparsable Bug</tt> </li> <li> <tt>Unparsable Bug Tracker Version</tt> </li> <li> <tt>Unsupported Bugtracker</tt> </li> <li> <tt>Private Remote Bug</tt> </li> <li> <tt>Synchronisation succeeded</tt> </li> <li> <tt>Unable to import comments</tt> </li> <li> <tt>Unable to push comments</tt> </li> <li> <tt>Unable to set link remote bug to Launchpad</tt> </li> </ul> </td> <td> <p> Last Error Type </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>remote_bug</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Remote Bug</p> <p>The bug number of this bug in the remote bug tracker.</p> </div> </td> </tr> <tr> <td> <p> <strong>remote_importance</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Remote Importance </p> </td> </tr> <tr> <td> <p> <strong>remote_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Remote Status </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Bug watch title </p> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The URL at which to view the remote bug. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="bug_watch-standard-methods" title="bug_watch-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="build" title="build">build</h3> <p> A Build interface </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/+source/<var><source_package.name></var>/+build/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildinfo_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>buildinfo file URL</p> <p>The URL for the .buildinfo file for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>changesfile_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Changes file URL</p> <p>The URL for the changes file for this build. Will be None if the build was imported by Gina.</p> </div> </td> </tr> <tr> <td> <p> <strong>current_source_publication_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_publishing_history">source_package_publishing_history</a>. </td> <td> <div> <p>Source publication</p> <p>The current source publication for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>external_dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>External dependencies</p> <p>Newline-separated list of repositories to be used to retrieve any external build-dependencies when performing this build, in the format: deb http[s]://[user:pass@]<host>[/path] series[-pocket] [components] This is intended for bootstrapping build-dependency loops.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related job (if any) </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source package name </p> </td> </tr> <tr> <td> <p> <strong>source_package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source package version </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="build-standard-methods" title="build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="build-custom-GETs" title="build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="build-getLatestSourcePublication" title="build-getLatestSourcePublication">getLatestSourcePublication</h5><div> <p>The latest source publication corresponding to this build.</p> <p>Unlike current_source_publication, this returns publications even if they are no longer active.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getLatestSourcePublication</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_publishing_history">source_package_publishing_history</a>. </p> </div> </div> <div id="build-custom-POSTs" title="build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="build-cancel" title="build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="build-rescore" title="build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="build-retry" title="build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="build_farm_job" title="build_farm_job">build_farm_job</h3> <p> Operations that jobs for the build farm must implement. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="build_farm_job-standard-methods" title="build_farm_job-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="build_farm_job-custom-POSTs" title="build_farm_job-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="build_farm_job-cancel" title="build_farm_job-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="build_farm_job-rescore" title="build_farm_job-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="build_farm_job-retry" title="build_farm_job-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="builder" title="builder">builder</h3> <div> <p>Builder information and state.</p> <p>Builder instance represents a single machine within the Launchpad Auto Build System. It should specify a 'processor' on which the machine is based and is able to build packages for; a URL, by which the machine is accessed through an XML-RPC interface; name, title for entity identification and browsing purposes; an LP-like owner which has unrestricted access to the instance; the machine status representation, including the field/properties: virtualized, open_resources, restricted_resources, builderok, status, failnotes and currentjob.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/builders/<var><builder.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Publicly Visible</p> <p>Whether or not to present the builder publicly.</p> </div> </td> </tr> <tr> <td> <p> <strong>builderok</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Builder State OK</p> <p>Whether or not the builder is ok</p> </div> </td> </tr> <tr> <td> <p> <strong>clean_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Clean</tt> </li> <li> <tt>Dirty</tt> </li> <li> <tt>Cleaning</tt> </li> </ul> </td> <td> <div> <p>Clean status</p> <p>The readiness of the builder to take a job. Only internal build infrastructure bots need to or should write to this.</p> </div> </td> </tr> <tr> <td> <p> <strong>current_build_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#build_farm_job">build_farm_job</a>. </td> <td> <div> <p>Current build</p> <p>The job currently running on this builder.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_clean_status_changed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date clean status changed</p> <p>The date the builder's clean status last changed.</p> </div> </td> </tr> <tr> <td> <p> <strong>failnotes</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Failure Notes</p> <p>The reason for a builder not being ok</p> </div> </td> </tr> <tr> <td> <p> <strong>failure_count</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Failure Count</p> <p>Number of consecutive failures for this builder.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>manual</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Manual Mode</p> <p>The auto-build system does not dispatch jobs automatically for builders in manual mode.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The builder name used for reference purposes</p> </div> </td> </tr> <tr> <td> <p> <strong>open_resources</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Open resources</p> <p>Resource tags offered by this builder, that can be required by a build and if required must match.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>Builder owner, a Launchpad member which will be responsible for this device.</p> </div> </td> </tr> <tr> <td> <p> <strong>processor_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#processor">processor</a>. </td> <td> <div> <p>Processor</p> <p>DEPRECATED: Processor identifying jobs which can be built by this device. Use processors instead to handle multiple supported architectures.</p> </div> </td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Processors</p> <p>Processors identifying jobs which can be built by this device.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>restricted_resources</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Restricted resources</p> <p>Resource tags offered by this builder, indicating that the builder may only be used by builds that explicitly require these tags.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The builder title. Should be just a few words.</p> </div> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>URL</p> <p>The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: <a class="rst-reference external" href="http://farm.com:8221/" target="_top">http://farm.com:8221/</a></p> </div> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Version</p> <p>The version of launchpad-buildd on the worker.</p> </div> </td> </tr> <tr> <td> <p> <strong>virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Virtualized</p> <p>Whether or not the builder is a virtual Xen instance.</p> </div> </td> </tr> <tr> <td> <p> <strong>vm_host</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>VM host</p> <p>The machine hostname hosting the virtual buildd-worker, e.g.: foobar-host.ppa</p> </div> </td> </tr> <tr> <td> <p> <strong>vm_reset_protocol</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>1.1</tt> </li> <li> <tt>2.0</tt> </li> </ul> </td> <td> <div> <p>VM reset protocol</p> <p>The protocol version for resetting the VM.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="builder-standard-methods" title="builder-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="builder-custom-GETs" title="builder-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="builder-getBuildRecords" title="builder-getBuildRecords">getBuildRecords</h5><div> <p>Return build records in the context it is implemented.</p> <p>It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.</p> <p>The result is simply not filtered if the optional filters are omitted by call sites.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildRecords</var></p></td><td></td></tr><tr><td><p><strong>build_state</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs building</tt></li><li><tt>Successfully built</tt></li><li><tt>Failed to build</tt></li><li><tt>Dependency wait</tt></li><li><tt>Chroot problem</tt></li><li><tt>Build for superseded Source</tt></li><li><tt>Currently building</tt></li><li><tt>Failed to upload</tt></li><li><tt>Uploading build</tt></li><li><tt>Cancelling build</tt></li><li><tt>Cancelled build</tt></li><li><tt>Gathering build output</tt></li></ul></td><td><div> <p>Build status</p> <p>The status of this build record</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="charm_base" title="charm_base">charm_base</h3> <p> A base for charms. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+charm-bases/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>build_snap_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building charm recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Distro series </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures that the charm base supports.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this base.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="charm_base-standard-methods" title="charm_base-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="charm_base-custom-POSTs" title="charm_base-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="charm_base-setProcessors" title="charm_base-setProcessors">setProcessors</h5> <p> Set the architectures that the charm base supports. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="charm_recipe" title="charm_recipe">charm_recipe</h3> <p> A buildable charm recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+charm/<var><recipe.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>auto_build</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically build when branch changes</p> <p>Whether this charm recipe is built automatically when its branch changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this charm recipe. Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'</p> </div> </td> </tr> <tr> <td> <p> <strong>build_path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build path</p> <p>Subdirectory within the branch containing metadata.yaml.</p> </div> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build">charm_recipe_build</a> collection. </td> <td> <div> <p>All builds of this charm recipe.</p> <p>All builds of this charm recipe, sorted in descending order of finishing (or starting if not completed successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>can_upload_to_store</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can upload to Charmhub</p> <p>Whether everything is set up to allow uploading builds of this charm recipe to Charmhub.</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build">charm_recipe_build</a> collection. </td> <td> <div> <p>Completed builds of this charm recipe.</p> <p>Completed builds of this charm recipe, sorted in descending order of finishing.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A description of the charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>failed_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build_request">charm_recipe_build_request</a> collection. </td> <td> <p> Failed build requests for this charm recipe. </p> </td> </tr> <tr> <td> <p> <strong>git_ref_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td> <td> <div> <p>Git branch</p> <p>The Git branch containing a charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Charm recipe is stale and is due to be rebuilt. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Charm recipe name</p> <p>The name of the charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build_request">charm_recipe_build_request</a> collection. </td> <td> <p> Pending build requests for this charm recipe. </p> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build">charm_recipe_build</a> collection. </td> <td> <div> <p>Pending builds of this charm recipe.</p> <p>Pending builds of this charm recipe, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Private</p> <p>Whether this charm recipe is private.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project that this charm recipe is associated with </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this charm recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build this charm recipe on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>store_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Store channels</p> <p>Channels to release this charm to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Registered store name</p> <p>The registered name of this charm in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically upload to store</p> <p>Whether builds of this charm recipe are automatically uploaded to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="charm_recipe-standard-methods" title="charm_recipe-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="charm_recipe-custom-POSTs" title="charm_recipe-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="charm_recipe-beginAuthorization" title="charm_recipe-beginAuthorization">beginAuthorization</h5> <div> <p>Begin authorizing uploads of this charm recipe to Charmhub.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>beginAuthorization</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The serialized macaroon returned by the store. The caller should acquire a discharge macaroon for this caveat from Candid and then call completeAuthorization.</td> </p> </div> <div class="method"> <h5 id="charm_recipe-completeAuthorization" title="charm_recipe-completeAuthorization">completeAuthorization</h5> <div> <p>Complete authorizing uploads of this charm recipe to Charmhub.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>completeAuthorization</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>discharge_macaroon</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Serialized discharge macaroon </p> </td> </tr> </table> </div> <div class="method"><h5 id="charm_recipe-newWebhook" title="charm_recipe-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"><h5 id="charm_recipe-requestBuilds" title="charm_recipe-requestBuilds">requestBuilds</h5><div> <p>Request that the charm recipe be built.</p> <p>This is an asynchronous operation; once the operation has finished, the resulting build request's C{status} will be "Completed" and its C{builds} collection will return the resulting builds.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuilds</var></p></td><td></td></tr><tr><td><p><strong>channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels to use for these builds.</p> <p>A dictionary mapping snap names to channels to use for these builds. Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#charm_recipe_build_request">charm_recipe_build_request</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="charm_recipe_build" title="charm_recipe_build">charm_recipe_build</h3> <p> A build record for a charm recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+charm/<var><recipe.name></var>/+build/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for which to build. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe">charm_recipe</a>. </td> <td> <p> The charm recipe to build. </p> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who requested this build. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Revision ID</p> <p>The revision ID of the branch used for this build, if available.</p> </div> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>store_upload_error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store upload error message</p> <p>The error message, if any, from the last attempt to upload this charm recipe build to Charmhub.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload_revision</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store revision</p> <p>The revision assigned to this charm recipe build by Charmhub.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unscheduled</tt> </li> <li> <tt>Pending</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Failed to release to channels</tt> </li> <li> <tt>Uploaded</tt> </li> </ul> </td> <td> <p> Store upload status </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="charm_recipe_build-standard-methods" title="charm_recipe_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="charm_recipe_build-custom-GETs" title="charm_recipe_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="charm_recipe_build-getFileUrls" title="charm_recipe_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="charm_recipe_build-custom-POSTs" title="charm_recipe_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="charm_recipe_build-cancel" title="charm_recipe_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="charm_recipe_build-rescore" title="charm_recipe_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="charm_recipe_build-retry" title="charm_recipe_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="charm_recipe_build-scheduleStoreUpload" title="charm_recipe_build-scheduleStoreUpload">scheduleStoreUpload</h5> <div> <p>Schedule an upload of this build to the store.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>scheduleStoreUpload</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="charm_recipe_build_request" title="charm_recipe_build_request">charm_recipe_build_request</h3> <p> A request to build a charm recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+charm/<var><recipe.name></var>/+build-request/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe_build">charm_recipe_build</a> collection. </td> <td> <p> Builds produced by this request </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request finished </p> </td> </tr> <tr> <td> <p> <strong>date_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request was made </p> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Error message </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#charm_recipe">charm_recipe</a>. </td> <td> <p> Charm recipe </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Completed</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="charm_recipe_build_request-standard-methods" title="charm_recipe_build_request-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="ci_build" title="ci_build">ci_build</h3> <p> A build record for a pipeline of CI jobs. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>commit_sha1</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The Git commit ID for this CI build. </p> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture that this CI build should run on. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_refs</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The git references that originated this CI Build. </p> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> The Git repository for this CI build. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>results</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A mapping from job IDs to result tokens, retrieved from the builder. </p> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>stages</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A list of stages in this build's configured pipeline. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="ci_build-standard-methods" title="ci_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="ci_build-custom-GETs" title="ci_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="ci_build-getFileUrls" title="ci_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="ci_build-custom-POSTs" title="ci_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="ci_build-cancel" title="ci_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="ci_build-rescore" title="ci_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="ci_build-retry" title="ci_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="code_import" title="code_import">code_import</h3> <p> A code import to a Bazaar branch or Git repository. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Branch</p> <p>The Bazaar branch produced by the import system.</p> </div> </td> </tr> <tr> <td> <p> <strong>cvs_module</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Module</p> <p>The path to import within the repository. Usually, it is the name of the project.</p> </div> </td> </tr> <tr> <td> <p> <strong>cvs_root</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Repository</p> <p>The CVSROOT. Example: :pserver:anonymous@anoncvs.gnome.org:/cvs/gnome</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_successful</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Last successful </p> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Git repository</p> <p>The Git repository produced by the import system.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>rcs_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Concurrent Versions System</tt> </li> <li> <tt>Subversion via CSCVS</tt> </li> <li> <tt>Subversion via bzr-svn</tt> </li> <li> <tt>Git</tt> </li> <li> <tt>Mercurial</tt> </li> <li> <tt>Bazaar</tt> </li> </ul> </td> <td> <div> <p>Type of RCS</p> <p>The revision control system to import from.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>review_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending Review</tt> </li> <li> <tt>Invalid</tt> </li> <li> <tt>Reviewed</tt> </li> <li> <tt>Suspended</tt> </li> <li> <tt>Failed</tt> </li> </ul> </td> <td> <div> <p>Review Status</p> <p>Only reviewed imports are processed.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>target_rcs_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Bazaar</tt> </li> <li> <tt>Git</tt> </li> </ul> </td> <td> <div> <p>Type of target RCS</p> <p>The revision control system to import to.</p> </div> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>URL</p> <p>The URL of the VCS branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="code_import-standard-methods" title="code_import-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="code_import-custom-POSTs" title="code_import-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="code_import-requestImport" title="code_import-requestImport">requestImport</h5> <div> <p>Request that an import be tried soon.</p> <p>This method will schedule an import to happen soon for this branch.</p> <p>The import must be in the Reviewed state, if not then a CodeImportNotInReviewedState error will be thrown. If using the API then a status code of 400 will result.</p> <p>If the import is already running then a CodeImportAlreadyRunning error will be thrown. If using the API then a status code of 400 will result.</p> <p>The two cases can be distinguished over the API by seeing if the exception names appear in the body of the response.</p> <p>If used over the API and the request has already been made then this method will silently do nothing. If called internally then the error_if_already_requested parameter controls whether a CodeImportAlreadyRequested exception will be thrown in that situation.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>requestImport</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">None</td> </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="code_review_comment" title="code_review_comment">code_review_comment</h3> <p> A link between a merge proposal and a message. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>as_quoted_email</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The message as quoted in email. </p> </td> </tr> <tr> <td> <p> <strong>author_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Comment Author </p> </td> </tr> <tr> <td> <p> <strong>branch_merge_proposal_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <p> The branch merge proposal </p> </td> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> All the text/plain chunks joined together as a unicode string. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_deleted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was deleted </p> </td> </tr> <tr> <td> <p> <strong>date_last_edited</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was last edited </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>DB ID</p> <p>The tracking number for this comment.</p> </div> </td> </tr> <tr> <td> <p> <strong>message_body</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Deprecated. Use "content" attribute instead. </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revisions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message_revision">message_revision</a> collection. </td> <td> <div> <p>Message revision history</p> <p>Revision history of this message, sorted in ascending order.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The title of the comment </p> </td> </tr> <tr> <td> <p> <strong>vote</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Approve</tt> </li> <li> <tt>Needs Fixing</tt> </li> <li> <tt>Needs Information</tt> </li> <li> <tt>Abstain</tt> </li> <li> <tt>Disapprove</tt> </li> <li> <tt>Needs Resubmitting</tt> </li> </ul> </td> <td> <p> Review </p> </td> </tr> <tr> <td> <p> <strong>vote_tag</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Vote tag </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="code_review_comment-standard-methods" title="code_review_comment-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="code_review_comment-custom-POSTs" title="code_review_comment-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="code_review_comment-deleteContent" title="code_review_comment-deleteContent">deleteContent</h5> <p> Deletes this message content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteContent</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="code_review_comment-editContent" title="code_review_comment-editContent">editContent</h5> <p> Edit the content of this message, generating a new message revision with the old content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>editContent</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_content</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Message content</p> <p>The new message content string</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="code_review_vote_reference" title="code_review_vote_reference">code_review_vote_reference</h3> <div> <p>A reference to a vote on a IBranchMergeProposal.</p> <p>There is at most one reference to a vote for each reviewer on a given branch merge proposal.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_merge_proposal_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <p> The merge proposal that is the subject of this vote </p> </td> </tr> <tr> <td> <p> <strong>comment_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#code_review_comment">code_review_comment</a>. </td> <td> <p> The code review comment that contains the most recent vote. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_pending</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Is the pending? </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who originally registered this vote </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>review_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Review type</p> <p>Lowercase keywords describing the type of review.</p> </div> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Reviewer</p> <p>A person who you want to review this.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="code_review_vote_reference-standard-methods" title="code_review_vote_reference-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="code_review_vote_reference-custom-POSTs" title="code_review_vote_reference-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="code_review_vote_reference-claimReview" title="code_review_vote_reference-claimReview">claimReview</h5> <div> <p>Change a pending review into a review for claimant.</p> <p>Pending team reviews can be claimed by members of that team. This allows reviews to be moved of the general team todo list, and onto a personal todo list.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>claimReview</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="code_review_vote_reference-reassignReview" title="code_review_vote_reference-reassignReview">reassignReview</h5> <div> <p>Reassign a pending review to someone else.</p> <p>Pending reviews can be reassigned to someone else.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>reassignReview</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>reviewer</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person or team to assign to do the review. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="commercial_subscription" title="commercial_subscription">commercial_subscription</h3> <div> <p>A Commercial Subscription for a Product.</p> <p>If the product has a licence which does not qualify for free hosting, a subscription needs to be purchased.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+commercialsubscription/<var><commercial_subscription.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date the first subscription was applied.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Expiration Date</p> <p>The expiration date of the subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Modified</p> <p>The date the subscription was modified.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_starts</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Beginning of Subscription</p> <p>The date the subscription starts.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution which has commercial subscription</p> <p>Distribution for which this commercial subscription is applied.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_active</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether this subscription is active.</p> </div> </td> </tr> <tr> <td> <p> <strong>product_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project">project</a>. </td> <td> <div> <p>Product which has commercial subscription</p> <p>Project for which this commercial subscription is applied.</p> </div> </td> </tr> <tr> <td> <p> <strong>purchaser_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Purchaser</p> <p>Person who purchased the voucher.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>Person who redeemed the voucher.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="commercial_subscription-standard-methods" title="commercial_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="country" title="country">country</h3> <p> The country description. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+countries/<var><iso3166code2></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Description </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>iso3166code2</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> iso3166code2 </p> </td> </tr> <tr> <td> <p> <strong>iso3166code3</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> iso3166code3 </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Country name </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Country title </p> </td> </tr> </table> </div> <div id="country-standard-methods" title="country-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="craft_recipe" title="craft_recipe">craft_recipe</h3> <p> A buildable craft recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>auto_build</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically build when branch changes</p> <p>Whether this craft recipe is built automatically when the branch containing its craft.yaml recipe changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this craft recipe. Currently only 'core', 'core18', 'core20', and 'sourcecraft' keys are supported.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build path</p> <p>Subdirectory within the branch containing craft.yaml.</p> </div> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build">craft_recipe_build</a> collection. </td> <td> <div> <p>All builds of this craft recipe.</p> <p>All builds of this craft recipe, sorted in descending order of finishing (or starting if not completed successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>can_upload_to_store</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can upload to the CraftStore</p> <p>Whether everything is set up to allow uploading builds of this craftrecipe to the CraftStore.</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build">craft_recipe_build</a> collection. </td> <td> <div> <p>Completed builds of this craft recipe.</p> <p>Completed builds of this craft recipe, sorted in descending order of finishing.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A description of the craft recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>failed_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build_request">craft_recipe_build_request</a> collection. </td> <td> <p> Failed build requests for this craft recipe. </p> </td> </tr> <tr> <td> <p> <strong>fetch_service_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>strict</tt> </li> <li> <tt>permissive</tt> </li> </ul> </td> <td> <div> <p>Fetch service policy</p> <p>Which policy to use when using the fetch service. Ignored if use_fetch_service flag is False.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git branch path</p> <p>The path of the Git branch containing a sourcecraft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_ref_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td> <td> <div> <p>Git branch</p> <p>The Git branch containing a craft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Git repository</p> <p>A Git repository with a branch containing a sourcecraft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a sourcecraft.yaml at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this craft recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Craft recipe is stale and is due to be rebuilt. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Craft recipe name</p> <p>The name of the craft recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this craft recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build_request">craft_recipe_build_request</a> collection. </td> <td> <p> Pending build requests for this craft recipe. </p> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build">craft_recipe_build</a> collection. </td> <td> <div> <p>Pending builds of this craft recipe.</p> <p>Pending builds of this craft recipe, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Private</p> <p>Whether this craft recipe is private.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project that this craft recipe is associated with </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this craft recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build this craft recipe on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>store_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Store channels</p> <p>Channels to release this craft to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Registered store name</p> <p>The registered name of this craft in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically upload to store</p> <p>Whether builds of this craft recipe are automatically uploaded to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>use_fetch_service</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Use fetch service</p> <p>If set, Craft builds will use the fetch-service instead of the builder-proxy to access external resources.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="craft_recipe-standard-methods" title="craft_recipe-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="craft_recipe-custom-POSTs" title="craft_recipe-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="craft_recipe-requestBuilds" title="craft_recipe-requestBuilds">requestBuilds</h5><div> <p>Request that the craft recipe be built.</p> <p>This is an asynchronous operation; once the operation has finished, the resulting build request's C{status} will be "Completed" and its C{builds} collection will return the resulting builds.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuilds</var></p></td><td></td></tr><tr><td><p><strong>architectures</strong></p></td><td><p></p></td><td><p> The list of architectures to build for this recipe. </p></td></tr><tr><td><p><strong>channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels to use for these builds.</p> <p>A dictionary mapping snap names to channels to use for these builds. Currently only 'sourcecraft', 'core', 'core18', 'core20', and 'core22' keys are supported.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#craft_recipe_build_request">craft_recipe_build_request</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="craft_recipe_build" title="craft_recipe_build">craft_recipe_build</h3> <p> A build record for a craft recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_metadata_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>URL of the build metadata file</p> <p>URL of the metadata file generated by the fetch service, if it exists.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Currently only 'core', 'core18', 'core20', and 'sourcecraft' keys are supported.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for which to build. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe">craft_recipe</a>. </td> <td> <p> The craft recipe to build. </p> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who requested this build. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Revision ID</p> <p>The revision ID of the branch used for this build, if available.</p> </div> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="craft_recipe_build-standard-methods" title="craft_recipe_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="craft_recipe_build-custom-GETs" title="craft_recipe_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="craft_recipe_build-getFileUrls" title="craft_recipe_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="craft_recipe_build-custom-POSTs" title="craft_recipe_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="craft_recipe_build-cancel" title="craft_recipe_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="craft_recipe_build-rescore" title="craft_recipe_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="craft_recipe_build-retry" title="craft_recipe_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="craft_recipe_build_request" title="craft_recipe_build_request">craft_recipe_build_request</h3> <p> A request to build a craft recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe_build">craft_recipe_build</a> collection. </td> <td> <p> Builds produced by this request </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request finished </p> </td> </tr> <tr> <td> <p> <strong>date_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request was made </p> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Error message </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#craft_recipe">craft_recipe</a>. </td> <td> <p> Craft recipe </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Completed</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="craft_recipe_build_request-standard-methods" title="craft_recipe_build_request-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="cve" title="cve">cve</h3> <p> A single CVE database entry. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/bugs/cve/<var><sequence></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bugs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> Bugs related to this CVE entry. </p> </td> </tr> <tr> <td> <p> <strong>cvss</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>CVSS</p> <p>The CVSS vector strings from various authorities that publish it.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_made_public</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Made Public </p> </td> </tr> <tr> <td> <p> <strong>date_modified</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Date Modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>A description of the CVE issue. This will be updated regularly from the CVE database.</p> </div> </td> </tr> <tr> <td> <p> <strong>discovered_by</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Discovered by</p> <p>The name of person(s) or organization that discovered the CVE</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>A very brief name describing the ref and state.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>sequence</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>CVE Sequence Number</p> <p>Should take the form XXXX-XXXX, all digits.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Candidate</tt> </li> <li> <tt>Entry</tt> </li> <li> <tt>Deprecated</tt> </li> </ul> </td> <td> <div> <p>Current CVE State</p> <p>Whether or not the vulnerability has been reviewed and assigned a full CVE number, or is still considered a Candidate, or is deprecated.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>A title for the CVE</p> </div> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>URL</p> <p>Return a URL to the site that has the CVE data for this CVE reference.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="cve-standard-methods" title="cve-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distribution" title="distribution">distribution</h3> <div> <p>An operating system distribution.</p> <p>Launchpadlib example: retrieving the current version of a package in a particular distroseries.</p> <pre class="rst-literal-block"> ubuntu = launchpad.distributions["ubuntu"] archive = ubuntu.main_archive series = ubuntu.current_series print(archive.getPublishedSources(exact_match=True, source_name="apport", distro_series=series)[0].source_package_version) </pre> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this item is active.</p> </div> </td> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> The visible and active milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> All milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>archive_mirrors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution_mirror">distribution_mirror</a> collection. </td> <td> <p> All enabled and official ARCHIVE mirrors of this Distribution. </p> </td> </tr> <tr> <td> <p> <strong>archives_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a> collection. </td> <td> <p> A sequence of the distribution's primary, partner and debug archives. </p> </td> </tr> <tr> <td> <p> <strong>branch_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td> <div> <p>Branch sharing policy</p> <p>Sharing policy for this pillar's branches.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> </ul> </td> <td> <div> <p>Bug sharing policy</p> <p>Sharing policy for this pillar's bugs.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_supervisor_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Bug Supervisor</p> <p>The Launchpad id of the person or team (preferred) responsible for bug management.</p> </div> </td> </tr> <tr> <td> <p> <strong>cdimage_mirrors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution_mirror">distribution_mirror</a> collection. </td> <td> <p> All enabled and official RELEASE mirrors of this Distribution. </p> </td> </tr> <tr> <td> <p> <strong>code_admin_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Code Administrator</p> <p>The distribution source code administrator.</p> </div> </td> </tr> <tr> <td> <p> <strong>commercial_subscription_is_due</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Commercial subscription is due</p> <p>Whether the distribution's licensing requires a new commercial subscription to use launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>commercial_subscription_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#commercial_subscription">commercial_subscription</a>. </td> <td> <div> <p>Commercial subscriptions</p> <p>An object which contains the timeframe and the voucher code of a subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>current_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Current series</p> <p>The current development series of this distribution. Note that all maintainerships refer to the current series. When people ask about the state of packages in the distribution, we should interpret that query in the context of the currentseries.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date created</p> <p>The date this distribution was registered.</p> </div> </td> </tr> <tr> <td> <p> <strong>default_traversal_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Series</tt> </li> <li> <tt>Source package</tt> </li> <li> <tt>OCI project</tt> </li> </ul> </td> <td> <div> <p>Default traversal policy</p> <p>The type of object that /{distro}/{name} URLs for this distribution resolve to.</p> </div> </td> </tr> <tr> <td> <p> <strong>derivatives_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a> collection. </td> <td> <p> This Distribution's derivatives </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Details about the distributions's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> </div> </td> </tr> <tr> <td> <p> <strong>development_series_alias</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Alias for development series</p> <p>If set, an alias for the current development series in this distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>The displayable name of the distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>domain_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Web site URL</p> <p>The distro's web site URL.</p> </div> </td> </tr> <tr> <td> <p> <strong>driver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Driver</p> <p>The person or team responsible for decisions about features and bugs that will be targeted for any series in this distribution. Note that you can also specify a driver on each series whose permissions will be limited to that specific series.</p> </div> </td> </tr> <tr> <td> <p> <strong>homepage_content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage Content</p> <p>The content of this distribution's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>icon_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Icon</p> <p>A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this distribution. The icon will be displayed everywhere we list the distribution and link to it.</p> </div> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of data contained in this item.</p> </div> </td> </tr> <tr> <td> <p> <strong>logo_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Logo</p> <p>An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this distribution. It should be no bigger than 50kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>main_archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Distribution Main Archive. </p> </td> </tr> <tr> <td> <p> <strong>members_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Members</p> <p>The distro's members team.</p> </div> </td> </tr> <tr> <td> <p> <strong>mirror_admin_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Mirror Administrator</p> <p>The person or team that has the rights to review and mark this distribution's mirrors as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>mugshot_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Brand</p> <p>A large image of exactly 192x192 pixels, that will be displayed on this distribution's home page in Launchpad. It should be no bigger than 100kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The distro's name.</p> </div> </td> </tr> <tr> <td> <p> <strong>oci_project_admin_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>OCI Project Administrator</p> <p>The person or team that has the rights to manage OCI Projects for this distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_answers</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> People can ask questions in Launchpad Answers </p> </td> </tr> <tr> <td> <p> <strong>official_blueprints</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> This project uses blueprints </p> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bugs</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Bugs in this project are tracked in Launchpad </p> </td> </tr> <tr> <td> <p> <strong>official_codehosting</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Code for this project is published in Bazaar branches on Launchpad </p> </td> </tr> <tr> <td> <p> <strong>official_packages</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Packages are tracked in Launchpad </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The restricted team, moderated team, or person who maintains the distribution information in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Distribution is confidential</p> <p>If set, this distribution is visible only to those with access grants.</p> </div> </td> </tr> <tr> <td> <p> <strong>redirect_default_traversal</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Redirect the default traversal</p> <p>If true, the default traversal is for migration and redirects to a different canonical URL.</p> </div> </td> </tr> <tr> <td> <p> <strong>redirect_release_uploads</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Redirect release pocket uploads</p> <p>Redirect release pocket uploads to proposed pocket</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The distro's registrant.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>security_admin_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Security Administrator</p> <p>The distribution security administrator.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>series_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a> collection. </td> <td> <p> DistroSeries inside this Distribution </p> </td> </tr> <tr> <td> <p> <strong>specification_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td> <div> <p>Blueprint sharing policy</p> <p>Sharing policy for this project's specifications.</p> </div> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A short paragraph to introduce the goals and highlights of the distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>supports_mirrors</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Enable mirror listings and probes </p> </td> </tr> <tr> <td> <p> <strong>supports_ppas</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Enable PPA creation and publication </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The distro's title.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationgroup_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#translation_group">translation_group</a>. </td> <td> <div> <p>Translation group</p> <p>The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationpermission</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open</tt> </li> <li> <tt>Structured</tt> </li> <li> <tt>Restricted</tt> </li> <li> <tt>Closed</tt> </li> </ul> </td> <td> <div> <p>Translation permissions policy</p> <p>The policy this project or distribution uses to balance openness and control for their translations.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>vcs</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Bazaar</tt> </li> <li> <tt>Git</tt> </li> </ul> </td> <td> <div> <p>VCS</p> <p>Version control system for this distribution's code.</p> </div> </td> </tr> <tr> <td> <p> <strong>vulnerabilities_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#vulnerability">vulnerability</a> collection. </td> <td> <p> Vulnerabilities in this distribution. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="distribution-standard-methods" title="distribution-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distribution-custom-GETs" title="distribution-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="distribution-canUserAlterAnswerContact" title="distribution-canUserAlterAnswerContact">canUserAlterAnswerContact</h5> <div> <p>Can the user add or remove the answer contact.</p> <p>Users can add or remove themselves or one of the teams they administered. Admins and target owners can add/remove anyone.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canUserAlterAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user or an administered team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="distribution-findReferencedOOPS" title="distribution-findReferencedOOPS">findReferencedOOPS</h5> <div> <p>Find OOPS reports between start_date and end_date.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>findReferencedOOPS</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>end_date</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Modified before date </p> </td> </tr> <tr> <td> <p> <strong>start_date</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Modified after date </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A set of OOPS id's - strings of the form 'OOPS-w+'.</td> </p> </div> <div class="method"><h5 id="distribution-findSimilarQuestions" title="distribution-findSimilarQuestions">findSimilarQuestions</h5><div> <p>Return questions similar to phrase.</p> <p>Return a list of question similar to the provided phrase. These questions will be found using a fuzzy search. The list is ordered from the most similar question to the least similar question.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findSimilarQuestions</var></p></td><td></td></tr><tr><td><p><strong>phrase</strong></p></td><td><p><small>(required)</small></p></td><td><p> A phrase </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="distribution-getAnswerContactsForLanguage" title="distribution-getAnswerContactsForLanguage">getAnswerContactsForLanguage</h5><div> <p>Return the list of Persons that provide support for a language.</p> <p>An answer contact supports questions in their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAnswerContactsForLanguage</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="distribution-getArchive" title="distribution-getArchive">getArchive</h5><div> <p>Return the distribution archive with the given name.</p> <p>Only distribution archives are considered -- PPAs will not be found.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getArchive</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Archive name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive">archive</a>. </p> </div> <div class="method"><h5 id="distribution-getBestMirrorsForCountry" title="distribution-getBestMirrorsForCountry">getBestMirrorsForCountry</h5><div> <p>Return the best mirrors to be used by someone in the given country.</p> <p>The list of mirrors is composed by the official mirrors located in the given country (or in the country's continent if the country doesn't have any) plus the main mirror of that type.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBestMirrorsForCountry</var></p></td><td></td></tr><tr><td><p><strong>country</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#country">country</a>. </td><td><div> <p>Location</p> <p>The country in which this mirror is based.</p> </div></td></tr><tr><td><p><strong>mirror_type</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Archive</tt></li><li><tt>CD Image</tt></li></ul></td><td><div> <p>Content</p> <p>Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_mirror">distribution_mirror</a> collection. </p> </div> <div class="method"> <h5 id="distribution-getBranchTips" title="distribution-getBranchTips">getBranchTips</h5> <div> <p>Return a list of branches which have new tips since a date.</p> <p>Each branch information is a tuple of (branch_unique_name, tip_revision, (official_series*)).</p> <p>So for each branch in the distribution, you'll get the branch unique name, the revision id of tip, and if the branch is official for some series, the list of series name.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBranchTips</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>since</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Time of last change</p> <p>Return branches that have new tips since this timestamp.</p> </div> </td> </tr> </table> </div> <div class="method"><h5 id="distribution-getBuildRecords" title="distribution-getBuildRecords">getBuildRecords</h5><div> <p>Return build records in the context it is implemented.</p> <p>It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.</p> <p>The result is simply not filtered if the optional filters are omitted by call sites.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildRecords</var></p></td><td></td></tr><tr><td><p><strong>build_state</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs building</tt></li><li><tt>Successfully built</tt></li><li><tt>Failed to build</tt></li><li><tt>Dependency wait</tt></li><li><tt>Chroot problem</tt></li><li><tt>Build for superseded Source</tt></li><li><tt>Currently building</tt></li><li><tt>Failed to upload</tt></li><li><tt>Uploading build</tt></li><li><tt>Cancelling build</tt></li><li><tt>Cancelled build</tt></li><li><tt>Gathering build output</tt></li></ul></td><td><div> <p>Build status</p> <p>The status of this build record</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> <div class="method"><h5 id="distribution-getCountryMirror" title="distribution-getCountryMirror">getCountryMirror</h5><p> Return the country DNS mirror for a country and content type. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getCountryMirror</var></p></td><td></td></tr><tr><td><p><strong>country</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#country">country</a>. </td><td><div> <p>Location</p> <p>The country in which this mirror is based.</p> </div></td></tr><tr><td><p><strong>mirror_type</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Archive</tt></li><li><tt>CD Image</tt></li></ul></td><td><div> <p>Content</p> <p>Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_mirror">distribution_mirror</a>. </p> </div> <div class="method"><h5 id="distribution-getDevelopmentSeries" title="distribution-getDevelopmentSeries">getDevelopmentSeries</h5><p> Return the DistroSeries which are marked as in development. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDevelopmentSeries</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series">distro_series</a> collection. </p> </div> <div class="method"><h5 id="distribution-getMilestone" title="distribution-getMilestone">getMilestone</h5><p> Return a milestone with the given name for this object, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMilestone</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#milestone">milestone</a>. </p> </div> <div class="method"><h5 id="distribution-getMirrorByName" title="distribution-getMirrorByName">getMirrorByName</h5><p> Return the mirror with the given name for this distribution or None if it's not found. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMirrorByName</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_mirror">distribution_mirror</a>. </p> </div> <div class="method"><h5 id="distribution-getOCIProject" title="distribution-getOCIProject">getOCIProject</h5><p> Return a OCIProject with the given name for this distribution, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOCIProject</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> OCI project name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#oci_project">oci_project</a>. </p> </div> <div class="method"> <h5 id="distribution-getQuestion" title="distribution-getQuestion">getQuestion</h5> <div> <p>Return the question by its id, if it is applicable to this target.</p> <p>If there is no such question number for this target, return None</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getQuestion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>question_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Question Number </p> </td> </tr> </table> </div> <div class="method"><h5 id="distribution-getSeries" title="distribution-getSeries">getSeries</h5><div> <p>Return the series with the name or version given.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSeries</var></p></td><td></td></tr><tr><td><p><strong>name_or_version</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name or version </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series">distro_series</a>. </p> </div> <div class="method"><h5 id="distribution-getSourcePackage" title="distribution-getSourcePackage">getSourcePackage</h5><p> Return a DistributionSourcePackage with the given name for this distribution, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSourcePackage</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_source_package">distribution_source_package</a>. </p> </div> <div class="method"><h5 id="distribution-getSpecification" title="distribution-getSpecification">getSpecification</h5><p> Returns the specification with the given name, for this target, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSpecification</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the specification </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a>. </p> </div> <div class="method"><h5 id="distribution-getSubscription" title="distribution-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distribution-getSubscriptions" title="distribution-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="distribution-getSupportedLanguages" title="distribution-getSupportedLanguages">getSupportedLanguages</h5><div> <p>Return a list of languages spoken by at the answer contacts.</p> <p>An answer contact is considered to speak a given language if that language is listed as one of their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSupportedLanguages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#language">language</a> collection. </p> </div> <div class="method"><h5 id="distribution-getTranslationImportQueueEntries" title="distribution-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="distribution-searchOCIProjects" title="distribution-searchOCIProjects">searchOCIProjects</h5><p> Search for OCI projects that match the title text. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchOCIProjects</var></p></td><td></td></tr><tr><td><p><strong>text</strong></p></td><td><p></p></td><td><p> OCI title substring match </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#oci_project">oci_project</a> collection. </p> </div> <div class="method"><h5 id="distribution-searchQuestions" title="distribution-searchQuestions">searchQuestions</h5><div> <p>Return the questions from the collection matching search criteria.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention_from</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="distribution-searchSourcePackages" title="distribution-searchSourcePackages">searchSourcePackages</h5><div> <p>Search for source packages that correspond to the given text.</p> <p>This method just decorates the result of searchSourcePackageCaches() to return DistributionSourcePackages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchSourcePackages</var></p></td><td></td></tr><tr><td><p><strong>source_match</strong></p></td><td><p><small>(required)</small></p></td><td><p> Source package name substring match </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_source_package">distribution_source_package</a> collection. </p> </div> <div class="method"><h5 id="distribution-searchTasks" title="distribution-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="distribution-userHasBugSubscriptions" title="distribution-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="distribution-custom-POSTs" title="distribution-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="distribution-addAnswerContact" title="distribution-addAnswerContact">addAnswerContact</h5> <div> <p>Add a new answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was added, False if the person already is an answer contact.</td> </p> </div> <div class="method"><h5 id="distribution-addBugSubscription" title="distribution-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distribution-addBugSubscriptionFilter" title="distribution-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"> <h5 id="distribution-addOfficialBugTag" title="distribution-addOfficialBugTag">addOfficialBugTag</h5> <p> Add tag to the official bug tags of this target. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addOfficialBugTag</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>tag</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The official bug tag </p> </td> </tr> </table> </div> <div class="method"> <h5 id="distribution-deleteOCICredentials" title="distribution-deleteOCICredentials">deleteOCICredentials</h5> <p> Delete any existing OCI credentials for the distribution. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteOCICredentials</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="distribution-newOCIProject" title="distribution-newOCIProject">newOCIProject</h5><p> Create an IOCIProject for this distro. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newOCIProject</var></p></td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description for this OCI project.</p> <p>A short description of this OCI project.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>The OCI project name.</p> <p>The name that groups a set of OCI recipes together.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#oci_project">oci_project</a>. </p> </div> <div class="method"> <h5 id="distribution-newVulnerability" title="distribution-newVulnerability">newVulnerability</h5> <p> Create a new vulnerability in the distribution. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>newVulnerability</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>creator</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person creating the vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>cve</strong> </p> </td> <td><p></p> Link to a <a href="#cve">cve</a>. </td> <td> <p> External CVE reference corresponding to this vulnerability, if any. </p> </td> </tr> <tr> <td> <p> <strong>date_made_public</strong> </p> </td> <td> <p></p> </td> <td> <p> The date this vulnerability was made public. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p></p> </td> <td> <p> A short description of the vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>importance</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Undecided</tt> </li> <li> <tt>Critical</tt> </li> <li> <tt>High</tt> </li> <li> <tt>Medium</tt> </li> <li> <tt>Low</tt> </li> <li> <tt>Wishlist</tt> </li> </ul> </td> <td> <p> Indicates the work priority, not the severity. Defaults to Undecided. </p> </td> </tr> <tr> <td> <p> <strong>importance_explanation</strong> </p> </td> <td> <p></p> </td> <td> <p> Used to explain why our importance differs from somebody else's CVSS score. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <p> Information Type. Defaults to Public. </p> </td> </tr> <tr> <td> <p> <strong>mitigation</strong> </p> </td> <td> <p></p> </td> <td> <p> Explains why we're ignoring this vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>notes</strong> </p> </td> <td> <p></p> </td> <td> <p> Free-form notes for this vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs triage</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Ignored</tt> </li> <li> <tt>Retired</tt> </li> </ul> </td> <td> <p> The status of the vulnerability. </p> </td> </tr> </table> </div> <div class="method"><h5 id="distribution-newWebhook" title="distribution-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"> <h5 id="distribution-removeAnswerContact" title="distribution-removeAnswerContact">removeAnswerContact</h5> <div> <p>Remove an answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was removed, False if the person wasn't an answer contact.</td> </p> </div> <div class="method"> <h5 id="distribution-removeBugSubscription" title="distribution-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="distribution-removeOfficialBugTag" title="distribution-removeOfficialBugTag">removeOfficialBugTag</h5> <p> Remove tag from the official bug tags of this target. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeOfficialBugTag</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>tag</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The official bug tag </p> </td> </tr> </table> </div> <div class="method"> <h5 id="distribution-setOCICredentials" title="distribution-setOCICredentials">setOCICredentials</h5> <p> Set the credentials for the OCI registry for OCI projects. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setOCICredentials</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>password</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Password</p> <p>The password for the OCI registry.</p> </div> </td> </tr> <tr> <td> <p> <strong>region</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>OCI registry region.</p> <p>The region of the OCI registry.</p> </div> </td> </tr> <tr> <td> <p> <strong>registry_url</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>The registry url.</p> <p>The url of the OCI registry to use.</p> </div> </td> </tr> <tr> <td> <p> <strong>username</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Username</p> <p>The username for the OCI registry.</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distribution_mirror" title="distribution_mirror">distribution_mirror</h3> <p> A mirror of a given distribution. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Base URL</p> <p>The HTTP or FTP base URL of this mirror</p> </div> </td> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Archive</tt> </li> <li> <tt>CD Image</tt> </li> </ul> </td> <td> <div> <p>Content</p> <p>Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>country_dns_mirror</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Country DNS Mirror</p> <p>Whether this is a country mirror in DNS.</p> </div> </td> </tr> <tr> <td> <p> <strong>country_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#country">country</a>. </td> <td> <div> <p>Location</p> <p>The country in which this mirror is based.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date on which this mirror was registered.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_reviewed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date reviewed</p> <p>The date on which this mirror was last reviewed by a mirror admin.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Description </p> </td> </tr> <tr> <td> <p> <strong>displayname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Organisation</p> <p>The name of the organization hosting this mirror.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>The distribution that is mirrored</p> </div> </td> </tr> <tr> <td> <p> <strong>enabled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> This mirror was probed successfully. </p> </td> </tr> <tr> <td> <p> <strong>ftp_base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>FTP URL</p> <p>e.g.: <a class="rst-reference external" href="ftp://archive.ubuntu.com/ubuntu/" target="_top">ftp://archive.ubuntu.com/ubuntu/</a></p> </div> </td> </tr> <tr> <td> <p> <strong>http_base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>HTTP URL</p> <p>e.g.: <a class="rst-reference external" href="http://archive.ubuntu.com/ubuntu/" target="_top">http://archive.ubuntu.com/ubuntu/</a></p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>https_base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> HTTPS URL </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>A short and unique name for this mirror.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_candidate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Apply to be an official mirror of this distribution </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The person who is set as the current administrator of thismirror.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Reviewer</p> <p>The person who last reviewed this mirror.</p> </div> </td> </tr> <tr> <td> <p> <strong>rsync_base_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Rsync URL</p> <p>e.g.: rsync://archive.ubuntu.com/ubuntu/</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>speed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>128 Kbps</tt> </li> <li> <tt>256 Kbps</tt> </li> <li> <tt>512 Kbps</tt> </li> <li> <tt>1 Mbps</tt> </li> <li> <tt>2 Mbps</tt> </li> <li> <tt>10 Mbps</tt> </li> <li> <tt>45 Mbps</tt> </li> <li> <tt>100 Mbps</tt> </li> <li> <tt>1 Gbps</tt> </li> <li> <tt>2 Gbps</tt> </li> <li> <tt>4 Gbps</tt> </li> <li> <tt>10 Gbps</tt> </li> <li> <tt>20 Gbps</tt> </li> <li> <tt>50 Gbps</tt> </li> <li> <tt>100 Gbps</tt> </li> </ul> </td> <td> <p> Link Speed </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending review</tt> </li> <li> <tt>Unofficial</tt> </li> <li> <tt>Official</tt> </li> <li> <tt>Broken</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of a mirror's registration.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>whiteboard</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Whiteboard</p> <p>Notes on the current status of the mirror (only visible to admins and the mirror's registrant).</p> </div> </td> </tr> </table> </div> <div id="distribution_mirror-standard-methods" title="distribution_mirror-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distribution_mirror-custom-GETs" title="distribution_mirror-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="distribution_mirror-canTransitionToCountryMirror" title="distribution_mirror-canTransitionToCountryMirror">canTransitionToCountryMirror</h5> <p> Verify if a mirror can be set as a country mirror or return False. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canTransitionToCountryMirror</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distribution_mirror-getOverallFreshness" title="distribution_mirror-getOverallFreshness">getOverallFreshness</h5> <div> <p>Return this mirror's overall freshness.</p> <p>For ARCHIVE mirrors, the overall freshness is the worst freshness of all of this mirror's content objects (MirrorDistroArchSeries, MirrorDistroSeriesSource or MirrorCDImageDistroSeriess).</p> <p>For RELEASE mirrors, the overall freshness is either UP (up to date), if the mirror contains all ISO images that it should or UNKNOWN if it doesn't contain one or more ISO images.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getOverallFreshness</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distribution_mirror-isOfficial" title="distribution_mirror-isOfficial">isOfficial</h5> <p> Return True if this is an official mirror. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isOfficial</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distribution_source_package" title="distribution_source_package">distribution_source_package</h3> <div> <p>Represents a source package in a distribution.</p> <p>Create IDistributionSourcePackages by invoking IDistribution.getSourcePackage().</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/+source/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Display name for this package. </p> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <p> The distribution. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The source package name as text </p> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Title for this package. </p> </td> </tr> <tr> <td> <p> <strong>upstream_product_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The upstream product to which this package is linked. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="distribution_source_package-standard-methods" title="distribution_source_package-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distribution_source_package-custom-GETs" title="distribution_source_package-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="distribution_source_package-canUserAlterAnswerContact" title="distribution_source_package-canUserAlterAnswerContact">canUserAlterAnswerContact</h5> <div> <p>Can the user add or remove the answer contact.</p> <p>Users can add or remove themselves or one of the teams they administered. Admins and target owners can add/remove anyone.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canUserAlterAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user or an administered team </p> </td> </tr> </table> </div> <div class="method"><h5 id="distribution_source_package-findSimilarQuestions" title="distribution_source_package-findSimilarQuestions">findSimilarQuestions</h5><div> <p>Return questions similar to phrase.</p> <p>Return a list of question similar to the provided phrase. These questions will be found using a fuzzy search. The list is ordered from the most similar question to the least similar question.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findSimilarQuestions</var></p></td><td></td></tr><tr><td><p><strong>phrase</strong></p></td><td><p><small>(required)</small></p></td><td><p> A phrase </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-getAnswerContactsForLanguage" title="distribution_source_package-getAnswerContactsForLanguage">getAnswerContactsForLanguage</h5><div> <p>Return the list of Persons that provide support for a language.</p> <p>An answer contact supports questions in their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAnswerContactsForLanguage</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-getBranches" title="distribution_source_package-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-getMergeProposals" title="distribution_source_package-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"> <h5 id="distribution_source_package-getQuestion" title="distribution_source_package-getQuestion">getQuestion</h5> <div> <p>Return the question by its id, if it is applicable to this target.</p> <p>If there is no such question number for this target, return None</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getQuestion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>question_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Question Number </p> </td> </tr> </table> </div> <div class="method"><h5 id="distribution_source_package-getSubscription" title="distribution_source_package-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distribution_source_package-getSubscriptions" title="distribution_source_package-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-getSupportedLanguages" title="distribution_source_package-getSupportedLanguages">getSupportedLanguages</h5><div> <p>Return a list of languages spoken by at the answer contacts.</p> <p>An answer contact is considered to speak a given language if that language is listed as one of their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSupportedLanguages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#language">language</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-searchQuestions" title="distribution_source_package-searchQuestions">searchQuestions</h5><div> <p>Return the questions from the collection matching search criteria.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention_from</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="distribution_source_package-searchTasks" title="distribution_source_package-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="distribution_source_package-userHasBugSubscriptions" title="distribution_source_package-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="distribution_source_package-custom-POSTs" title="distribution_source_package-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="distribution_source_package-addAnswerContact" title="distribution_source_package-addAnswerContact">addAnswerContact</h5> <div> <p>Add a new answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was added, False if the person already is an answer contact.</td> </p> </div> <div class="method"><h5 id="distribution_source_package-addBugSubscription" title="distribution_source_package-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distribution_source_package-addBugSubscriptionFilter" title="distribution_source_package-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"><h5 id="distribution_source_package-newCodeImport" title="distribution_source_package-newCodeImport">newCodeImport</h5><div> <p>Create a new code import.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newCodeImport</var></p></td><td></td></tr><tr><td><p><strong>branch_name</strong></p></td><td><p></p></td><td><p> Name of branch to create </p></td></tr><tr><td><p><strong>cvs_module</strong></p></td><td><p></p></td><td><p> CVS module to import </p></td></tr><tr><td><p><strong>cvs_root</strong></p></td><td><p></p></td><td><p> CVS root URL </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner of the resulting branch </p></td></tr><tr><td><p><strong>rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Concurrent Versions System</tt></li><li><tt>Subversion via CSCVS</tt></li><li><tt>Subversion via bzr-svn</tt></li><li><tt>Git</tt></li><li><tt>Mercurial</tt></li><li><tt>Bazaar</tt></li></ul></td><td></td></tr><tr><td><p><strong>target_rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Bazaar</tt></li><li><tt>Git</tt></li></ul></td><td></td></tr><tr><td><p><strong>url</strong></p></td><td><p></p></td><td><p> Foreign VCS URL </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#code_import">code_import</a>. </p> </div> <div class="method"><h5 id="distribution_source_package-newWebhook" title="distribution_source_package-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"> <h5 id="distribution_source_package-removeAnswerContact" title="distribution_source_package-removeAnswerContact">removeAnswerContact</h5> <div> <p>Remove an answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was removed, False if the person wasn't an answer contact.</td> </p> </div> <div class="method"> <h5 id="distribution_source_package-removeBugSubscription" title="distribution_source_package-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distro_arch_series" title="distro_arch_series">distro_arch_series</h3> <p> An architecture for a distroseries. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/<var><distroseries.name></var>/<var><architecture_tag></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>architecture_tag</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Architecture Tag</p> <p>The architecture tag, or short piece of text that identifies this architecture. All binary packages in the archive will use this tag in their filename. Please get it correct. It should really never be changed!</p> </div> </td> </tr> <tr> <td> <p> <strong>chroot_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Build chroot URL</p> <p>The URL to the current build chroot for this distroarchseries.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display name</p> <p>The display name of this distroarchseries.</p> </div> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> The context distroseries </p> </td> </tr> <tr> <td> <p> <strong>enabled</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Enabled</p> <p>Whether or not this DistroArchSeries is enabled for build creation and publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_nominated_arch_indep</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Is Nominated Arch Independent</p> <p>True if this distroarchseries is the NominatedArchIndep one.</p> </div> </td> </tr> <tr> <td> <p> <strong>main_archive_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Main Archive</p> <p>The main archive of the distroarchseries.</p> </div> </td> </tr> <tr> <td> <p> <strong>official</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Official Support</p> <p>Indicate whether or not this port has official support from the vendor of the distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who registered this port. </p> </td> </tr> <tr> <td> <p> <strong>package_count</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Package Count</p> <p>A cache of the number of packages published in the RELEASE pocket of this port.</p> </div> </td> </tr> <tr> <td> <p> <strong>processor_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a>. </td> <td> <p> Processor </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>supports_virtualized</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>PPA support available</p> <p>Indicate whether or not this port has support for building PPA packages.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The title of this distroarchseries.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="distro_arch_series-standard-methods" title="distro_arch_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distro_arch_series-custom-GETs" title="distro_arch_series-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="distro_arch_series-getBuildRecords" title="distro_arch_series-getBuildRecords">getBuildRecords</h5><div> <p>Return build records in the context it is implemented.</p> <p>It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.</p> <p>The result is simply not filtered if the optional filters are omitted by call sites.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildRecords</var></p></td><td></td></tr><tr><td><p><strong>build_state</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs building</tt></li><li><tt>Successfully built</tt></li><li><tt>Failed to build</tt></li><li><tt>Dependency wait</tt></li><li><tt>Chroot problem</tt></li><li><tt>Build for superseded Source</tt></li><li><tt>Currently building</tt></li><li><tt>Failed to upload</tt></li><li><tt>Uploading build</tt></li><li><tt>Cancelling build</tt></li><li><tt>Cancelled build</tt></li><li><tt>Gathering build output</tt></li></ul></td><td><div> <p>Build status</p> <p>The status of this build record</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> <div class="method"> <h5 id="distro_arch_series-getChrootHash" title="distro_arch_series-getChrootHash">getChrootHash</h5> <p> Return applicable hashes for the current chroot of this pocket. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getChrootHash</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>image_type</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Chroot tarball</tt> </li> <li> <tt>LXD image</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_arch_series-getChrootURL" title="distro_arch_series-getChrootURL">getChrootURL</h5> <div> <p>Return the chroot URL for this series, pocket, and image type.</p> <p>The pocket defaults to "Release"; the image type defaults to "Chroot tarball".</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getChrootURL</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>image_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Chroot tarball</tt> </li> <li> <tt>LXD image</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="distro_arch_series-getSourceFilter" title="distro_arch_series-getSourceFilter">getSourceFilter</h5><div> <p>Get the filter for packages to build for this architecture, if any.</p> <p>Packages are normally built for all available architectures, subject to any constraints in their Architecture field. If a filter is set, then it applies the additional constraint that packages not included by the filter will not be built for this architecture.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSourceFilter</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_arch_series_filter">distro_arch_series_filter</a>. </p> </div> </div> <div id="distro_arch_series-custom-POSTs" title="distro_arch_series-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="distro_arch_series-removeChroot" title="distro_arch_series-removeChroot">removeChroot</h5> <div> <p>Remove the chroot tarball used for builds in this architecture.</p> <p>The pocket defaults to "Release"; the image type defaults to "Chroot tarball".</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeChroot</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>image_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Chroot tarball</tt> </li> <li> <tt>LXD image</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_arch_series-removeSourceFilter" title="distro_arch_series-removeSourceFilter">removeSourceFilter</h5> <div> <p>Remove any filter for packages to build for this architecture.</p> <p>This causes packages to be built for this architecture when they might previously have been filtered, subject to any constraints in their Architecture field.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeSourceFilter</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_arch_series-setChroot" title="distro_arch_series-setChroot">setChroot</h5> <div> <p>Set the chroot tarball used for builds in this architecture.</p> <p>The SHA-1 checksum must match the chroot file.</p> <p>The pocket defaults to "Release"; the image type defaults to "Chroot tarball".</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setChroot</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>data</strong> </p> </td> <td><p><small>(required)</small></p> Link to a file resource. </td> <td></td> </tr> <tr> <td> <p> <strong>image_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Chroot tarball</tt> </li> <li> <tt>LXD image</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>sha1sum</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_arch_series-setChrootFromBuild" title="distro_arch_series-setChrootFromBuild">setChrootFromBuild</h5> <div> <p>Set the chroot tarball from a live filesystem build.</p> <p>The pocket defaults to "Release"; the image type defaults to "Chroot tarball".</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setChrootFromBuild</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>filename</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Filename </p> </td> </tr> <tr> <td> <p> <strong>image_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Chroot tarball</tt> </li> <li> <tt>LXD image</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>livefsbuild</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#livefs_build">livefs_build</a>. </td> <td> <p> Live filesystem build </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_arch_series-setSourceFilter" title="distro_arch_series-setSourceFilter">setSourceFilter</h5> <div> <p>Set a filter for packages to build for this architecture.</p> <p>Packages are normally built for all available architectures, subject to any constraints in their Architecture field. If a filter is set, then it applies the additional constraint that packages not included by the filter will not be built for this architecture.</p> <p>If the sense of the filter is "Include", then the filter only includes packages in the given package set. If the sense of the filter is "Exclude", then the filter only includes packages not in the given package set.</p> <p>Later changes to the given package set will also affect any filters using it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setSourceFilter</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>packageset</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td> <td> <p> Package set </p> </td> </tr> <tr> <td> <p> <strong>sense</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Include</tt> </li> <li> <tt>Exclude</tt> </li> </ul> </td> <td> <p> Sense </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distro_arch_series_filter" title="distro_arch_series_filter">distro_arch_series_filter</h3> <div> <p>A filter for packages to be included in or excluded from a DAS.</p> <p>Since package sets can include other package sets, a single package set is flexible enough for this. However, one might reasonably want to either include some packages ("this architecture is obsolescent or experimental and we only want to build a few packages for it") or exclude some packages ("this architecture can't handle some packages so we want to make them go away centrally").</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/<var><distroseries.name></var>/<var><architecture_tag></var>/+source-filter</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>creator_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Creator</p> <p>The user who created this filter.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The time when this filter was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date last modified</p> <p>The time when this filter was last modified.</p> </div> </td> </tr> <tr> <td> <p> <strong>distroarchseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <div> <p>Distro arch series</p> <p>The distro arch series that this filter is for.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>packageset_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#packageset">packageset</a>. </td> <td> <div> <p>Package set</p> <p>The package set to be included in or excluded from this distro arch series.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>sense</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Include</tt> </li> <li> <tt>Exclude</tt> </li> </ul> </td> <td> <div> <p>Sense</p> <p>Whether the filter represents packages to include or exclude from the distro arch series.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="distro_arch_series_filter-standard-methods" title="distro_arch_series_filter-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distro_series" title="distro_series">distro_series</h3> <p> A series of an operating system distribution. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.</p> </div> </td> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> The visible and active milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>advertise_by_hash</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Advertise by-hash directories</p> <p>Advertise by-hash directories with a flag in the Release file so that apt uses them by default. Only effective if publish_by_hash is also set.</p> </div> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> All milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>architectures_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a> collection. </td> <td> <div> <p>Enabled architectures</p> <p>All architectures in this series with the 'enabled' flag set.</p> </div> </td> </tr> <tr> <td> <p> <strong>backports_not_automatic</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Don't upgrade to backports automatically</p> <p>Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release files generated for the backports pocket. This tells apt to automatically upgrade within backports, but not into it.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>changeslist</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Email changes to</p> <p>The mailing list or other email address that Launchpad should notify about new uploads.</p> </div> </td> </tr> <tr> <td> <p> <strong>component_names</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The series component names </p> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date this series was registered. </p> </td> </tr> <tr> <td> <p> <strong>datereleased</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Date released </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A detailed description of this series, with information on the architectures covered, the availability of security updates and any other relevant information.</p> </div> </td> </tr> <tr> <td> <p> <strong>displayname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display name</p> <p>The series displayname.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>The distribution for which this is a series.</p> </div> </td> </tr> <tr> <td> <p> <strong>driver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Driver</p> <p>The person or team responsible for decisions about features and bugs that will be targeted to this series of the distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>drivers_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> A list of the people or teams who are drivers for this series. This list is made up of any drivers or owners from this series and the parent drivers. </p> </td> </tr> <tr> <td> <p> <strong>fullseriesname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Series full name</p> <p>The series full name, e.g. Ubuntu Warty</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>include_long_descriptions</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Include long descriptions in Packages rather than in Translation-en</p> <p>If True, write long descriptions to the per-architecture Packages files; if False, write them to a Translation-en file common across architectures instead. Using a common file reduces the bandwidth footprint of enabling multiarch on clients, which requires downloading Packages files for multiple architectures.</p> </div> </td> </tr> <tr> <td> <p> <strong>index_compressors</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Compression types to use for published index files</p> <p>A list of compression types to use for published index files (Packages, Sources, etc.).</p> </div> </td> </tr> <tr> <td> <p> <strong>language_pack_full_export_requested</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Request a full language pack export</p> <p>Whether next language pack generation will be a full export. This information is useful when update packs are too big and want to merge all those changes in the base pack.</p> </div> </td> </tr> <tr> <td> <p> <strong>main_archive_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Distribution Main Archive </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of this series.</p> </div> </td> </tr> <tr> <td> <p> <strong>nominatedarchindep_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> DistroArchSeries designed to build architecture-independent packages within this distroseries context. </p> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owning team of the derived series</p> <p>This attribute mirrors the owner of the distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>previous_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Parent series</p> <p>The series from which this one was branched.</p> </div> </td> </tr> <tr> <td> <p> <strong>proposed_not_automatic</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Don't upgrade to proposed updates automatically</p> <p>Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release files generated for the proposed pocket. This tells apt to automatically upgrade within proposed, but not into it.</p> </div> </td> </tr> <tr> <td> <p> <strong>publish_by_hash</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Publish by-hash directories</p> <p>Publish archive index files in by-hash directories so that apt can retrieve them based on their hash, avoiding race conditions between InRelease and other files during mirror updates.</p> </div> </td> </tr> <tr> <td> <p> <strong>publish_i18n_index</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Publish I18n index</p> <p>Publish archive i18n/Index file, which is believed to be unused.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Registrant </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Active Development</tt> </li> <li> <tt>Pre-release Freeze</tt> </li> <li> <tt>Current Stable Release</tt> </li> <li> <tt>Supported</tt> </li> <li> <tt>Obsolete</tt> </li> <li> <tt>Future</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>strict_supported_component_dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Strict dependencies of supported components</p> <p>If True, packages in supported components (main and restricted) may not build-depend on packages in unsupported components. Do not rely on the name of this attribute, even for reading; it is currently subject to change.</p> </div> </td> </tr> <tr> <td> <p> <strong>suite_names</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The series pocket names </p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".</p> </div> </td> </tr> <tr> <td> <p> <strong>supported</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Supported</p> <p>Whether or not this series is currently supported.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The title of this series. It should be distinctive and designed to look good at the top of a page.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Version</p> <p>The version string for this series.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="distro_series-standard-methods" title="distro_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distro_series-custom-GETs" title="distro_series-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="distro_series-getBuildRecords" title="distro_series-getBuildRecords">getBuildRecords</h5><div> <p>Return build records in the context it is implemented.</p> <p>It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.</p> <p>The result is simply not filtered if the optional filters are omitted by call sites.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildRecords</var></p></td><td></td></tr><tr><td><p><strong>build_state</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs building</tt></li><li><tt>Successfully built</tt></li><li><tt>Failed to build</tt></li><li><tt>Dependency wait</tt></li><li><tt>Chroot problem</tt></li><li><tt>Build for superseded Source</tt></li><li><tt>Currently building</tt></li><li><tt>Failed to upload</tt></li><li><tt>Uploading build</tt></li><li><tt>Cancelling build</tt></li><li><tt>Cancelled build</tt></li><li><tt>Gathering build output</tt></li></ul></td><td><div> <p>Build status</p> <p>The status of this build record</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div></td></tr><tr><td><p><strong>source_name</strong></p></td><td><p></p></td><td><p> Source package name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getDerivedSeries" title="distro_series-getDerivedSeries">getDerivedSeries</h5><p> Get all DistroSeries derived from this one. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDerivedSeries</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series">distro_series</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getDifferenceComments" title="distro_series-getDifferenceComments">getDifferenceComments</h5><div> <p>Get IDistroSeriesDifferenceComment items.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDifferenceComments</var></p></td><td></td></tr><tr><td><p><strong>since</strong></p></td><td><p></p></td><td><div> <p>Minimum creation timestamp</p> <p>Ignore comments that are older than this.</p> </div></td></tr><tr><td><p><strong>source_package_name</strong></p></td><td><p></p></td><td><div> <p>Name of source package</p> <p>Only return comments for this source package.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series_difference_comment">distro_series_difference_comment</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getDifferencesTo" title="distro_series-getDifferencesTo">getDifferencesTo</h5><div> <p>Return the differences between this series and the specified parent_series (or all the parent series if parent_series is None).</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDifferencesTo</var></p></td><td></td></tr><tr><td><p><strong>child_version_higher</strong></p></td><td><p></p></td><td><p> Only return differences for which the child's version is higher than the parent's. </p></td></tr><tr><td><p><strong>difference_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Unique to derived series</tt></li><li><tt>Missing from derived series</tt></li><li><tt>Different versions</tt></li></ul></td><td><p> Only return differences of this type. </p></td></tr><tr><td><p><strong>parent_series</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td><p> The parent series to consider. </p></td></tr><tr><td><p><strong>source_package_name_filter</strong></p></td><td><p></p></td><td><p> Only return differences for packages matching this name. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Needs attention</tt></li><li><tt>Blocklisted current version</tt></li><li><tt>Blocklisted always</tt></li><li><tt>Resolved</tt></li></ul></td><td><p> Only return differences of this status. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series_difference">distro_series_difference</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getDistroArchSeries" title="distro_series-getDistroArchSeries">getDistroArchSeries</h5><p> Return the distroarchseries for this distroseries with the given architecturetag. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDistroArchSeries</var></p></td><td></td></tr><tr><td><p><strong>archtag</strong></p></td><td><p><small>(required)</small></p></td><td><p> The architecture tag </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_arch_series">distro_arch_series</a>. </p> </div> <div class="method"><h5 id="distro_series-getPackageUploads" title="distro_series-getPackageUploads">getPackageUploads</h5><div> <p>Get package upload records for this distribution series.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPackageUploads</var></p></td><td></td></tr><tr><td><p><strong>archive</strong></p></td><td><p></p> Link to a <a href="#archive">archive</a>. </td><td><div> <p>Archive</p> <p>Return only items for this archive.</p> </div></td></tr><tr><td><p><strong>created_since_date</strong></p></td><td><p></p></td><td><div> <p>Created Since Timestamp</p> <p>Return items that are more recent than this timestamp.</p> </div></td></tr><tr><td><p><strong>custom_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>raw-installer</tt></li><li><tt>raw-translations</tt></li><li><tt>raw-dist-upgrader</tt></li><li><tt>raw-ddtp-tarball</tt></li><li><tt>raw-translations-static</tt></li><li><tt>meta-data</tt></li><li><tt>uefi</tt></li><li><tt>signing</tt></li></ul></td><td><div> <p>Custom Type</p> <p>Return only items with custom files of this type.</p> </div></td></tr><tr><td><p><strong>exact_match</strong></p></td><td><p></p></td><td><div> <p>Exact match</p> <p>Whether to filter name and version by exact matching.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p></p></td><td><p> Package or file name </p></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><div> <p>Pocket</p> <p>Return only items targeted to this pocket</p> </div></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>New</tt></li><li><tt>Unapproved</tt></li><li><tt>Accepted</tt></li><li><tt>Done</tt></li><li><tt>Rejected</tt></li></ul></td><td><div> <p>Package Upload Status</p> <p>Return only items that have this status.</p> </div></td></tr><tr><td><p><strong>version</strong></p></td><td><p></p></td><td><p> Package version </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#package_upload">package_upload</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getParentSeries" title="distro_series-getParentSeries">getParentSeries</h5><p> Get all parent DistroSeries. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getParentSeries</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distro_series">distro_series</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getSourcePackage" title="distro_series-getSourcePackage">getSourcePackage</h5><div> <p>Return a source package in this distro series by name.</p> <p>The name given may be a string or an ISourcePackageName-providing object. The source package may not be published in the distro series.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSourcePackage</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the source package </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package">source_package</a>. </p> </div> <div class="method"><h5 id="distro_series-getSpecification" title="distro_series-getSpecification">getSpecification</h5><p> Returns the specification with the given name, for this target, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSpecification</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the specification </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a>. </p> </div> <div class="method"><h5 id="distro_series-getSubscription" title="distro_series-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distro_series-getSubscriptions" title="distro_series-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="distro_series-getTranslationImportQueueEntries" title="distro_series-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"> <h5 id="distro_series-getTranslationTemplateStatistics" title="distro_series-getTranslationTemplateStatistics">getTranslationTemplateStatistics</h5> <div> <p>Return statistics for translation templates in this series.</p> <p>The return value is a list of dicts for each template in the series, each of which has this form:</p> <pre class="rst-literal-block"> { "sourcepackage": ..., "translation_domain": ..., "name": ..., "total": ..., "enabled": ..., "languagepack": ..., "priority": ..., "date_last_updated": ..., } </pre> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getTranslationTemplateStatistics</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="distro_series-getTranslationTemplates" title="distro_series-getTranslationTemplates">getTranslationTemplates</h5><div> <p>Return an iterator over all its translation templates.</p> <p>The returned templates are either obsolete or current.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationTemplates</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_template">translation_template</a> collection. </p> </div> <div class="method"><h5 id="distro_series-searchTasks" title="distro_series-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="distro_series-userHasBugSubscriptions" title="distro_series-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="distro_series-custom-POSTs" title="distro_series-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="distro_series-addBugSubscription" title="distro_series-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="distro_series-addBugSubscriptionFilter" title="distro_series-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"> <h5 id="distro_series-initDerivedDistroSeries" title="distro_series-initDerivedDistroSeries">initDerivedDistroSeries</h5> <div> <p>Initialize this series from parents.</p> <p>This method performs checks and then creates a job to populate the new distroseries.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>initDerivedDistroSeries</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>archindep_archtag</strong> </p> </td> <td> <p></p> </td> <td> <p> Architecture tag to build architecture-independent packages. </p> </td> </tr> <tr> <td> <p> <strong>architectures</strong> </p> </td> <td> <p></p> </td> <td> <p> The list of architectures to copy to the derived distroseries. </p> </td> </tr> <tr> <td> <p> <strong>overlay_components</strong> </p> </td> <td> <p></p> </td> <td> <p> The list of overlay components. </p> </td> </tr> <tr> <td> <p> <strong>overlay_pockets</strong> </p> </td> <td> <p></p> </td> <td> <p> The list of overlay pockets. </p> </td> </tr> <tr> <td> <p> <strong>overlays</strong> </p> </td> <td> <p></p> </td> <td> <p> The list of booleans indicating, for each parent, if the parent/child relationship should be an overlay. </p> </td> </tr> <tr> <td> <p> <strong>packagesets</strong> </p> </td> <td> <p></p> </td> <td> <p> The list of packagesets to copy to the derived distroseries </p> </td> </tr> <tr> <td> <p> <strong>parents</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The list of parents to derive from. </p> </td> </tr> <tr> <td> <p> <strong>rebuild</strong> </p> </td> <td> <p></p> </td> <td> <p> If binaries will be copied to the derived distroseries. </p> </td> </tr> </table> </div> <div class="method"><h5 id="distro_series-newMilestone" title="distro_series-newMilestone">newMilestone</h5><p> Create a new milestone for this DistroSeries. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newMilestone</var></p></td><td></td></tr><tr><td><p><strong>code_name</strong></p></td><td><p></p></td><td><div> <p>Code name</p> <p>An alternative name for the milestone.</p> </div></td></tr><tr><td><p><strong>date_targeted</strong></p></td><td><p></p></td><td><div> <p>Date Targeted</p> <p>Example: 2005-11-24</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>Only letters, numbers, and simple punctuation are allowed.</p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p></p></td><td><div> <p>Summary</p> <p>A summary of the features and status of this milestone.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#milestone">milestone</a>. </p> </div> <div class="method"> <h5 id="distro_series-removeBugSubscription" title="distro_series-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distro_series_difference" title="distro_series_difference">distro_series_difference</h3> <p> An interface for a package difference between two distroseries. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>base_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Base version</p> <p>The common base version of the package for differences with different versions in the parent and derived series.</p> </div> </td> </tr> <tr> <td> <p> <strong>derived_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Derived series</p> <p>The distribution series which identifies the derived series with the difference.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>package_diff_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Completed</tt> </li> <li> <tt>Failed</tt> </li> </ul> </td> <td> <div> <p>Package diff status</p> <p>The status of the diff between the base version and the derived version.</p> </div> </td> </tr> <tr> <td> <p> <strong>package_diff_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Package diff url</p> <p>The url for the diff between the base version and the derived version.</p> </div> </td> </tr> <tr> <td> <p> <strong>parent_package_diff_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Completed</tt> </li> <li> <tt>Failed</tt> </li> </ul> </td> <td> <div> <p>Parent package diff status</p> <p>The status of the diff between the base version and the parent version.</p> </div> </td> </tr> <tr> <td> <p> <strong>parent_package_diff_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Parent package diff url</p> <p>The url for the diff between the base version and the parent version.</p> </div> </td> </tr> <tr> <td> <p> <strong>parent_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Parent series</p> <p>The distribution series which identifies the parent series with the difference.</p> </div> </td> </tr> <tr> <td> <p> <strong>parent_source_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Parent source version</p> <p>The version of the most recent source publishing in the parent series.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Source version</p> <p>The version of the most recent source publishing in the derived series.</p> </div> </td> </tr> <tr> <td> <p> <strong>sourcepackagename</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source Package Name </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs attention</tt> </li> <li> <tt>Blocklisted current version</tt> </li> <li> <tt>Blocklisted always</tt> </li> <li> <tt>Resolved</tt> </li> </ul> </td> <td> <div> <p>Distro series difference status.</p> <p>The current status of this difference.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="distro_series_difference-standard-methods" title="distro_series_difference-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="distro_series_difference-custom-POSTs" title="distro_series_difference-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="distro_series_difference-addComment" title="distro_series_difference-addComment">addComment</h5> <p> Add a comment on this difference. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addComment</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Comment text </p> </td> </tr> </table> </div> <div class="method"> <h5 id="distro_series_difference-blocklist" title="distro_series_difference-blocklist">blocklist</h5> <div> <p>Blocklists this version or all versions of this source package and adds a comment on this difference.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>blocklist</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>all</strong> </p> </td> <td> <p></p> </td> <td> <p> All </p> </td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Comment text </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The created DistroSeriesDifferenceComment object.</td> </p> </div> <div class="method"> <h5 id="distro_series_difference-requestPackageDiffs" title="distro_series_difference-requestPackageDiffs">requestPackageDiffs</h5> <div> <p>Requests IPackageDiffs for the derived and parent version.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>requestPackageDiffs</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="distro_series_difference-unblocklist" title="distro_series_difference-unblocklist">unblocklist</h5> <div> <p>Removes this difference from the blocklist and adds a comment on this difference.</p> <p>The status will be updated based on the versions.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unblocklist</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Comment text </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The created DistroSeriesDifferenceComment object.</td> </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="distro_series_difference_comment" title="distro_series_difference_comment">distro_series_difference_comment</h3> <p> A comment for a distroseries difference record. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>body_text</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Comment text</p> <p>The comment text for the related distro series difference.</p> </div> </td> </tr> <tr> <td> <p> <strong>comment_author_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The author of the comment. </p> </td> </tr> <tr> <td> <p> <strong>comment_date</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Comment date. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Source package name</p> <p>Name of the source package that this comment is for.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="distro_series_difference_comment-standard-methods" title="distro_series_difference_comment-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="email_address" title="email_address">email_address</h3> <p> The object that stores the IPerson's emails. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><person.name></var>/+email/<var><email></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>email</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Email Address </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="email_address-standard-methods" title="email_address-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="faq" title="faq">faq</h3> <div> <p>A document containing the answer to a commonly asked question.</p> <p>The answer can be in the document itself or can be hosted on a separate web site and referred to by URL.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+faq/<var><faq.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Content</p> <p>The answer for this FAQ in plain text. You may choose to include a URL to an external FAQ.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Created </p> </td> </tr> <tr> <td> <p> <strong>date_last_updated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Last Updated </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>FAQ Number</p> <p>The unique number identifying the FAQ in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>keywords</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Keywords</p> <p>One or more terms that relate to this FAQ.</p> </div> </td> </tr> <tr> <td> <p> <strong>last_updated_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Last Updated By</p> <p>The last person who modified the document.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#faq_target">faq_target</a>. </td> <td> <div> <p>Target</p> <p>Product or distribution containing this FAQ.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The title describing this FAQ, often a question.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="faq-standard-methods" title="faq-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="faq_target" title="faq_target">faq_target</h3> <p> An object that can contain a FAQ document. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="faq_target-standard-methods" title="faq_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="git_ref" title="git_ref">git_ref</h3> <p> A reference in a Git repository. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+git/<var><repository.name></var>/+ref/<var><path></var> or /~<var><person.name></var>/<var><distribution.name></var>/+source/<var><source_package.name></var>/+git/<var><repository.name></var>/+ref/<var><path></var> or /~<var><person.name></var>/+git/<var><repository.name></var>/+ref/<var><path></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>commit_sha1</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Commit SHA-1</p> <p>The full SHA-1 object name of the commit object referenced by this reference.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependent_landings_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Dependent landings</p> <p>A collection of the merge proposals that are dependent on this reference.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>landing_candidates_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing candidates</p> <p>A collection of the merge proposals where this reference is the target.</p> </div> </td> </tr> <tr> <td> <p> <strong>landing_targets_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing targets</p> <p>A collection of the merge proposals where this reference is the source.</p> </div> </td> </tr> <tr> <td> <p> <strong>path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Path</p> <p>The full path of this reference, e.g. refs/heads/master.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Repository</p> <p>The Git repository containing this reference.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="git_ref-standard-methods" title="git_ref-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="git_ref-custom-GETs" title="git_ref-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="git_ref-checkPermissions" title="git_ref-checkPermissions">checkPermissions</h5> <div> <p>Check a person's permissions on this reference.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>checkPermissions</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to check </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A list of zero or more of "create", "push", and "force-push", indicating the requested person's effective permissions on this reference.</td> </p> </div> <div class="method"> <h5 id="git_ref-getGrants" title="git_ref-getGrants">getGrants</h5> <div> <p>Get the access grants specific to this reference.</p> <p>Other grants may apply via wildcard rules.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getGrants</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="git_ref-getMergeProposals" title="git_ref-getMergeProposals">getMergeProposals</h5><p> Return matching BranchMergeProposals. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>merged_revision_ids</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> </div> <div id="git_ref-custom-POSTs" title="git_ref-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="git_ref-createMergeProposal" title="git_ref-createMergeProposal">createMergeProposal</h5><div> <p>Create a new BranchMergeProposal with this reference as the source.</p> <p>Both the merge_target and the merge_prerequisite, if it is there, must be references whose repositories have the same target as the source.</p> <p>References in personal repositories cannot specify merge proposals.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createMergeProposal</var></p></td><td></td></tr><tr><td><p><strong>commit_message</strong></p></td><td><p></p></td><td><div> <p>Commit message</p> <p>Message to use when committing this merge.</p> </div></td></tr><tr><td><p><strong>initial_comment</strong></p></td><td><p></p></td><td><div> <p>Initial comment</p> <p>Registrant's initial description of proposal.</p> </div></td></tr><tr><td><p><strong>merge_prerequisite</strong></p></td><td><p></p> Link to a <a href="#git_ref">git_ref</a>. </td><td></td></tr><tr><td><p><strong>merge_target</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td><td></td></tr><tr><td><p><strong>needs_review</strong></p></td><td><p></p></td><td><div> <p>Needs review</p> <p>If True, the proposal needs review. Otherwise, it will be work in progress.</p> </div></td></tr><tr><td><p><strong>review_types</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>reviewers</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#branch_merge_proposal">branch_merge_proposal</a>. </p> </div> <div class="method"> <h5 id="git_ref-setGrants" title="git_ref-setGrants">setGrants</h5> <div> <p>Set the access grants specific to this reference.</p> <p>Other grants may apply via wildcard rules.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setGrants</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>grants</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Grants</p> <p>The new list of grants for this reference.</p> <p>For example:</p> <pre class="rst-literal-block"> [ { "grantee_type": "Repository owner", "can_create": true, "can_push": true, "can_force_push": true }, { "grantee_type": "Person", "grantee_link": "/~example-person", "can_push": true } ] </pre> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="git_repository" title="git_repository">git_repository</h3> <p> A Git repository. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+git/<var><repository.name></var> or /~<var><person.name></var>/<var><distribution.name></var>/+source/<var><source_package.name></var>/+git/<var><repository.name></var> or /~<var><person.name></var>/+git/<var><repository.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_ref">git_ref</a> collection. </td> <td> <p> The branch references present in this repository. </p> </td> </tr> <tr> <td> <p> <strong>builder_constraints</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Builder constraints</p> <p>Builder resource tags required by builds of this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>code_import_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#code_import">code_import</a>. </td> <td> <p> The associated CodeImport, if any. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>date_last_repacked</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date last repacked</p> <p>The date that this repository was last repacked.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_scanned</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date last scanned</p> <p>The date when pack statistics were last updated for this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>default_branch</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Default branch</p> <p>The full path to the default branch for this repository, e.g. refs/heads/master.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependent_landings_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Dependent landings</p> <p>A collection of the merge proposals that are dependent on this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Display name</p> <p>Display name of the repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_https_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>HTTPS URL</p> <p>An HTTPS URL for this repository, or None in the case of private repositories.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_identity</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git identity</p> <p>If this is the default repository for some target, then this is 'lp:' plus a shortcut version of the path via that target. Otherwise it is simply 'lp:' plus the unique name.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_ssh_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>SSH URL</p> <p>A git+ssh:// URL for this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> ID </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>landing_candidates_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing candidates</p> <p>A collection of the merge proposals where this repository is the target.</p> </div> </td> </tr> <tr> <td> <p> <strong>landing_targets_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </td> <td> <div> <p>Landing targets</p> <p>A collection of the merge proposals where this repository is the source.</p> </div> </td> </tr> <tr> <td> <p> <strong>loose_object_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Loose object count</p> <p>The number of loose objects for this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The repository name. Keep very short, unique, and descriptive, because it will be used in URLs.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_default</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Owner default</p> <p>Whether this repository is the default for its owner and target.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this Git repository. This controls who can modify the repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>pack_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Pack count</p> <p>The number of packs for this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Private</p> <p>This repository is visible only to its subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>refs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_ref">git_ref</a> collection. </td> <td> <p> The references present in this repository. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this Git repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>repository_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Hosted</tt> </li> <li> <tt>Imported</tt> </li> <li> <tt>Remote</tt> </li> </ul> </td> <td> <div> <p>Repository type</p> <p>The way this repository is hosted: directly on Launchpad, or imported from somewhere else.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Review Team</p> <p>The reviewer of a repository is the person or exclusive team that is responsible for reviewing proposals and merging into this repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscribers_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Persons subscribed to this repository. </p> </td> </tr> <tr> <td> <p> <strong>subscriptions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_subscription">git_subscription</a> collection. </td> <td> <p> GitSubscriptions associated with this repository. </p> </td> </tr> <tr> <td> <p> <strong>target_default</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Target default</p> <p>Whether this repository is the default for its target.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_target">git_target</a>. </td> <td> <div> <p>Target</p> <p>The target of the repository.</p> </div> </td> </tr> <tr> <td> <p> <strong>unique_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Unique name</p> <p>Unique name of the repository, including the owner and project names.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="git_repository-standard-methods" title="git_repository-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="git_repository-custom-GETs" title="git_repository-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="git_repository-canBeDeleted" title="git_repository-canBeDeleted">canBeDeleted</h5> <div> <p>Can this repository be deleted in its current state?</p> <p>A repository is considered deletable if it is not linked to any merge proposals.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeDeleted</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="git_repository-checkRefPermissions" title="git_repository-checkRefPermissions">checkRefPermissions</h5> <div> <p>Check a person's permissions on some references in this repository.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>checkRefPermissions</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>paths</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Reference paths </p> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to check </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A dict mapping reference paths to lists of zero or more of "create", "push", and "force-push", indicating the requested person's effective permissions on each of the requested references.</td> </p> </div> <div class="method"><h5 id="git_repository-getAccessTokens" title="git_repository-getAccessTokens">getAccessTokens</h5><div> <p>Return personal access tokens for this target.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAccessTokens</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#access_token">access_token</a> collection. </p> </div> <div class="method"><h5 id="git_repository-getMergeProposals" title="git_repository-getMergeProposals">getMergeProposals</h5><p> Return matching BranchMergeProposals. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>merged_revision_ids</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="git_repository-getRefByPath" title="git_repository-getRefByPath">getRefByPath</h5><div> <p>Look up a single reference in this repository by path.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRefByPath</var></p></td><td></td></tr><tr><td><p><strong>path</strong></p></td><td><p><small>(required)</small></p></td><td><p> A string to look up as a path. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_ref">git_ref</a>. </p> </div> <div class="method"> <h5 id="git_repository-getRules" title="git_repository-getRules">getRules</h5> <p> Get the access rules for this repository. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getRules</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="git_repository-getStatusReports" title="git_repository-getStatusReports">getStatusReports</h5><div> <p>Retrieves the list of reports that exist for a commit.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getStatusReports</var></p></td><td></td></tr><tr><td><p><strong>commit_sha1</strong></p></td><td><p><small>(required)</small></p></td><td><p> The Git commit for which this report is built. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#revision_status_report">revision_status_report</a> collection. </p> </div> <div class="method"><h5 id="git_repository-getSubscription" title="git_repository-getSubscription">getSubscription</h5><p> Return the GitSubscription for this person. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> The person to search for </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_subscription">git_subscription</a>. </p> </div> <div class="method"> <h5 id="git_repository-isPersonTrustedReviewer" title="git_repository-isPersonTrustedReviewer">isPersonTrustedReviewer</h5> <div> <p>Return true if the reviewer is a trusted reviewer.</p> <p>The reviewer is trusted if they either own the repository, or are in the team that owns the repository, or they are in the review team for the repository.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>isPersonTrustedReviewer</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>reviewer</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> A person for which the reviewer status is in question. </p> </td> </tr> </table> </div> </div> <div id="git_repository-custom-POSTs" title="git_repository-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="git_repository-collectGarbage" title="git_repository-collectGarbage">collectGarbage</h5> <div> <p>Trigger a gc run for a given git repository.</p> <p>Raises Unauthorized if the repack was attempted by a person that is not an admin or a registry expert.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>collectGarbage</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="git_repository-fork" title="git_repository-fork">fork</h5><div> <p>Fork this repository to the given user's account.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>fork</var></p></td><td></td></tr><tr><td><p><strong>new_owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> The person who will own the forked repository. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a>. </p> </div> <div class="method"> <h5 id="git_repository-issueAccessToken" title="git_repository-issueAccessToken">issueAccessToken</h5> <div> <p>Issue an access token for this repository.</p> <p>Access tokens can be used to push to this repository over HTTPS. They are only valid for a single repository, and have a short expiry period (currently fixed at one week), so at the moment they are only suitable in some limited situations. By default they are currently implemented as macaroons.</p> <p>If description and scopes are both given, then issue a personal access token instead, either non-expiring or with an expiry time given by date_expires. These may be used in webservice API requests for certain methods on this repository.</p> <p>This interface is experimental, and may be changed or removed without notice.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>issueAccessToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p></p> </td> <td> <p> When the token should expire. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p></p> </td> <td> <p> A short description of the token. </p> </td> </tr> <tr> <td> <p> <strong>scopes</strong> </p> </td> <td> <p></p> </td> <td> <p> A list of scopes to be granted by this token. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">If description and scopes are both given, the secret for a new personal access token (Launchpad only records the hash of this secret and not the secret itself, so the caller must be careful to save this; personal access tokens are in development and may not entirely work yet). Otherwise, a serialised macaroon.</td> </p> </div> <div class="method"><h5 id="git_repository-newStatusReport" title="git_repository-newStatusReport">newStatusReport</h5><div> <p>Create a new status report.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newStatusReport</var></p></td><td></td></tr><tr><td><p><strong>commit_sha1</strong></p></td><td><p><small>(required)</small></p></td><td><p> The Git commit for which this report is built. </p></td></tr><tr><td><p><strong>result</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Waiting</tt></li><li><tt>Running</tt></li><li><tt>Succeeded</tt></li><li><tt>Failed</tt></li><li><tt>Skipped</tt></li><li><tt>Cancelled</tt></li></ul></td><td><p> Result of the report </p></td></tr><tr><td><p><strong>result_summary</strong></p></td><td><p></p></td><td><p> A short summary of the result. </p></td></tr><tr><td><p><strong>title</strong></p></td><td><p><small>(required)</small></p></td><td><p> A short title for the report. </p></td></tr><tr><td><p><strong>url</strong></p></td><td><p></p></td><td><div> <p>URL</p> <p>The external url of the report.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#revision_status_report">revision_status_report</a>. </p> </div> <div class="method"><h5 id="git_repository-newWebhook" title="git_repository-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"> <h5 id="git_repository-repackRepository" title="git_repository-repackRepository">repackRepository</h5> <div> <p>Trigger a repack repository operation.</p> <p>Raises Unauthorized if the repack was attempted by a person that is not an admin or a registry expert.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>repackRepository</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="git_repository-rescan" title="git_repository-rescan">rescan</h5> <div> <p>Force a rescan of this repository as a celery task.</p> <p>This may be helpful in cases where a previous scan crashed.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescan</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="git_repository-setRules" title="git_repository-setRules">setRules</h5> <p> Set the access rules for this repository. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setRules</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>rules</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Rules</p> <p>The new list of rules for this repository.</p> <p>For example:</p> <pre class="rst-literal-block"> [ { "ref_pattern": "refs/heads/*", "grants": [ { "grantee_type": "Repository owner", "can_create": true, "can_push": true, "can_force_push": true } ] }, { "ref_pattern": "refs/heads/stable/*", "grants": [ { "grantee_type": "Person", "grantee_link": "/~example-stable-team", "can_create": true, "can_push": true } ] } ] </pre> </div> </td> </tr> </table> </div> <div class="method"><h5 id="git_repository-subscribe" title="git_repository-subscribe">subscribe</h5><div> <p>Subscribe this person to the repository.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>subscribe</var></p></td><td></td></tr><tr><td><p><strong>code_review_level</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>No email</tt></li><li><tt>Status changes only</tt></li><li><tt>Email about all changes</tt></li></ul></td><td><p> The level of code review notification emails. </p></td></tr><tr><td><p><strong>max_diff_lines</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Don't send diffs</tt></li><li><tt>500 lines</tt></li><li><tt>1000 lines</tt></li><li><tt>5000 lines</tt></li><li><tt>Send entire diff</tt></li></ul></td><td><p> The max number of lines for diff email. </p></td></tr><tr><td><p><strong>notification_level</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>No email</tt></li><li><tt>Branch attribute notifications only</tt></li><li><tt>Branch revision notifications only</tt></li><li><tt>Branch attribute and revision notifications</tt></li></ul></td><td><p> The level of notification to subscribe to. </p></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> The person to subscribe. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_subscription">git_subscription</a>. </p> </div> <div class="method"> <h5 id="git_repository-unsubscribe" title="git_repository-unsubscribe">unsubscribe</h5> <div> <p>Remove the person's subscription to this repository.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person to unsubscribe </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="git_subscription" title="git_subscription">git_subscription</h3> <p> The relationship between a person and a Git repository. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>max_diff_lines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Don't send diffs</tt> </li> <li> <tt>500 lines</tt> </li> <li> <tt>1000 lines</tt> </li> <li> <tt>5000 lines</tt> </li> <li> <tt>Send entire diff</tt> </li> </ul> </td> <td> <div> <p>Generated Diff Size Limit</p> <p>Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.</p> </div> </td> </tr> <tr> <td> <p> <strong>notification_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>No email</tt> </li> <li> <tt>Branch attribute notifications only</tt> </li> <li> <tt>Branch revision notifications only</tt> </li> <li> <tt>Branch attribute and revision notifications</tt> </li> </ul> </td> <td> <div> <p>Notification Level</p> <p>Attribute notifications are sent when repository details are changed such as lifecycle status and name. Revision notifications are generated when new revisions are found.</p> </div> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>Enter the launchpad id, or email address of the person you wish to subscribe to this repository. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.</p> </div> </td> </tr> <tr> <td> <p> <strong>repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> Repository ID </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>review_level</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>No email</tt> </li> <li> <tt>Status changes only</tt> </li> <li> <tt>Email about all changes</tt> </li> </ul> </td> <td> <div> <p>Code review Level</p> <p>Control the kind of review activity that triggers notifications.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscribed_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscribed by</p> <p>The person who created this subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="git_subscription-standard-methods" title="git_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="git_subscription-custom-GETs" title="git_subscription-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="git_subscription-canBeUnsubscribedByUser" title="git_subscription-canBeUnsubscribedByUser">canBeUnsubscribedByUser</h5> <p> Can the user unsubscribe the subscriber from the repository? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeUnsubscribedByUser</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="git_target" title="git_target">git_target</h3> <div> <p>An object that has related Git repositories.</p> <p>A project contains Git repositories, a source package on a distribution contains Git repositories, and a person contains "personal" Git repositories.</p> </div> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="git_target-standard-methods" title="git_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="gpg_key" title="gpg_key">gpg_key</h3> <p> OpenPGP support </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><person.name></var>/+gpg-keys/<var><fingerprint></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>fingerprint</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> User Fingerprint </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>keyid</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> OpenPGP key ID </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="gpg_key-standard-methods" title="gpg_key-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="has_bugs" title="has_bugs">has_bugs</h3> <p> An entity which has a collection of bug tasks. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="has_bugs-standard-methods" title="has_bugs-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="has_bugs-custom-GETs" title="has_bugs-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="has_bugs-searchTasks" title="has_bugs-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="has_milestones" title="has_milestones">has_milestones</h3> <p> An interface for classes providing milestones. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> The visible and active milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> All milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="has_milestones-standard-methods" title="has_milestones-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="irc_id" title="irc_id">irc_id</h3> <p> A person's nickname on an IRC network. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><person.name></var>/+ircnick/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>network</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> IRC network </p> </td> </tr> <tr> <td> <p> <strong>nickname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Nickname </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="irc_id-standard-methods" title="irc_id-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="jabber_id" title="jabber_id">jabber_id</h3> <p> Jabber specific user ID </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><person.name></var>/+jabberid/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>jabberid</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> New Jabber user ID </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="jabber_id-standard-methods" title="jabber_id-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="language" title="language">language</h3> <p> A Language. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+languages/<var><code></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>code</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The ISO 639 code </p> </td> </tr> <tr> <td> <p> <strong>english_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The English name </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>plural_expression</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Plural form expression</p> <p>The expression that relates a number of items to the appropriate plural form.</p> </div> </td> </tr> <tr> <td> <p> <strong>plural_forms</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Number of plural forms</p> <p>The number of plural forms this language has.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>text_direction</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Left to Right</tt> </li> <li> <tt>Right to Left</tt> </li> </ul> </td> <td> <div> <p>Text direction</p> <p>The direction of text in this language.</p> </div> </td> </tr> <tr> <td> <p> <strong>translators_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Total number of translators for this language. </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Visible</p> <p>Whether this language is visible by default.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="language-standard-methods" title="language-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="livefs" title="livefs">livefs</h3> <p> A buildable live filesystem image. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#livefs_build">livefs_build</a> collection. </td> <td> <div> <p>All builds of this live filesystem.</p> <p>All builds of this live filesystem, sorted in descending order of finishing (or starting if not completed successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#livefs_build">livefs_build</a> collection. </td> <td> <div> <p>Completed builds of this live filesystem.</p> <p>Completed builds of this live filesystem, sorted in descending order of finishing.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distro Series</p> <p>The series for which the image should be built.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> ID </p> </td> </tr> <tr> <td> <p> <strong>keep_binary_files_days</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Binary file retention period</p> <p>Keep binary files attached to builds of this live filesystem for at least this many days. If unset, disable pruning.</p> </div> </td> </tr> <tr> <td> <p> <strong>metadata</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A dict of data about the image. Entries here will be passed to the builder. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the live filesystem image.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this live filesystem image.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#livefs_build">livefs_build</a> collection. </td> <td> <div> <p>Pending builds of this live filesystem.</p> <p>Pending builds of this live filesystem, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this live filesystem image.</p> </div> </td> </tr> <tr> <td> <p> <strong>relative_build_score</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Relative build score</p> <p>A delta to apply to all build scores for the live filesystem. Builds with a higher score will build sooner.</p> </div> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build this live filesystem image on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="livefs-standard-methods" title="livefs-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="livefs-custom-POSTs" title="livefs-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="livefs-newWebhook" title="livefs-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"><h5 id="livefs-requestBuild" title="livefs-requestBuild">requestBuild</h5><div> <p>Request that the live filesystem be built.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuild</var></p></td><td></td></tr><tr><td><p><strong>archive</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>distro_arch_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td><td></td></tr><tr><td><p><strong>metadata_override</strong></p></td><td><p></p></td><td><p> A dict of data about the image. </p></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td></td></tr><tr><td><p><strong>unique_key</strong></p></td><td><p></p></td><td><p> A unique key for this build, if required. </p></td></tr><tr><td><p><strong>version</strong></p></td><td><p></p></td><td><p> A version string for this build. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#livefs_build">livefs_build</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="livefs_build" title="livefs_build">livefs_build</h3> <p> Build information for live filesystem builds. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> The archive from which to build the live filesystem. </p> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for which to build. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>livefs_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#livefs">livefs</a>. </td> <td> <p> The live filesystem to build. </p> </td> </tr> <tr> <td> <p> <strong>metadata_override</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> A dict of data about the image; this will be merged into the metadata dict for the live filesystem. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> The pocket for which to build. </p> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who requested this build. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>unique_key</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> An optional unique key; if set, this identifies a class of builds for this live filesystem. </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> A version string for this build. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="livefs_build-standard-methods" title="livefs_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="livefs_build-custom-GETs" title="livefs_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="livefs_build-getFileUrls" title="livefs_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="livefs_build-custom-POSTs" title="livefs_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="livefs_build-cancel" title="livefs_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="livefs_build-rescore" title="livefs_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="livefs_build-retry" title="livefs_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="message" title="message">message</h3> <p> A Message. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+bug/<var><bug.id></var>/comments/<var><index></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_attachments_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_attachment">bug_attachment</a> collection. </td> <td> <p> A list of BugAttachments connected to this message. </p> </td> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> All the text/plain chunks joined together as a unicode string. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_deleted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was deleted </p> </td> </tr> <tr> <td> <p> <strong>date_last_edited</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was last edited </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> <tr> <td> <p> <strong>parent_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message">message</a>. </td> <td> <p> Parent </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revisions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message_revision">message_revision</a> collection. </td> <td> <div> <p>Message revision history</p> <p>Revision history of this message, sorted in ascending order.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subject</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Subject </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Message visibility.</p> <p>Whether or not the message is visible.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="message-standard-methods" title="message-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="message-custom-GETs" title="message-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="message-getAPIParent" title="message-getAPIParent">getAPIParent</h5> <p> Return None because messages are not threaded over the API. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getAPIParent</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="message-custom-POSTs" title="message-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="message-deleteContent" title="message-deleteContent">deleteContent</h5> <p> Deletes this message content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteContent</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="message-editContent" title="message-editContent">editContent</h5> <p> Edit the content of this message, generating a new message revision with the old content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>editContent</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_content</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Message content</p> <p>The new message content string</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="message_revision" title="message_revision">message_revision</h3> <p> A historical revision of a IMessage. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><message-url></var>/revisions/<var><index></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The message at the given revision </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this message revision was created. </p> </td> </tr> <tr> <td> <p> <strong>date_created_display</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this message revision was created, rendered in the user's timezone for the web UI. </p> </td> </tr> <tr> <td> <p> <strong>date_deleted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this message revision was created. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revision</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Revision number </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="message_revision-standard-methods" title="message_revision-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="message_revision-custom-POSTs" title="message_revision-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="message_revision-deleteContent" title="message_revision-deleteContent">deleteContent</h5> <p> Deletes this MessageRevision content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteContent</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="milestone" title="milestone">milestone</h3> <p> Actual interface for milestones. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+milestone/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>code_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Code name</p> <p>An alternative name for the milestone.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_targeted</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Targeted</p> <p>Example: 2005-11-24</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this object should be shown in web forms for targeting.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>Only letters, numbers, and simple punctuation are allowed.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>release_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_release">project_release</a>. </td> <td> <p> The release for this milestone. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>series_target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#has_milestones">has_milestones</a>. </td> <td> <p> The productseries or distroseries of this milestone. </p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A summary of the features and status of this milestone.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#has_milestones">has_milestones</a>. </td> <td> <p> The product, distribution, or project group for this milestone. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> A context title for pages. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="milestone-standard-methods" title="milestone-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="milestone-custom-GETs" title="milestone-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="milestone-getSubscription" title="milestone-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="milestone-getSubscriptions" title="milestone-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"> <h5 id="milestone-getTags" title="milestone-getTags">getTags</h5> <div> <p>Return the milestone tags in alphabetical order.</p> <p>See above the IMilestone.setTags docstring for an explanation of why this is not a property.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getTags</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="milestone-searchTasks" title="milestone-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="milestone-userHasBugSubscriptions" title="milestone-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="milestone-custom-POSTs" title="milestone-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="milestone-addBugSubscription" title="milestone-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="milestone-addBugSubscriptionFilter" title="milestone-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"><h5 id="milestone-createProductRelease" title="milestone-createProductRelease">createProductRelease</h5><div> <p>Create a new ProductRelease.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createProductRelease</var></p></td><td></td></tr><tr><td><p><strong>changelog</strong></p></td><td><p></p></td><td><div> <p>Changelog</p> <p>A description of every change in the release.</p> </div></td></tr><tr><td><p><strong>date_released</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Date released</p> <p>The date this release was published. Before release, this should have an estimated release date.</p> </div></td></tr><tr><td><p><strong>release_notes</strong></p></td><td><p></p></td><td><div> <p>Release notes</p> <p>A description of important new features (though the changelog below might repeat some of this information).</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#project_release">project_release</a>. </p> </div> <div class="method"> <h5 id="milestone-removeBugSubscription" title="milestone-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="milestone-setTags" title="milestone-setTags">setTags</h5> <div> <p>Set the milestone tags.</p> <p>Note that this is not a property because, while the current user is needed to store tags metadata, it is desirable to avoid using thread locals to get the current request in models.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setTags</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>tags</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Tags for this milestone</p> <p>Space-separated keywords for classifying this milestone.</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="object_with_translation_imports" title="object_with_translation_imports">object_with_translation_imports</h3> <div> <p>An entity that has a translation import queue.</p> <p>Examples include ProductSeries, SourcePackage, DistroSeries, and Person.</p> </div> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="object_with_translation_imports-standard-methods" title="object_with_translation_imports-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="object_with_translation_imports-custom-GETs" title="object_with_translation_imports-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="object_with_translation_imports-getTranslationImportQueueEntries" title="object_with_translation_imports-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_project" title="oci_project">oci_project</h3> <p> A project containing Open Container Initiative recipes. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/+oci/<var><oci_project.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The description for this OCI project. </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Display name for this OCI project. </p> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <p> The distribution that this OCI project is associated with. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of this OCI project.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project that this OCI project is associated with. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person that registered this project.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>series_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_project_series">oci_project_series</a> collection. </td> <td> <p> Series inside this OCI project. </p> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="oci_project-standard-methods" title="oci_project-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="oci_project-custom-GETs" title="oci_project-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="oci_project-getSubscription" title="oci_project-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="oci_project-getSubscriptions" title="oci_project-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="oci_project-searchTasks" title="oci_project-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="oci_project-userHasBugSubscriptions" title="oci_project-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="oci_project-custom-POSTs" title="oci_project-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="oci_project-addBugSubscription" title="oci_project-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="oci_project-addBugSubscriptionFilter" title="oci_project-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"><h5 id="oci_project-newRecipe" title="oci_project-newRecipe">newRecipe</h5><p> Create an IOCIRecipe for this project. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newRecipe</var></p></td><td></td></tr><tr><td><p><strong>build_args</strong></p></td><td><p></p></td><td><div> <p>Build ARGs to be used when building the recipe</p> <p>A dict of VARIABLE=VALUE to be used as ARG when building the recipe.</p> </div></td></tr><tr><td><p><strong>build_daily</strong></p></td><td><p></p></td><td><p> Should this recipe be built daily?. </p></td></tr><tr><td><p><strong>build_file</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Build file path.</p> <p>The relative path to the file within this recipe's branch that defines how to build the recipe.</p> </div></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description for this recipe.</p> <p>A short description of this recipe.</p> </div></td></tr><tr><td><p><strong>git_ref</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td><td><p> Git branch. </p></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>OCI Recipe name.</p> <p>The name of the new OCI Recipe.</p> </div></td></tr><tr><td><p><strong>owner</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person or team that owns the new OCI Recipe. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#oci_recipe">oci_recipe</a>. </p> </div> <div class="method"> <h5 id="oci_project-removeBugSubscription" title="oci_project-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="oci_project-setOfficialRecipeStatus" title="oci_project-setOfficialRecipeStatus">setOfficialRecipeStatus</h5> <p> Change whether an OCI Recipe is official or not for this project. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setOfficialRecipeStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>recipe</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#oci_recipe">oci_recipe</a>. </td> <td> <div> <p>OCI recipe</p> <p>The OCI recipe to change the status of.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Official status</p> <p>Whether the OCI recipe should be official or not.</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_project_series" title="oci_project_series">oci_project_series</h3> <div> <p>A series of an Open Container Initiative project.</p> <p>This is used to allow tracking bugs against multiple versions of images.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/+oci/<var><oci_project.name></var>/+series/<var><oci_project_series.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The date on which this series was created in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of this series.</p> </div> </td> </tr> <tr> <td> <p> <strong>oci_project_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_project">oci_project</a>. </td> <td> <p> The OCI project that this series belongs to. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person that registered this series.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Active Development</tt> </li> <li> <tt>Pre-release Freeze</tt> </li> <li> <tt>Current Stable Release</tt> </li> <li> <tt>Supported</tt> </li> <li> <tt>Obsolete</tt> </li> <li> <tt>Future</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A brief summary of this series.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="oci_project_series-standard-methods" title="oci_project_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_push_rule" title="oci_push_rule">oci_push_rule</h3> <p> A rule for pushing builds of an OCI recipe to a registry. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>image_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Image name</p> <p>The intended name of the image on the registry.</p> </div> </td> </tr> <tr> <td> <p> <strong>registry_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Registry URL</p> <p>The registry URL for the credentials of this push rule</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>username</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Username</p> <p>The username for the credentials, if available.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="oci_push_rule-standard-methods" title="oci_push_rule-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_recipe" title="oci_recipe">oci_recipe</h3> <p> A recipe for building Open Container Initiative images. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><distribution.name></var>/+oci/<var><oci_project.name></var>/+recipe/<var><oci_recipe.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>allow_internet</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Allow external network access</p> <p>Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_args</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build ARG variables</p> <p>The dictionary of ARG variables to be used when building this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_daily</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build daily</p> <p>If True, this recipe should be built daily.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_file</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build file path</p> <p>The relative path to the file within this recipe's branch that defines how to build the recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build directory context</p> <p>Directory to use for build context and OCIRecipe.build_file location.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_ref_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td> <td> <div> <p>Git branch</p> <p>The Git branch containing a Dockerfile at the location defined by the build_file attribute.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>image_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Image name</p> <p>Image name to use on upload to registry. Defaults to recipe name if not set. Only used when Distribution credentials are set.</p> </div> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this OCI recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>oci_project_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_project">oci_project</a>. </td> <td> <div> <p>OCI project</p> <p>The OCI project that this recipe is for.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this OCI recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures for which the OCI recipe should be built.</p> </div> </td> </tr> <tr> <td> <p> <strong>push_rules_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_push_rule">oci_push_rule</a> collection. </td> <td> <div> <p>Push rules for this OCI recipe.</p> <p>All of the push rules for registry upload that apply to this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The user who registered this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="oci_recipe-standard-methods" title="oci_recipe-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="oci_recipe-custom-POSTs" title="oci_recipe-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="oci_recipe-newPushRule" title="oci_recipe-newPushRule">newPushRule</h5><p> Add a new rule for pushing builds of this recipe to a registry. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newPushRule</var></p></td><td></td></tr><tr><td><p><strong>credentials</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Registry credentials</p> <p>The credentials to use in pushing the image to the registry</p> </div></td></tr><tr><td><p><strong>credentials_owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Registry credentials owner </p></td></tr><tr><td><p><strong>image_name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Image name</p> <p>Name of the image to push to on the registry</p> </div></td></tr><tr><td><p><strong>registry_url</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Registry URL</p> <p>URL for the target registry</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#oci_push_rule">oci_push_rule</a>. </p> </div> <div class="method"><h5 id="oci_recipe-newWebhook" title="oci_recipe-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"><h5 id="oci_recipe-requestBuilds" title="oci_recipe-requestBuilds">requestBuilds</h5><div> <p>Request that the OCI recipe is built for all available architectures.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuilds</var></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#oci_recipe_build_request">oci_recipe_build_request</a>. </p> </div> <div class="method"> <h5 id="oci_recipe-setProcessors" title="oci_recipe-setProcessors">setProcessors</h5> <p> Set the architectures for which the recipe should be built. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_recipe_build" title="oci_recipe_build">oci_recipe_build</h3> <p> A build record for an OCI recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><distribution.name></var>/+oci/<var><oci_project.name></var>/+recipe/<var><oci_recipe.name></var>/+build/<var><oci_recipe_build.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>date</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The date when the build completed or is estimated to complete. </p> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for which to build. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>estimate</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> If true, the date value is an estimate. </p> </td> </tr> <tr> <td> <p> <strong>eta</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The datetime when the build job is estimated to complete. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_recipe">oci_recipe</a>. </td> <td> <p> The OCI recipe to build. </p> </td> </tr> <tr> <td> <p> <strong>registry_upload_error_summary</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Registry upload error summary</p> <p>The error summary, if any, from the last attempt to upload this build to a registry.</p> </div> </td> </tr> <tr> <td> <p> <strong>registry_upload_errors</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Detailed registry upload errors</p> <p>A list of errors, as described in <a class="rst-reference external" href="https://docs.docker.com/registry/spec/api/#errors" target="_top">https://docs.docker.com/registry/spec/api/#errors</a>, from the last attempt to upload this build to a registry.</p> </div> </td> </tr> <tr> <td> <p> <strong>registry_upload_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unscheduled</tt> </li> <li> <tt>Pending</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploaded</tt> </li> <li> <tt>Superseded</tt> </li> </ul> </td> <td> <p> Registry upload status </p> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Requester</p> <p>The person who requested this OCI recipe build.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="oci_recipe_build-standard-methods" title="oci_recipe_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="oci_recipe_build-custom-GETs" title="oci_recipe_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="oci_recipe_build-getFileUrls" title="oci_recipe_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="oci_recipe_build-custom-POSTs" title="oci_recipe_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="oci_recipe_build-cancel" title="oci_recipe_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="oci_recipe_build-rescore" title="oci_recipe_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="oci_recipe_build-retry" title="oci_recipe_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="oci_recipe_build-scheduleRegistryUpload" title="oci_recipe_build-scheduleRegistryUpload">scheduleRegistryUpload</h5> <div> <p>Schedule an upload of this build to each configured registry.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>scheduleRegistryUpload</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="oci_recipe_build_request" title="oci_recipe_build_request">oci_recipe_build_request</h3> <p> A request to build an OCI Recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><distribution.name></var>/+oci/<var><oci_project.name></var>/+recipe/<var><oci_recipe.name></var>/+build-request/<var><build_request.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_recipe_build">oci_recipe_build</a> collection. </td> <td> <p> Builds produced by this request </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request finished </p> </td> </tr> <tr> <td> <p> <strong>date_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request was made </p> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Error message </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#oci_recipe">oci_recipe</a>. </td> <td> <p> OCI Recipe </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Completed</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="oci_recipe_build_request-standard-methods" title="oci_recipe_build_request-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="package_upload" title="package_upload">package_upload</h3> <p> A Queue item for the archive uploader. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The archive for this upload.</p> </div> </td> </tr> <tr> <td> <p> <strong>changes_file_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Changes file URL</p> <p>Librarian URL for the changes file associated with this upload. Will be None if the upload was copied from another series.</p> </div> </td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source package component name </p> </td> </tr> <tr> <td> <p> <strong>contains_build</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Whether or not this upload contains binaries </p> </td> </tr> <tr> <td> <p> <strong>contains_copy</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Whether or not this upload contains a copy from another series. </p> </td> </tr> <tr> <td> <p> <strong>contains_source</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Whether or not this upload contains sources </p> </td> </tr> <tr> <td> <p> <strong>copy_source_archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Copy source archive</p> <p>The archive from which this package was copied, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date created</p> <p>The date this package upload was done.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_arches</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architectures related to this item </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Generic displayname for a queue item </p> </td> </tr> <tr> <td> <p> <strong>display_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> This item's displayable source package version </p> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Series</p> <p>The distroseries targeted by this upload.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> ID </p> </td> </tr> <tr> <td> <p> <strong>logs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#package_upload_log">package_upload_log</a> collection. </td> <td> <p> The package upload logs </p> </td> </tr> <tr> <td> <p> <strong>package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Name of the uploaded source package </p> </td> </tr> <tr> <td> <p> <strong>package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source package version </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>The pocket</p> <p>The pocket targeted by this upload.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>section_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source package section name </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>New</tt> </li> <li> <tt>Unapproved</tt> </li> <li> <tt>Accepted</tt> </li> <li> <tt>Done</tt> </li> <li> <tt>Rejected</tt> </li> </ul> </td> <td> <div> <p>Queue status</p> <p>The status of this upload.</p> </div> </td> </tr> </table> </div> <div id="package_upload-standard-methods" title="package_upload-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="package_upload-custom-GETs" title="package_upload-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="package_upload-binaryFileUrls" title="package_upload-binaryFileUrls">binaryFileUrls</h5> <div> <p>URLs for all the binary files attached to this upload.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>binaryFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this upload.</td> </p> </div> <div class="method"> <h5 id="package_upload-customFileUrls" title="package_upload-customFileUrls">customFileUrls</h5> <div> <p>URLs for all the custom files attached to this upload.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>customFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this upload.</td> </p> </div> <div class="method"> <h5 id="package_upload-getBinaryProperties" title="package_upload-getBinaryProperties">getBinaryProperties</h5> <div> <p>The properties of the binaries associated with this queue item.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBinaryProperties</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A list of dictionaries, each containing the properties of a single binary.</td> </p> </div> <div class="method"> <h5 id="package_upload-sourceFileUrls" title="package_upload-sourceFileUrls">sourceFileUrls</h5> <div> <p>URLs for all the source files attached to this upload.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>sourceFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this upload.</td> </p> </div> </div> <div id="package_upload-custom-POSTs" title="package_upload-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="package_upload-acceptFromQueue" title="package_upload-acceptFromQueue">acceptFromQueue</h5> <div> <p>Call setAccepted, do a flush, and send notification email.</p> <ul class="rst-simple"> <li>Grant karma to people involved with the upload.</li> </ul> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>acceptFromQueue</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="package_upload-overrideBinaries" title="package_upload-overrideBinaries">overrideBinaries</h5> <div> <p>Override binary packages in a binary queue item.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>overrideBinaries</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>changes</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>A sequence of changes to apply.</p> <p>Each item may have a 'name' item which specifies the binary package name to override; otherwise, the change applies to all binaries in the upload. It may also have 'component', 'section', and 'priority' items which replace the corresponding existing one in the upload's overridden binaries.</p> </div> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if any binaries were overridden.</td> </p> </div> <div class="method"> <h5 id="package_upload-overrideSource" title="package_upload-overrideSource">overrideSource</h5> <div> <p>Override the source package contained in this queue item.</p> <p>The override values may be None, in which case they are not changed.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>overrideSource</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_component</strong> </p> </td> <td> <p></p> </td> <td> <p> The new component name. </p> </td> </tr> <tr> <td> <p> <strong>new_section</strong> </p> </td> <td> <p></p> </td> <td> <p> The new section name. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the source was overridden.</td> </p> </div> <div class="method"> <h5 id="package_upload-rejectFromQueue" title="package_upload-rejectFromQueue">rejectFromQueue</h5> <p> Call setRejected, do a flush, and send notification email. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rejectFromQueue</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Rejection comment </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="package_upload_log" title="package_upload_log">package_upload_log</h3> <p> A log entry recording a change in a package upload's status. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> User's comment about this change. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this action happened. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>new_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>New</tt> </li> <li> <tt>Unapproved</tt> </li> <li> <tt>Accepted</tt> </li> <li> <tt>Done</tt> </li> <li> <tt>Rejected</tt> </li> </ul> </td> <td> <p> New status. </p> </td> </tr> <tr> <td> <p> <strong>old_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>New</tt> </li> <li> <tt>Unapproved</tt> </li> <li> <tt>Accepted</tt> </li> <li> <tt>Done</tt> </li> <li> <tt>Rejected</tt> </li> </ul> </td> <td> <p> Old status. </p> </td> </tr> <tr> <td> <p> <strong>package_upload_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#package_upload">package_upload</a>. </td> <td> <p> The package upload that generated this log </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Who did this action. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="package_upload_log-standard-methods" title="package_upload_log-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="packageset" title="packageset">packageset</h3> <p> An interface for package sets. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The creation date/time for the package set at hand.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>The description for the package set at hand.</p> </div> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>The distroseries to which this package set is related.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> ID </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Valid package set name </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person who owns this package set.</p> </div> </td> </tr> <tr> <td> <p> <strong>relative_build_score</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build score</p> <p>Build score bonus for packages in this package set.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="packageset-standard-methods" title="packageset-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="packageset-custom-GETs" title="packageset-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="packageset-getSourcesIncluded" title="packageset-getSourcesIncluded">getSourcesIncluded</h5> <div> <p>Get all source names associated with this package set.</p> <p>This method returns the source package names that are directly or indirectly associated with the package set at hand. Indirect associations may be defined through package set successors.</p> <p>Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSourcesIncluded</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>direct_inclusion</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A (potentially empty) sequence of string source package names.</td> </p> </div> <div class="method"> <h5 id="packageset-getSourcesNotSharedBy" title="packageset-getSourcesNotSharedBy">getSourcesNotSharedBy</h5> <div> <p>Get source package names not included by another package set.</p> <p>Which source package names included by this package are <em>not</em> included by the other_package_set?</p> <p>Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSourcesNotSharedBy</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>direct_inclusion</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>other_package_set</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td> <td> <p> The package set we are comparing to. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A (potentially empty) sequence of string source package names.</td> </p> </div> <div class="method"> <h5 id="packageset-getSourcesSharedBy" title="packageset-getSourcesSharedBy">getSourcesSharedBy</h5> <div> <p>Get source package names also included by another package set.</p> <p>What source package names does this package set have in common with the other_package_set?</p> <p>Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSourcesSharedBy</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>direct_inclusion</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>other_package_set</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#packageset">packageset</a>. </td> <td> <p> The package set we are comparing to. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A (potentially empty) sequence of string source package names.</td> </p> </div> <div class="method"><h5 id="packageset-relatedSets" title="packageset-relatedSets">relatedSets</h5><div> <p>Get all other package sets in this set's PackagesetGroup.</p> <p>Returns all package sets that are related to this one, but not this one itself.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>relatedSets</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a> collection. </p> </div> <div class="method"><h5 id="packageset-setsIncluded" title="packageset-setsIncluded">setsIncluded</h5><div> <p>Get all package sets that are included by this one.</p> <p>Return all package sets that are directly or indirectly included by this one.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>setsIncluded</var></p></td><td></td></tr><tr><td><p><strong>direct_inclusion</strong></p></td><td><p></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a> collection. </p> </div> <div class="method"><h5 id="packageset-setsIncludedBy" title="packageset-setsIncludedBy">setsIncludedBy</h5><div> <p>Get all package sets that include this one.</p> <p>Return all package sets that directly or indirectly include this one.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>setsIncludedBy</var></p></td><td></td></tr><tr><td><p><strong>direct_inclusion</strong></p></td><td><p></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#packageset">packageset</a> collection. </p> </div> </div> <div id="packageset-custom-POSTs" title="packageset-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="packageset-addSources" title="packageset-addSources">addSources</h5> <div> <p>Add the named source packages to this package set.</p> <p>Any passed source package names will become <em>directly</em> associated with the package set at hand.</p> <p>This function is idempotent in the sense that source package names that are already directly associated with a package set will be ignored.</p> <p>This method facilitates the addition of source package names to package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances. Non-existing source package names will be ignored.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addSources</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of source package names. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="packageset-addSubsets" title="packageset-addSubsets">addSubsets</h5> <div> <p>Add the named package sets as subsets to this package set.</p> <p>Any passed source package names will become <em>directly</em> associated with the package set at hand.</p> <p>This function is idempotent in the sense that package subsets that are already directly associated with a package set will be ignored.</p> <p>This method facilitates the addition of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addSubsets</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of package set names. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="packageset-removeSources" title="packageset-removeSources">removeSources</h5> <div> <p>Remove the named source packages from this package set.</p> <p>Only source package names <em>directly</em> included by this package set can be removed. Any others will be ignored.</p> <p>This method facilitates the removal of source package names from package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeSources</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of source package names. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="packageset-removeSubsets" title="packageset-removeSubsets">removeSubsets</h5> <div> <p>Remove the named package subsets from this package set.</p> <p>Only package subsets <em>directly</em> included by this package set can be removed. Any others will be ignored.</p> <p>This method facilitates the removal of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeSubsets</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>names</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of package set names. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="person" title="person">person</h3> <p> A Person. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>account_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Placeholder</tt> </li> <li> <tt>Unactivated</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Suspended</tt> </li> <li> <tt>Closed</tt> </li> <li> <tt>Deceased</tt> </li> </ul> </td> <td> <p> The status of this person's account </p> </td> </tr> <tr> <td> <p> <strong>account_status_history</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Account status history </p> </td> </tr> <tr> <td> <p> <strong>admins_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> List of this team's admins. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Default PPA</p> <p>The PPA named 'ppa' owned by this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>confirmed_email_addresses_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#email_address">email_address</a> collection. </td> <td> <div> <p>Confirmed emails of this person.</p> <p>Confirmed emails are the ones in the VALIDATED state</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>deactivated_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Former members of the team. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Your name as you would like it displayed throughout Launchpad. Most people use their full name here.</p> </div> </td> </tr> <tr> <td> <p> <strong>expired_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Expired members of the team. </p> </td> </tr> <tr> <td> <p> <strong>gpg_keys_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#gpg_key">gpg_key</a> collection. </td> <td> <p> List of valid OpenPGP keys ordered by ID </p> </td> </tr> <tr> <td> <p> <strong>hide_email_addresses</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Hide my email addresses from other Launchpad users </p> </td> </tr> <tr> <td> <p> <strong>homepage_content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage Content</p> <p>Obsolete. Use description.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>ID</p> <p>Internal immutable identifier for this person. Only visible by privileged users.</p> </div> </td> </tr> <tr> <td> <p> <strong>invited_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Other teams which have been invited to become members of this team. </p> </td> </tr> <tr> <td> <p> <strong>irc_nicknames_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#irc_id">irc_id</a> collection. </td> <td> <p> List of IRC nicknames of this Person. </p> </td> </tr> <tr> <td> <p> <strong>is_probationary</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Is this a probationary user? </p> </td> </tr> <tr> <td> <p> <strong>is_team</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Is this object a team? </p> </td> </tr> <tr> <td> <p> <strong>is_ubuntu_coc_signer</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Signed Ubuntu Code of Conduct </p> </td> </tr> <tr> <td> <p> <strong>is_valid</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> This is an active user or a team. </p> </td> </tr> <tr> <td> <p> <strong>jabber_ids_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#jabber_id">jabber_id</a> collection. </td> <td> <p> List of Jabber IDs of this Person. </p> </td> </tr> <tr> <td> <p> <strong>karma</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Karma</p> <p>The cached total karma for this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>languages_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#language">language</a> collection. </td> <td> <p> List of languages known by this person </p> </td> </tr> <tr> <td> <p> <strong>logo_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Logo</p> <p>An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>mailing_list_auto_subscribe_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Never subscribe to mailing lists</tt> </li> <li> <tt>Ask me when I join a team</tt> </li> <li> <tt>Always subscribe me to mailing lists</tt> </li> </ul> </td> <td> <div> <p>Mailing List Auto-subscription Policy</p> <p>This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.</p> </div> </td> </tr> <tr> <td> <p> <strong>members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> List of direct members with ADMIN or APPROVED status </p> </td> </tr> <tr> <td> <p> <strong>members_details_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <div> <p>Active TeamMemberships for this object's members.</p> <p>Active TeamMemberships are the ones with the ADMIN or APPROVED status. The results are ordered using Person.sortingColumns.</p> </div> </td> </tr> <tr> <td> <p> <strong>memberships_details_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <p> All TeamMemberships for Teams this Team or Person is an active member of. </p> </td> </tr> <tr> <td> <p> <strong>mugshot_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Mugshot</p> <p>A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> </div> </td> </tr> <tr> <td> <p> <strong>open_membership_invitations_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <div> <p>Open membership invitations.</p> <p>All TeamMemberships which represent an invitation (to join a team) sent to this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>participants_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <div> <p>All participants of this team.</p> <p>List of all direct and indirect people and teams who, one way or another, are a part of this team. If you want a method to check if a given person is a member of a team, you should probably look at IPerson.inTeam().</p> </div> </td> </tr> <tr> <td> <p> <strong>ppas_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a> collection. </td> <td> <div> <p>PPAs for this person.</p> <p>PPAs owned by the context person ordered by name.</p> </div> </td> </tr> <tr> <td> <p> <strong>preferred_email_address_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#email_address">email_address</a>. </td> <td> <div> <p>Preferred email address</p> <p>The preferred email address for this person. The one we'll use to communicate with them.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>This team is private</p> <p>Private teams are visible only to their members.</p> </div> </td> </tr> <tr> <td> <p> <strong>proposed_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> People who have applied to join the team. </p> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>social_accounts_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#social_account">social_account</a> collection. </td> <td> <p> List of Social Accounts of this Person. </p> </td> </tr> <tr> <td> <p> <strong>sshkeys_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#ssh_key">ssh_key</a> collection. </td> <td> <p> List of SSH keys </p> </td> </tr> <tr> <td> <p> <strong>sub_teams_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team">team</a> collection. </td> <td> <div> <p>All subteams of this team.</p> <p>A subteam is any team that is a member (either directly or indirectly) of this team. As an example, let's say we have this hierarchy of teams:</p> <dl class="rst-docutils"> <dt>Rosetta Translators</dt> <dd><dl class="rst-first rst-last rst-docutils"> <dt>Rosetta pt Translators</dt> <dd>Rosetta pt_BR Translators</dd> </dl> </dd> </dl> <p>In this case, both 'Rosetta pt Translators' and 'Rosetta pt_BR Translators' are subteams of the 'Rosetta Translators' team, and all members of both subteams are considered members of "Rosetta Translators".</p> </div> </td> </tr> <tr> <td> <p> <strong>super_teams_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team">team</a> collection. </td> <td> <div> <p>All superteams of this team.</p> <p>A superteam is any team that this team is a member of. For example, let's say we have this hierarchy of teams, and we are the "Rosetta pt_BR Translators":</p> <dl class="rst-docutils"> <dt>Rosetta Translators</dt> <dd><dl class="rst-first rst-last rst-docutils"> <dt>Rosetta pt Translators</dt> <dd>Rosetta pt_BR Translators</dd> </dl> </dd> </dl> <p>In this case, we will return both 'Rosetta pt Translators' and 'Rosetta Translators', because we are member of both of them.</p> </div> </td> </tr> <tr> <td> <p> <strong>team_owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team Owner </p> </td> </tr> <tr> <td> <p> <strong>time_zone</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time zone of this object. </p> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>visibility</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Private</tt> </li> </ul> </td> <td> <div> <p>Visibility</p> <p>Anyone can see a public team's data. Only team members can see private team data.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>wiki_names_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#wiki_name">wiki_name</a> collection. </td> <td> <p> All WikiNames of this Person, sorted alphabetically by URL. </p> </td> </tr> </table> </div> <div id="person-standard-methods" title="person-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="person-custom-GETs" title="person-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="person-getArchiveSubscriptionURLs" title="person-getArchiveSubscriptionURLs">getArchiveSubscriptionURLs</h5> <div> <p>Return private archive URLs that this person can see.</p> <p>For each of the private archives (PPAs) that this person can see, return a URL that includes the HTTP basic auth data. The URL returned is suitable for including in a sources.list file.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getArchiveSubscriptionURLs</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="person-getArchiveSubscriptions" title="person-getArchiveSubscriptions">getArchiveSubscriptions</h5><p> Return (private) archives subscription for this person. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getArchiveSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_subscriber">archive_subscriber</a> collection. </p> </div> <div class="method"><h5 id="person-getBranches" title="person-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="person-getBugSubscriberPackages" title="person-getBugSubscriberPackages">getBugSubscriberPackages</h5><div> <p>Return the packages for which this person is a bug subscriber.</p> <p>Returns a list of IDistributionSourcePackage's, ordered alphabetically (A to Z) by name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBugSubscriberPackages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_source_package">distribution_source_package</a> collection. </p> </div> <div class="method"><h5 id="person-getDirectAnswerQuestionTargets" title="person-getDirectAnswerQuestionTargets">getDirectAnswerQuestionTargets</h5><div> <p>Return a list of IQuestionTargets that a person is subscribed to.</p> <p>This will return IQuestionTargets that the person is registered as an answer contact because they subscribed themselves.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDirectAnswerQuestionTargets</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question_target">question_target</a> collection. </p> </div> <div class="method"><h5 id="person-getMembersByStatus" title="person-getMembersByStatus">getMembersByStatus</h5><div> <p>Return the people whose membership on this team match :status:.</p> <p>If no orderby is provided, Person.sortingColumns is used.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMembersByStatus</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Proposed</tt></li><li><tt>Approved</tt></li><li><tt>Administrator</tt></li><li><tt>Deactivated</tt></li><li><tt>Expired</tt></li><li><tt>Declined</tt></li><li><tt>Invited</tt></li><li><tt>Invitation declined</tt></li></ul></td><td><p> The state of this membership </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="person-getMergeProposals" title="person-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="person-getOwnedProjects" title="person-getOwnedProjects">getOwnedProjects</h5><div> <p>Projects owned by this person or teams to which they belong.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOwnedProjects</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> <div class="method"><h5 id="person-getOwnedTeams" title="person-getOwnedTeams">getOwnedTeams</h5><div> <p>Return the teams that this person owns.</p> <p>The iterator includes the teams that the user owns, but it not a member of.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOwnedTeams</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#team">team</a> collection. </p> </div> <div class="method"><h5 id="person-getPPAByName" title="person-getPPAByName">getPPAByName</h5><div> <p>Return a PPA with the given name if it exists.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPPAByName</var></p></td><td></td></tr><tr><td><p><strong>distribution</strong></p></td><td><p></p> Link to a <a href="#distribution">distribution</a>. </td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive">archive</a>. </p> </div> <div class="method"><h5 id="person-getRecipe" title="person-getRecipe">getRecipe</h5><p> Return the person's recipe with the given name. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRecipe</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_recipe">source_package_recipe</a>. </p> </div> <div class="method"><h5 id="person-getRequestedReviews" title="person-getRequestedReviews">getRequestedReviews</h5><div> <p>Returns merge proposals where a person was asked to review.</p> <p>This does not include merge proposals that were requested from teams that the person is part of. If status is not passed then it will return proposals that are in the "Needs Review" state.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRequestedReviews</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"> <h5 id="person-getSocialAccountsByPlatform" title="person-getSocialAccountsByPlatform">getSocialAccountsByPlatform</h5> <p> Return Social Accounts associated to the user. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSocialAccountsByPlatform</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>platform</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Matrix platform</tt> </li> </ul> </td> <td> <p> Social Platform Type </p> </td> </tr> </table> </div> <div class="method"><h5 id="person-getTeamAnswerQuestionTargets" title="person-getTeamAnswerQuestionTargets">getTeamAnswerQuestionTargets</h5><div> <p>Return a list of IQuestionTargets that are indirect subscriptions.</p> <p>This will return IQuestionTargets that the person or team is registered as an answer contact because of their membership in a team.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTeamAnswerQuestionTargets</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question_target">question_target</a> collection. </p> </div> <div class="method"><h5 id="person-getTranslationImportQueueEntries" title="person-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="person-searchQuestions" title="person-searchQuestions">searchQuestions</h5><div> <p>Search the person's questions.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention</strong></p></td><td><p></p></td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>participation</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Owner</tt></li><li><tt>Subscriber</tt></li><li><tt>Assignee</tt></li><li><tt>Commenter</tt></li><li><tt>Answerer</tt></li></ul></td><td><p> Participation </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="person-searchTasks" title="person-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <div id="person-custom-POSTs" title="person-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="person-acceptInvitationToBeMemberOf" title="person-acceptInvitationToBeMemberOf">acceptInvitationToBeMemberOf</h5> <div> <p>Accept an invitation to become a member of the given team.</p> <p>There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to APPROVED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>acceptInvitationToBeMemberOf</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-addLanguage" title="person-addLanguage">addLanguage</h5> <div> <p>Add a language to this person's preferences.</p> <p>If the given language is one of the user's preferred languages already, nothing will happen.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addLanguage</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>language</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="person-addMember" title="person-addMember">addMember</h5> <div> <p>Add the given person as a member of this team.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addMember</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Member </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Proposed</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Administrator</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Declined</tt> </li> <li> <tt>Invited</tt> </li> <li> <tt>Invitation declined</tt> </li> </ul> </td> <td> <p> The state of this membership </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A tuple containing a boolean indicating when the membership status changed and the current TeamMembershipStatus. This depends on the desired status passed as an argument, the membership policy and the user's privileges.</td> </p> </div> <div class="method"><h5 id="person-createPPA" title="person-createPPA">createPPA</h5><div> <p>Create a PPA.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createPPA</var></p></td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>displayname</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>distribution</strong></p></td><td><p></p> Link to a <a href="#distribution">distribution</a>. </td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>private</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>suppress_subscription_notifications</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive">archive</a>. </p> </div> <div class="method"><h5 id="person-createRecipe" title="person-createRecipe">createRecipe</h5><div> <p>Create a SourcePackageRecipe owned by this person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createRecipe</var></p></td><td></td></tr><tr><td><p><strong>build_daily</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>daily_build_archive</strong></p></td><td><p></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>recipe_text</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#source_package_recipe">source_package_recipe</a>. </p> </div> <div class="method"> <h5 id="person-declineInvitationToBeMemberOf" title="person-declineInvitationToBeMemberOf">declineInvitationToBeMemberOf</h5> <div> <p>Decline an invitation to become a member of the given team.</p> <p>There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to INVITATION_DECLINED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>declineInvitationToBeMemberOf</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-getArchiveSubscriptionURL" title="person-getArchiveSubscriptionURL">getArchiveSubscriptionURL</h5> <div> <p>Get a text line that is suitable to be used for a sources.list entry.</p> <p>It will create a new IArchiveAuthToken if one doesn't already exist.</p> <p>It raises Unauthorized if the context user does not have a valid subscription for the target archive or the caller is not context user itself.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getArchiveSubscriptionURL</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="person-join" title="person-join">join</h5> <div> <p>Join the given team if its membership_policy is not RESTRICTED.</p> <p>Join the given team according to the policies and defaults of that team:</p> <ul class="rst-simple"> <li>If the team membership_policy is OPEN, the user is added as an APPROVED member with a NULL TeamMembership.reviewer.</li> <li>If the team membership_policy is MODERATED, the user is added as a PROPOSED member and one of the team's administrators have to approve the membership.</li> </ul> <p>If may_subscribe_to_list is True, then also attempt to subscribe to the team's mailing list, depending on the list status and the person's auto-subscribe settings.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>join</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-leave" title="person-leave">leave</h5> <div> <p>Leave the given team.</p> <p>This is a convenience method for retractTeamMembership() that allows a user to leave the given team, or to cancel a PENDING membership request.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>leave</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-removeLanguage" title="person-removeLanguage">removeLanguage</h5> <div> <p>Remove a language from this person's preferences.</p> <p>If the given language is not present, nothing will happen.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeLanguage</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>language</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="person-retractTeamMembership" title="person-retractTeamMembership">retractTeamMembership</h5> <div> <p>Retract this team's membership in the given team.</p> <p>If there's a membership entry for this team on the given team and its status is either APPROVED, ADMIN, PENDING, or INVITED, the status is changed and the relevant entries in TeamParticipation.</p> <p>APPROVED and ADMIN status are changed to DEACTIVATED. PENDING status is changed to DECLINED. INVITED status is changes to INVITATION_DECLINED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retractTeamMembership</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-setAccountStatus" title="person-setAccountStatus">setAccountStatus</h5> <p> Set the status of this person's account. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setAccountStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Status change comment </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Placeholder</tt> </li> <li> <tt>Unactivated</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Suspended</tt> </li> <li> <tt>Closed</tt> </li> <li> <tt>Deceased</tt> </li> </ul> </td> <td> <p> The status of this account </p> </td> </tr> </table> </div> <div class="method"> <h5 id="person-setLocation" title="person-setLocation">setLocation</h5> <p> Specify the location and time zone of a person. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setLocation</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>latitude</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The latitude of this object. </p> </td> </tr> <tr> <td> <p> <strong>longitude</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The longitude of this object. </p> </td> </tr> <tr> <td> <p> <strong>time_zone</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The time zone of this object. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="pillar" title="pillar">pillar</h3> <div> <p>An object that might be a project, a project group, or a distribution.</p> <p>This is a polymorphic object served by the pillar set. Check the individual object to see what type it is.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this item is active.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="pillar-standard-methods" title="pillar-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="pillars" title="pillars">pillars</h3> <div> <p>An object for searching across projects, project groups, and distros.</p> <p>Projects, project groups, and distributions are collectively known as "pillars". This object lets you do a combined search across all types of pillars. It also gives you access to pillars that have been flagged by administrators as "featured" pillars.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/pillars</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>featured_pillars_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#pillar">pillar</a> collection. </td> <td> <p> Projects, project groups, and distributions that are featured on the site. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="pillars-standard-methods" title="pillars-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="pillars-custom-GETs" title="pillars-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="pillars-search" title="pillars-search">search</h5><div> <p>Return Projects/Project groups/Distros matching :text:.</p> <p>If :limit: is None, the default batch size will be used.</p> <p>The results are ordered descending by rank.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>search</var></p></td><td></td></tr><tr><td><p><strong>limit</strong></p></td><td><p></p></td><td><p> Maximum number of items to return. This is a hard limit: any pagination you request will happen within this limit. </p></td></tr><tr><td><p><strong>text</strong></p></td><td><p><small>(required)</small></p></td><td><p> Search text </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#pillar">pillar</a> collection. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="poll" title="poll">poll</h3> <p> A poll for a given proposition in a team. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><team.name></var>/+poll/<var><poll.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>allowspoilt</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Users can spoil their votes?</p> <p>Allow users to leave the ballot blank (i.e. cast a vote for "None of the above")</p> </div> </td> </tr> <tr> <td> <p> <strong>datecloses</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date and time when this poll closes </p> </td> </tr> <tr> <td> <p> <strong>dateopens</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date and time when this poll opens </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>The unique name of this poll</p> <p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> </div> </td> </tr> <tr> <td> <p> <strong>proposition</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The proposition that is going to be voted </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>secrecy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public Votes (Anyone can see a person's vote)</tt> </li> <li> <tt>Semi-secret Votes (Only team administrators can see a person's vote)</tt> </li> <li> <tt>Secret Votes (It's impossible to track a person's vote)</tt> </li> </ul> </td> <td> <p> The secrecy of the Poll </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>team_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team">team</a>. </td> <td> <p> The team that this poll refers to. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The title of this poll </p> </td> </tr> <tr> <td> <p> <strong>type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Simple Voting</tt> </li> <li> <tt>Condorcet Voting</tt> </li> </ul> </td> <td> <p> The type of this poll </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="poll-standard-methods" title="poll-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="preview_diff" title="preview_diff">preview_diff</h3> <div> <p>A diff generated to show actual diff between two branches.</p> <p>This diff will be used primarily for branch merge proposals where we are trying to determine the effective changes of landing the source branch on the target branch.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>added_lines_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of lines added in this diff. </p> </td> </tr> <tr> <td> <p> <strong>branch_merge_proposal_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch_merge_proposal">branch_merge_proposal</a>. </td> <td> <p> The branch merge proposal that diff relates to. </p> </td> </tr> <tr> <td> <p> <strong>conflicts</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The conflicts text describing any path or text conflicts. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>When this diff was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>diff_lines_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of lines in this diff. </p> </td> </tr> <tr> <td> <p> <strong>diff_text_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a file resource. </td> <td> <p> Content of this diff </p> </td> </tr> <tr> <td> <p> <strong>diffstat</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Statistics about this diff </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>DB ID</p> <p>The tracking number for this diff.</p> </div> </td> </tr> <tr> <td> <p> <strong>prerequisite_revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The tip revision id of the prerequisite branch used to generate the diff. </p> </td> </tr> <tr> <td> <p> <strong>removed_lines_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of lines removed in this diff. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The tip revision id of the source branch used to generate the diff. </p> </td> </tr> <tr> <td> <p> <strong>stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> If the preview diff is stale, it is out of date when compared to the tip revisions of the source, target, and possibly prerequisite branches. </p> </td> </tr> <tr> <td> <p> <strong>target_revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The tip revision id of the target branch used to generate the diff. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Title</p> <p>PreviewDiff title.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="preview_diff-standard-methods" title="preview_diff-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="processor" title="processor">processor</h3> <p> The Storm Processor Interface </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+processors/<var><processor.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>build_by_default</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Whether this processor is enabled on archives by default. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Description</p> <p>The Processor Description</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Name</p> <p>The Processor Name</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>restricted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Whether this processor is restricted. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>supports_nonvirtualized</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Supports non-virtualized builds</p> <p>Whether the processor has non-virtualized builders. If not, all builds for this processor will build on virtualized builders, even for non-virtualized archives.</p> </div> </td> </tr> <tr> <td> <p> <strong>supports_virtualized</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Supports virtualized builds</p> <p>Whether the processor has virtualized builders. If not, archives that require virtualized builds won't build on this processor.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Title</p> <p>The Processor Title</p> </div> </td> </tr> </table> </div> <div id="processor-standard-methods" title="processor-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project" title="project">project</h3> <div> <p>A Product.</p> <p>The Launchpad Registry describes the open source world as ProjectGroups and Products. Each ProjectGroup may be responsible for several Products. For example, the Mozilla Project has Firefox, Thunderbird and The Mozilla App Suite as Products, among others.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this item is active.</p> </div> </td> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> The visible and active milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> All milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>branch_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td> <div> <p>Branch sharing policy</p> <p>Sharing policy for this project's branches.</p> </div> </td> </tr> <tr> <td> <p> <strong>brand_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Brand</p> <p>A large image of exactly 192x192 pixels, that will be displayed on this project's home page in Launchpad. It should be no bigger than 100kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> </ul> </td> <td> <div> <p>Bug sharing policy</p> <p>Sharing policy for this project's bugs.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_supervisor_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Bug Supervisor</p> <p>The Launchpad id of the person or team (preferred) responsible for bug management.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_tracker_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_tracker">bug_tracker</a>. </td> <td> <p> Bugs are tracked </p> </td> </tr> <tr> <td> <p> <strong>commercial_subscription_is_due</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Commercial subscription is due</p> <p>Whether the project's licensing requires a new commercial subscription to use launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>commercial_subscription_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#commercial_subscription">commercial_subscription</a>. </td> <td> <div> <p>Commercial subscriptions</p> <p>An object which contains the timeframe and the voucher code of a subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date this project was created in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> </div> </td> </tr> <tr> <td> <p> <strong>development_focus_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td> <div> <p>Development focus</p> <p>The series that represents the master or trunk branch. The Bazaar URL lp:<project> points to the development focus series branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>The name of the project as it would appear in a paragraph.</p> </div> </td> </tr> <tr> <td> <p> <strong>download_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Download URL</p> <p>The full URL where downloads for this project are located, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> <tr> <td> <p> <strong>driver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Driver</p> <p>This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.</p> </div> </td> </tr> <tr> <td> <p> <strong>freshmeat_project</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Freshmeat Project</p> <p>The Freshmeat project name for this project, if it is in freshmeat. [DEPRECATED]</p> </div> </td> </tr> <tr> <td> <p> <strong>homepage_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage URL</p> <p>The project home page. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>icon_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Icon</p> <p>A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project. The icon will be displayed next to the project name everywhere in Launchpad that we refer to the project and link to it.</p> </div> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of data contained in this item.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_permitted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Is Permitted</p> <p>Whether the project's licensing qualifies for free hosting or the project has an up-to-date subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>license_approved</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Licence approved</p> <p>The project is legitimate and its licence appears valid. Not applicable to 'Other/Proprietary'.</p> </div> </td> </tr> <tr> <td> <p> <strong>license_info</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description of additional licences</p> <p>Description of licences that do not appear in the list above.</p> </div> </td> </tr> <tr> <td> <p> <strong>licenses</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Licences </p> </td> </tr> <tr> <td> <p> <strong>logo_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Logo</p> <p>An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project. It should be no bigger than 50kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_answers</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> People can ask questions in Launchpad Answers </p> </td> </tr> <tr> <td> <p> <strong>official_blueprints</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> This project uses blueprints </p> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bugs</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Bugs in this project are tracked in Launchpad </p> </td> </tr> <tr> <td> <p> <strong>official_codehosting</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Code for this project is published in Bazaar branches on Launchpad </p> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Maintainer</p> <p>The restricted team, moderated team, or person who maintains the project information in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Product is confidential</p> <p>This product is visible only to those with access grants.</p> </div> </td> </tr> <tr> <td> <p> <strong>programming_language</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Programming Languages</p> <p>A comma delimited list of programming languages used for this project.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_group_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project_group">project_group</a>. </td> <td> <div> <p>Part of</p> <p>Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_reviewed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Project reviewed</p> <p>Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.</p> </div> </td> </tr> <tr> <td> <p> <strong>qualifies_for_free_hosting</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Qualifies for free hosting</p> <p>Whether the project's licensing qualifies it for free use of launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>This person registered the project in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>releases_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_release">project_release</a> collection. </td> <td> <p> An iterator over the ProductReleases for this product. </p> </td> </tr> <tr> <td> <p> <strong>remote_product</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Remote bug tracker project id</p> <p>Some bug trackers host multiple projects at the same URL and require an identifier for the specific project.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewer_whiteboard</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Notes for the project reviewer</p> <p>Notes on the project's licence, editable only by reviewers (Admins and Commercial Admins).</p> </div> </td> </tr> <tr> <td> <p> <strong>screenshots_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Screenshots URL</p> <p>The full URL for screenshots of this project, if available. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>series_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_series">project_series</a> collection. </td> <td></td> </tr> <tr> <td> <p> <strong>sourceforge_project</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Sourceforge Project</p> <p>The SourceForge project name for this project, if it is in sourceforge.</p> </div> </td> </tr> <tr> <td> <p> <strong>specification_sharing_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td> <div> <p>Blueprint sharing policy</p> <p>Sharing policy for this project's specifications.</p> </div> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A short paragraph to introduce the project's work.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Title</p> <p>The project title. Should be just a few words.</p> </div> </td> </tr> <tr> <td> <p> <strong>translation_focus_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td> <div> <p>Translation focus</p> <p>Project series that translators should focus on.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationgroup_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#translation_group">translation_group</a>. </td> <td> <div> <p>Translation group</p> <p>The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationpermission</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open</tt> </li> <li> <tt>Structured</tt> </li> <li> <tt>Restricted</tt> </li> <li> <tt>Closed</tt> </li> </ul> </td> <td> <div> <p>Translation permissions policy</p> <p>The policy this project or distribution uses to balance openness and control for their translations.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>vcs</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Bazaar</tt> </li> <li> <tt>Git</tt> </li> </ul> </td> <td> <div> <p>VCS</p> <p>Version control system for this project's code.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> <tr> <td> <p> <strong>wiki_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Wiki URL</p> <p>The full URL of this project's wiki, if it has one. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> </table> </div> <div id="project-standard-methods" title="project-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project-custom-GETs" title="project-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="project-canUserAlterAnswerContact" title="project-canUserAlterAnswerContact">canUserAlterAnswerContact</h5> <div> <p>Can the user add or remove the answer contact.</p> <p>Users can add or remove themselves or one of the teams they administered. Admins and target owners can add/remove anyone.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canUserAlterAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user or an administered team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="project-findReferencedOOPS" title="project-findReferencedOOPS">findReferencedOOPS</h5> <div> <p>Find OOPS reports between start_date and end_date.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>findReferencedOOPS</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>end_date</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Modified before date </p> </td> </tr> <tr> <td> <p> <strong>start_date</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Modified after date </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A set of OOPS id's - strings of the form 'OOPS-w+'.</td> </p> </div> <div class="method"><h5 id="project-findSimilarQuestions" title="project-findSimilarQuestions">findSimilarQuestions</h5><div> <p>Return questions similar to phrase.</p> <p>Return a list of question similar to the provided phrase. These questions will be found using a fuzzy search. The list is ordered from the most similar question to the least similar question.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findSimilarQuestions</var></p></td><td></td></tr><tr><td><p><strong>phrase</strong></p></td><td><p><small>(required)</small></p></td><td><p> A phrase </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="project-getAccessTokens" title="project-getAccessTokens">getAccessTokens</h5><div> <p>Return personal access tokens for this target.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAccessTokens</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#access_token">access_token</a> collection. </p> </div> <div class="method"><h5 id="project-getAnswerContactsForLanguage" title="project-getAnswerContactsForLanguage">getAnswerContactsForLanguage</h5><div> <p>Return the list of Persons that provide support for a language.</p> <p>An answer contact supports questions in their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAnswerContactsForLanguage</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="project-getBranches" title="project-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="project-getMergeProposals" title="project-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="project-getMilestone" title="project-getMilestone">getMilestone</h5><p> Return a milestone with the given name for this object, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMilestone</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#milestone">milestone</a>. </p> </div> <div class="method"> <h5 id="project-getQuestion" title="project-getQuestion">getQuestion</h5> <div> <p>Return the question by its id, if it is applicable to this target.</p> <p>If there is no such question number for this target, return None</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getQuestion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>question_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Question Number </p> </td> </tr> </table> </div> <div class="method"><h5 id="project-getRelease" title="project-getRelease">getRelease</h5><p> Return the release for this product that has the version given. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRelease</var></p></td><td></td></tr><tr><td><p><strong>version</strong></p></td><td><p><small>(required)</small></p></td><td><p> Version </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project_release">project_release</a>. </p> </div> <div class="method"><h5 id="project-getSeries" title="project-getSeries">getSeries</h5><p> Return the series for this product for the given name, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSeries</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project_series">project_series</a>. </p> </div> <div class="method"><h5 id="project-getSpecification" title="project-getSpecification">getSpecification</h5><p> Returns the specification with the given name, for this target, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSpecification</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the specification </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a>. </p> </div> <div class="method"><h5 id="project-getSubscription" title="project-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project-getSubscriptions" title="project-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="project-getSupportedLanguages" title="project-getSupportedLanguages">getSupportedLanguages</h5><div> <p>Return a list of languages spoken by at the answer contacts.</p> <p>An answer contact is considered to speak a given language if that language is listed as one of their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSupportedLanguages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#language">language</a> collection. </p> </div> <div class="method"><h5 id="project-getTranslationImportQueueEntries" title="project-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"> <h5 id="project-get_timeline" title="project-get_timeline">get_timeline</h5> <div> <p>Return basic timeline data useful for creating a diagram.</p> <p>The number of milestones returned per series is limited.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>get_timeline</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>include_inactive</strong> </p> </td> <td> <p></p> </td> <td> <p> Include inactive </p> </td> </tr> </table> </div> <div class="method"><h5 id="project-searchQuestions" title="project-searchQuestions">searchQuestions</h5><div> <p>Return the questions from the collection matching search criteria.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention_from</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="project-searchTasks" title="project-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="project-userHasBugSubscriptions" title="project-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="project-custom-POSTs" title="project-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="project-addAnswerContact" title="project-addAnswerContact">addAnswerContact</h5> <div> <p>Add a new answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was added, False if the person already is an answer contact.</td> </p> </div> <div class="method"><h5 id="project-addBugSubscription" title="project-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project-addBugSubscriptionFilter" title="project-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"> <h5 id="project-addOfficialBugTag" title="project-addOfficialBugTag">addOfficialBugTag</h5> <p> Add tag to the official bug tags of this target. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addOfficialBugTag</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>tag</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The official bug tag </p> </td> </tr> </table> </div> <div class="method"> <h5 id="project-issueAccessToken" title="project-issueAccessToken">issueAccessToken</h5> <div> <p>Issue a personal access token for this target.</p> <p>Access tokens can be used to push to repositories over HTTPS. These may be used in webservice API requests for certain methods in the target's repositories.</p> <p>They are either non-expiring or with an expiry time given by date_expires.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>issueAccessToken</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p></p> </td> <td> <p> When the token should expire. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A short description of the token. </p> </td> </tr> <tr> <td> <p> <strong>scopes</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> A list of scopes to be granted by this token. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The secret for a new personal access token (Launchpad only records the hash of this secret and not the secret itself, so the caller must be careful to save this).</td> </p> </div> <div class="method"><h5 id="project-newCodeImport" title="project-newCodeImport">newCodeImport</h5><div> <p>Create a new code import.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newCodeImport</var></p></td><td></td></tr><tr><td><p><strong>branch_name</strong></p></td><td><p></p></td><td><p> Name of branch to create </p></td></tr><tr><td><p><strong>cvs_module</strong></p></td><td><p></p></td><td><p> CVS module to import </p></td></tr><tr><td><p><strong>cvs_root</strong></p></td><td><p></p></td><td><p> CVS root URL </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner of the resulting branch </p></td></tr><tr><td><p><strong>rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Concurrent Versions System</tt></li><li><tt>Subversion via CSCVS</tt></li><li><tt>Subversion via bzr-svn</tt></li><li><tt>Git</tt></li><li><tt>Mercurial</tt></li><li><tt>Bazaar</tt></li></ul></td><td></td></tr><tr><td><p><strong>target_rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Bazaar</tt></li><li><tt>Git</tt></li></ul></td><td></td></tr><tr><td><p><strong>url</strong></p></td><td><p></p></td><td><p> Foreign VCS URL </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#code_import">code_import</a>. </p> </div> <div class="method"><h5 id="project-newSeries" title="project-newSeries">newSeries</h5><div> <p>Creates a new IProductSeries for this IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newSeries</var></p></td><td></td></tr><tr><td><p><strong>branch</strong></p></td><td><p></p> Link to a <a href="#branch">branch</a>. </td><td><div> <p>Branch</p> <p>The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.</p> </div></td></tr><tr><td><p><strong>release_url_pattern</strong></p></td><td><p></p></td><td><div> <p>Release URL pattern</p> <p>A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: <a class="rst-reference external" href="http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz" target="_top">http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz</a></p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Summary</p> <p>A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#project_series">project_series</a>. </p> </div> <div class="method"><h5 id="project-newWebhook" title="project-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"> <h5 id="project-removeAnswerContact" title="project-removeAnswerContact">removeAnswerContact</h5> <div> <p>Remove an answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was removed, False if the person wasn't an answer contact.</td> </p> </div> <div class="method"> <h5 id="project-removeBugSubscription" title="project-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="project-removeOfficialBugTag" title="project-removeOfficialBugTag">removeOfficialBugTag</h5> <p> Remove tag from the official bug tags of this target. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeOfficialBugTag</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>tag</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The official bug tag </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project_group" title="project_group">project_group</h3> <p> A ProjectGroup. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this item is active.</p> </div> </td> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_group_milestone">project_group_milestone</a> collection. </td> <td> <p> The visible and active milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_group_milestone">project_group_milestone</a> collection. </td> <td> <p> All milestones associated with this object, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>If I鈥檓 reporting a bug, I should include, if possible</p> <p>These guidelines will be shown to anyone reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_tracker_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#bug_tracker">bug_tracker</a>. </td> <td> <div> <p>Bug Tracker</p> <p>The bug tracker the projects in this project group use.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date this project group was created in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Details about the project group's work, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Appropriately capitalised, and typically ending in "Project". Examples: the Apache Project, the Mozilla Project, the Gimp Project.</p> </div> </td> </tr> <tr> <td> <p> <strong>driver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Driver</p> <p>This is a project group-wide appointment. Think carefully here! This person or team will be able to set feature goals and approve bug targeting and backporting for ANY series in ANY project in this group. You can also appoint drivers at the level of a specific project or series. So you may just want to leave this space blank, and instead let the individual projects and series have drivers.</p> </div> </td> </tr> <tr> <td> <p> <strong>freshmeat_project</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Freshmeat Project Name</p> <p>The Freshmeat project name for this project group, if it is in Freshmeat. [DEPRECATED]</p> </div> </td> </tr> <tr> <td> <p> <strong>homepage_content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage Content</p> <p>The content of this project group's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>homepage_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage URL</p> <p>The project group home page. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>icon_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Icon</p> <p>A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project group. The icon will be displayed in Launchpad everywhere that we link to this project group. For example in listings or tables of active project groups.</p> </div> </td> </tr> <tr> <td> <p> <strong>logo_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Logo</p> <p>An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project group. It should be no bigger than 50kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>mugshot_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Brand</p> <p>A large image of exactly 192x192 pixels, that will be displayed on this project group's home page in Launchpad. It should be no bigger than 100kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>A unique name, used in URLs, identifying the project group. All lowercase, no special characters. Examples: apache, mozilla, gimp.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Maintainer</p> <p>The restricted team, moderated team, or person who maintains the project group information in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>projects_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project">project</a> collection. </td> <td> <p> List of active projects for this project group. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>Project group registrant. Must be a valid Launchpad Person.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>reviewed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Reviewed</p> <p>Whether or not this project group has been reviewed.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>sourceforge_project</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>SourceForge Project Name</p> <p>The SourceForge project name for this project group, if it is in SourceForge.</p> </div> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Project Group Summary</p> <p>A short paragraph to introduce the project group's work.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The full name of the project group, which can contain spaces, special characters, etc.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationgroup_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#translation_group">translation_group</a>. </td> <td> <div> <p>Translation group</p> <p>The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.</p> </div> </td> </tr> <tr> <td> <p> <strong>translationpermission</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open</tt> </li> <li> <tt>Structured</tt> </li> <li> <tt>Restricted</tt> </li> <li> <tt>Closed</tt> </li> </ul> </td> <td> <div> <p>Translation permissions policy</p> <p>The policy this project or distribution uses to balance openness and control for their translations.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>wiki_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Wiki URL</p> <p>The URL of this project group's wiki, if it has one. Please include the <a class="rst-reference external" href="http://" target="_top">http://</a></p> </div> </td> </tr> </table> </div> <div id="project_group-standard-methods" title="project_group-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project_group-custom-GETs" title="project_group-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="project_group-getBranches" title="project_group-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="project_group-getMergeProposals" title="project_group-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="project_group-getMilestone" title="project_group-getMilestone">getMilestone</h5><p> Return a milestone with the given name for this object, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMilestone</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> Name </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#milestone">milestone</a>. </p> </div> <div class="method"><h5 id="project_group-getSubscription" title="project_group-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_group-getSubscriptions" title="project_group-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="project_group-searchTasks" title="project_group-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="project_group-userHasBugSubscriptions" title="project_group-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="project_group-custom-POSTs" title="project_group-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="project_group-addBugSubscription" title="project_group-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_group-addBugSubscriptionFilter" title="project_group-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"> <h5 id="project_group-removeBugSubscription" title="project_group-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project_group_milestone" title="project_group_milestone">project_group_milestone</h3> <p> A marker interface for milestones related to a project </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>code_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Code name</p> <p>An alternative name for the milestone.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_targeted</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date Targeted</p> <p>Example: 2005-11-24</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this object should be shown in web forms for targeting.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>Only letters, numbers, and simple punctuation are allowed.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>release_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_release">project_release</a>. </td> <td> <p> The release for this milestone. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>series_target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#has_milestones">has_milestones</a>. </td> <td> <p> The productseries or distroseries of this milestone. </p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A summary of the features and status of this milestone.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#has_milestones">has_milestones</a>. </td> <td> <p> The product, distribution, or project group for this milestone. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> A context title for pages. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="project_group_milestone-standard-methods" title="project_group_milestone-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project_group_milestone-custom-GETs" title="project_group_milestone-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="project_group_milestone-getSubscription" title="project_group_milestone-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_group_milestone-getSubscriptions" title="project_group_milestone-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="project_group_milestone-searchTasks" title="project_group_milestone-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="project_group_milestone-userHasBugSubscriptions" title="project_group_milestone-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="project_group_milestone-custom-POSTs" title="project_group_milestone-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="project_group_milestone-addBugSubscription" title="project_group_milestone-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_group_milestone-addBugSubscriptionFilter" title="project_group_milestone-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"><h5 id="project_group_milestone-createProductRelease" title="project_group_milestone-createProductRelease">createProductRelease</h5><div> <p>Create a new ProductRelease.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createProductRelease</var></p></td><td></td></tr><tr><td><p><strong>changelog</strong></p></td><td><p></p></td><td><div> <p>Changelog</p> <p>A description of every change in the release.</p> </div></td></tr><tr><td><p><strong>date_released</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Date released</p> <p>The date this release was published. Before release, this should have an estimated release date.</p> </div></td></tr><tr><td><p><strong>release_notes</strong></p></td><td><p></p></td><td><div> <p>Release notes</p> <p>A description of important new features (though the changelog below might repeat some of this information).</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#project_release">project_release</a>. </p> </div> <div class="method"> <h5 id="project_group_milestone-removeBugSubscription" title="project_group_milestone-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project_release" title="project_release">project_release</h3> <div> <p>A specific release (i.e. version) of a product.</p> <p>For example: Mozilla 1.7.2 or Apache 2.0.48.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><project.name></var>/<var><project_series.name></var>/<var><release.version></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>changelog</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Changelog</p> <p>A description of every change in the release.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Created</p> <p>The date this project release was created in Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_released</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Date released</p> <p>The date this release was published. Before release, this should have an estimated release date.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Constructed display name for a project release. </p> </td> </tr> <tr> <td> <p> <strong>files_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_release_file">project_release_file</a> collection. </td> <td> <div> <p>Project release files</p> <p>A list of files for this release.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>milestone_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#milestone">milestone</a>. </td> <td> <div> <p>Milestone for this release</p> <p>A release requires a corresponding milestone that is not attached to another release.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>The registrant of this release.</p> <p>The person or who registered this release.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project that made this release. </p> </td> </tr> <tr> <td> <p> <strong>release_notes</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Release notes</p> <p>A description of important new features (though the changelog below might repeat some of this information).</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Constructed title for a project release. </p> </td> </tr> <tr> <td> <p> <strong>version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Version</p> <p>The specific version number assigned to this release. Letters and numbers are acceptable, for releases like "1.2rc3".</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="project_release-standard-methods" title="project_release-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project_release-custom-POSTs" title="project_release-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="project_release-add_file" title="project_release-add_file">add_file</h5><div> <p>Add file to the library and link to this IProductRelease.</p> <p>The signature file will also be added if available.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>add_file</var></p></td><td></td></tr><tr><td><p><strong>content_type</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td><div> <p>Description</p> <p>A detailed description of the file contents</p> </div></td></tr><tr><td><p><strong>file_content</strong></p></td><td><p><small>(required)</small></p> Link to a file resource. </td><td></td></tr><tr><td><p><strong>file_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Code Release Tarball</tt></li><li><tt>README File</tt></li><li><tt>Release Notes</tt></li><li><tt>ChangeLog File</tt></li><li><tt>Installer file</tt></li></ul></td><td><p> Upstream file type </p></td></tr><tr><td><p><strong>filename</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>signature_content</strong></p></td><td><p></p> Link to a file resource. </td><td></td></tr><tr><td><p><strong>signature_filename</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#project_release_file">project_release_file</a>. </p> </div> <div class="method"> <h5 id="project_release-delete" title="project_release-delete">delete</h5> <div> <p>Delete this release.</p> <p>This method must not be used if this release has any release files associated with it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>delete</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project_release_file" title="project_release_file">project_release_file</h3> <p> A file associated with a ProductRelease. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><project.name></var>/<var><project_series.name></var>/<var><release.version></var>/+file/<var><hosted_file.filename></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_uploaded</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Upload date</p> <p>The date this file was uploaded</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A detailed description of the file contents</p> </div> </td> </tr> <tr> <td> <p> <strong>file_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a file resource. </td> <td> <div> <p>File</p> <p>The file contents.</p> </div> </td> </tr> <tr> <td> <p> <strong>file_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Code Release Tarball</tt> </li> <li> <tt>README File</tt> </li> <li> <tt>Release Notes</tt> </li> <li> <tt>ChangeLog File</tt> </li> <li> <tt>Installer file</tt> </li> </ul> </td> <td> <p> Upstream file type </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>project_release_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project_release">project_release</a>. </td> <td> <div> <p>Project release</p> <p>The parent product release.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>signature_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a file resource. </td> <td> <div> <p>File signature</p> <p>The file signature.</p> </div> </td> </tr> </table> </div> <div id="project_release_file-standard-methods" title="project_release_file-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project_release_file-custom-POSTs" title="project_release_file-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="project_release_file-delete" title="project_release_file-delete">delete</h5> <p> Delete the product release file. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>delete</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="project_series" title="project_series">project_series</h3> <p> A series of releases. For example '2.0' or '1.3' or 'dev'. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><project.name></var>/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.</p> </div> </td> </tr> <tr> <td> <p> <strong>active_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> The visible milestones associated with this project series, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_milestones_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#milestone">milestone</a> collection. </td> <td> <p> All milestones associated with this project series, ordered by date expected. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Branch</p> <p>The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Registered </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Display name. In this case we have removed the underlying database field, and this attribute just returns the name.</p> </div> </td> </tr> <tr> <td> <p> <strong>driver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Release manager</p> <p>The person or team responsible for decisions about features and bugs that will be targeted to this series. If you don't nominate someone here, then the owners and drivers of the project and project group will automatically have those permissions.</p> </div> </td> </tr> <tr> <td> <p> <strong>drivers_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> A list of the people or teams who are drivers for this series. This list is made up of any drivers or owners from this series and the parent drivers. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>Project owner, either a valid Person or Team</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> Project </p> </td> </tr> <tr> <td> <p> <strong>release_finder_url_pattern</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Release URL pattern</p> <p>A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: <a class="rst-reference external" href="http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz" target="_top">http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz</a></p> </div> </td> </tr> <tr> <td> <p> <strong>releases_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_release">project_release</a> collection. </td> <td> <p> An iterator over the releases in this Series, sorted with latest release first. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Active Development</tt> </li> <li> <tt>Pre-release Freeze</tt> </li> <li> <tt>Current Stable Release</tt> </li> <li> <tt>Supported</tt> </li> <li> <tt>Obsolete</tt> </li> <li> <tt>Future</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>The product series title. Should be just a few words.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_autoimport_mode</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>None</tt> </li> <li> <tt>Import template files</tt> </li> <li> <tt>Import template and translation files</tt> </li> </ul> </td> <td> <div> <p>Import settings</p> <p>Specify which files will be imported from the source code branch.</p> </div> </td> </tr> <tr> <td> <p> <strong>translations_usage</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Launchpad</tt> </li> <li> <tt>External</tt> </li> <li> <tt>Not Applicable</tt> </li> </ul> </td> <td> <div> <p>Type of service for translations application</p> <p>Where does this pillar do translations?</p> </div> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="project_series-standard-methods" title="project_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="project_series-custom-GETs" title="project_series-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="project_series-getSpecification" title="project_series-getSpecification">getSpecification</h5><p> Returns the specification with the given name, for this target, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSpecification</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the specification </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a>. </p> </div> <div class="method"><h5 id="project_series-getSubscription" title="project_series-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_series-getSubscriptions" title="project_series-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"><h5 id="project_series-getTranslationImportQueueEntries" title="project_series-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="project_series-getTranslationTemplates" title="project_series-getTranslationTemplates">getTranslationTemplates</h5><div> <p>Return an iterator over all its translation templates.</p> <p>The returned templates are either obsolete or current.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationTemplates</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_template">translation_template</a> collection. </p> </div> <div class="method"> <h5 id="project_series-get_timeline" title="project_series-get_timeline">get_timeline</h5> <div> <p>Return basic timeline data useful for creating a diagram.</p> <p>The number of milestones returned is limited.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>get_timeline</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>include_inactive</strong> </p> </td> <td> <p></p> </td> <td> <p> Include inactive </p> </td> </tr> </table> </div> <div class="method"><h5 id="project_series-searchTasks" title="project_series-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> <div class="method"> <h5 id="project_series-userHasBugSubscriptions" title="project_series-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="project_series-custom-POSTs" title="project_series-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="project_series-addBugSubscription" title="project_series-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="project_series-addBugSubscriptionFilter" title="project_series-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"><h5 id="project_series-newMilestone" title="project_series-newMilestone">newMilestone</h5><p> Create a new milestone for this ProjectSeries. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newMilestone</var></p></td><td></td></tr><tr><td><p><strong>code_name</strong></p></td><td><p></p></td><td><div> <p>Code name</p> <p>An alternative name for the milestone.</p> </div></td></tr><tr><td><p><strong>date_targeted</strong></p></td><td><p></p></td><td><div> <p>Date Targeted</p> <p>Example: 2005-11-24</p> </div></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><div> <p>Name</p> <p>Only letters, numbers, and simple punctuation are allowed.</p> </div></td></tr><tr><td><p><strong>summary</strong></p></td><td><p></p></td><td><div> <p>Summary</p> <p>A summary of the features and status of this milestone.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#milestone">milestone</a>. </p> </div> <div class="method"> <h5 id="project_series-removeBugSubscription" title="project_series-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="question" title="question">question</h3> <p> A single question, often a support request. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+question/<var><question.id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>answer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#question_message">question_message</a>. </td> <td> <div> <p>Answer</p> <p>The IQuestionMessage that contains the answer confirmed by the owner as providing a solution to their problem.</p> </div> </td> </tr> <tr> <td> <p> <strong>answerer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Answered By</p> <p>The person who last provided a response intended to resolve the question.</p> </div> </td> </tr> <tr> <td> <p> <strong>assignee_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Assignee</p> <p>The person responsible for helping to resolve the question.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_due</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Due</p> <p>The date by which we should have resolved this question.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_query</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Last Queried</p> <p>The date on which we last heard from the customer (owner).</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_response</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date last Responded</p> <p>The date on which we last communicated with the customer. The combination of datelastquery and datelastresponse tells us in whose court the ball is.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_solved</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Answered</p> <p>The date on which the question owner confirmed that the question is Solved.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Include as much detail as possible: what you鈥檙e trying to achieve, what steps you take, what happens, and what you think should happen instead.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Question Number</p> <p>The tracking number for this question.</p> </div> </td> </tr> <tr> <td> <p> <strong>language_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#language">language</a>. </td> <td> <div> <p>Language</p> <p>The language in which this question is written.</p> </div> </td> </tr> <tr> <td> <p> <strong>messages_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#question_message">question_message</a> collection. </td> <td> <div> <p>Messages</p> <p>The list of messages that were exchanged as part of this question , sorted from first to last.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open</tt> </li> <li> <tt>Needs information</tt> </li> <li> <tt>Answered</tt> </li> <li> <tt>Solved</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Invalid</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#question_target">question_target</a>. </td> <td> <div> <p>This question is about</p> <p>The distribution, source package, or project the question pertains to.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A one-line summary of the issue or problem.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="question-standard-methods" title="question-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="question-custom-POSTs" title="question-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="question-reject" title="question-reject">reject</h5><div> <p>Mark this question as INVALID.</p> <p>Add an IQuestionMessage with action REJECT. The question status is changed to INVALID. The created message is set as the question answer and its owner as the question answerer. The datelastresponse and date_solved are updated to the message creation.</p> <p>Only answer contacts for the question target, the target owner or a member of the admin team can reject a request. All questions can be rejected.</p> <p>Return the created IQuestionMessage.</p> <p>This method should fire an IObjectCreatedEvent for the created IQuestionMessage and an IObjectModifiedEvent for the question.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>reject</var></p></td><td></td></tr><tr><td><p><strong>comment</strong></p></td><td><p><small>(required)</small></p></td><td><p> An explanation of the rejection </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#question_message">question_message</a>. </p> </div> <div class="method"> <h5 id="question-setCommentVisibility" title="question-setCommentVisibility">setCommentVisibility</h5> <div> <p>Set the visible attribute on a question message.</p> <p>This is restricted to Launchpad admins and registry members, and will return a HTTP Error 401: Unauthorized error for non-admin callers.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setCommentVisibility</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment_number</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The number of the comment in the list of messages. </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Show this comment? </p> </td> </tr> </table> </div> <div class="method"> <h5 id="question-subscribe" title="question-subscribe">subscribe</h5> <div> <p>Subscribe person to the question.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>subscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">an IQuestionSubscription.</td> </p> </div> <div class="method"> <h5 id="question-unsubscribe" title="question-unsubscribe">unsubscribe</h5> <div> <p>Unsubscribe person from the question.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="question_message" title="question_message">question_message</h3> <p> A message part of a question. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+question/<var><question.id></var>/messages/<var><message.index></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>action</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Request for more information</tt> </li> <li> <tt>Give more information</tt> </li> <li> <tt>Comment</tt> </li> <li> <tt>Answer</tt> </li> <li> <tt>Confirm</tt> </li> <li> <tt>Reject</tt> </li> <li> <tt>Expire</tt> </li> <li> <tt>Reopen</tt> </li> <li> <tt>Change status</tt> </li> </ul> </td> <td> <p> Action operated on the question by this message. </p> </td> </tr> <tr> <td> <p> <strong>bug_attachments_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_attachment">bug_attachment</a> collection. </td> <td> <p> A list of BugAttachments connected to this message. </p> </td> </tr> <tr> <td> <p> <strong>content</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> All the text/plain chunks joined together as a unicode string. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_deleted</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was deleted </p> </td> </tr> <tr> <td> <p> <strong>date_last_edited</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When this message was last edited </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>index</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Human readable Message index.</p> <p>The message's index in the question's list of messages.</p> </div> </td> </tr> <tr> <td> <p> <strong>new_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open</tt> </li> <li> <tt>Needs information</tt> </li> <li> <tt>Answered</tt> </li> <li> <tt>Solved</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Invalid</tt> </li> </ul> </td> <td> <div> <p>Question status after message</p> <p>The status of the question after the transition related the action operated by this message.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> <tr> <td> <p> <strong>parent_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message">message</a>. </td> <td> <p> Parent </p> </td> </tr> <tr> <td> <p> <strong>question_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#question">question</a>. </td> <td> <div> <p>The question related to this message.</p> <p>An IQuestion object.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revisions_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#message_revision">message_revision</a> collection. </td> <td> <div> <p>Message revision history</p> <p>Revision history of this message, sorted in ascending order.</p> </div> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subject</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Subject </p> </td> </tr> <tr> <td> <p> <strong>visible</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Message visibility.</p> <p>Whether or not the message is visible.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="question_message-standard-methods" title="question_message-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="question_message-custom-GETs" title="question_message-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="question_message-getAPIParent" title="question_message-getAPIParent">getAPIParent</h5> <p> Return None because messages are not threaded over the API. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getAPIParent</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="question_message-custom-POSTs" title="question_message-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="question_message-deleteContent" title="question_message-deleteContent">deleteContent</h5> <p> Deletes this message content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deleteContent</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="question_message-editContent" title="question_message-editContent">editContent</h5> <p> Edit the content of this message, generating a new message revision with the old content. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>editContent</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_content</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <div> <p>Message content</p> <p>The new message content string</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="question_subscription" title="question_subscription">question_subscription</h3> <p> A subscription for a person to a question. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date subscribed </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Person</p> <p>The person's Launchpad ID or email address.</p> </div> </td> </tr> <tr> <td> <p> <strong>question_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#question">question</a>. </td> <td> <p> Question </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="question_subscription-standard-methods" title="question_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="question_target" title="question_target">question_target</h3> <p> An object that can have a new question asked about it. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="question_target-standard-methods" title="question_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="question_target-custom-GETs" title="question_target-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="question_target-canUserAlterAnswerContact" title="question_target-canUserAlterAnswerContact">canUserAlterAnswerContact</h5> <div> <p>Can the user add or remove the answer contact.</p> <p>Users can add or remove themselves or one of the teams they administered. Admins and target owners can add/remove anyone.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canUserAlterAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user or an administered team </p> </td> </tr> </table> </div> <div class="method"><h5 id="question_target-findSimilarQuestions" title="question_target-findSimilarQuestions">findSimilarQuestions</h5><div> <p>Return questions similar to phrase.</p> <p>Return a list of question similar to the provided phrase. These questions will be found using a fuzzy search. The list is ordered from the most similar question to the least similar question.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>findSimilarQuestions</var></p></td><td></td></tr><tr><td><p><strong>phrase</strong></p></td><td><p><small>(required)</small></p></td><td><p> A phrase </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="question_target-getAnswerContactsForLanguage" title="question_target-getAnswerContactsForLanguage">getAnswerContactsForLanguage</h5><div> <p>Return the list of Persons that provide support for a language.</p> <p>An answer contact supports questions in their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getAnswerContactsForLanguage</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"> <h5 id="question_target-getQuestion" title="question_target-getQuestion">getQuestion</h5> <div> <p>Return the question by its id, if it is applicable to this target.</p> <p>If there is no such question number for this target, return None</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getQuestion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>question_id</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Question Number </p> </td> </tr> </table> </div> <div class="method"><h5 id="question_target-getSupportedLanguages" title="question_target-getSupportedLanguages">getSupportedLanguages</h5><div> <p>Return a list of languages spoken by at the answer contacts.</p> <p>An answer contact is considered to speak a given language if that language is listed as one of their preferred languages.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSupportedLanguages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#language">language</a> collection. </p> </div> <div class="method"><h5 id="question_target-searchQuestions" title="question_target-searchQuestions">searchQuestions</h5><div> <p>Return the questions from the collection matching search criteria.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention_from</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> </div> <div id="question_target-custom-POSTs" title="question_target-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="question_target-addAnswerContact" title="question_target-addAnswerContact">addAnswerContact</h5> <div> <p>Add a new answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was added, False if the person already is an answer contact.</td> </p> </div> <div class="method"> <h5 id="question_target-removeAnswerContact" title="question_target-removeAnswerContact">removeAnswerContact</h5> <div> <p>Remove an answer contact.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeAnswerContact</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The user of an administered team </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">True if the person was removed, False if the person wasn't an answer contact.</td> </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="revision_status_report" title="revision_status_report">revision_status_report</h3> <p> An revision status report for a Git commit. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ci_build_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#ci_build">ci_build</a>. </td> <td> <p> The CI build that produced this report. </p> </td> </tr> <tr> <td> <p> <strong>commit_sha1</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The Git commit for which this report is built. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> When the report was created. </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> When the report has finished. </p> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> When the report was started. </p> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for the CI build job that produced this report. </p> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> The Git repository for which this report is built. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>properties</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Metadata for artifacts attached to this report </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>result</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Waiting</tt> </li> <li> <tt>Running</tt> </li> <li> <tt>Succeeded</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Skipped</tt> </li> <li> <tt>Cancelled</tt> </li> </ul> </td> <td> <p> Result of the report </p> </td> </tr> <tr> <td> <p> <strong>result_summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A short summary of the result. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A short title for the report. </p> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>URL</p> <p>The external url of the report.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="revision_status_report-standard-methods" title="revision_status_report-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="revision_status_report-custom-GETs" title="revision_status_report-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="revision_status_report-getArtifactURLs" title="revision_status_report-getArtifactURLs">getArtifactURLs</h5> <div> <p>Retrieves the list of URLs for artifacts that exist for this report.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getArtifactURLs</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>artifact_type</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Log</tt> </li> <li> <tt>Binary</tt> </li> </ul> </td> <td></td> </tr> </table> </div> </div> <div id="revision_status_report-custom-POSTs" title="revision_status_report-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="revision_status_report-attach" title="revision_status_report-attach">attach</h5> <div> <p>Attach a new artifact to an existing status report.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>attach</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>data</strong> </p> </td> <td><p><small>(required)</small></p> Link to a file resource. </td> <td> <p> The content of the artifact in bytes. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The name of the artifact. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="revision_status_report-setLog" title="revision_status_report-setLog">setLog</h5> <div> <p>Set a new log on an existing status report.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setLog</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>log_data</strong> </p> </td> <td><p><small>(required)</small></p> Link to a file resource. </td> <td> <p> The content of the artifact in bytes. </p> </td> </tr> </table> </div> <div class="method"> <h5 id="revision_status_report-update" title="revision_status_report-update">update</h5> <div> <p>Updates a status report.</p> <blockquote> </blockquote> <p>Scopes: <tt class="rst-docutils literal">repository:build_status</tt></p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>update</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>properties</strong> </p> </td> <td> <p></p> </td> <td> <p> Properties dictionary </p> </td> </tr> <tr> <td> <p> <strong>result</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Waiting</tt> </li> <li> <tt>Running</tt> </li> <li> <tt>Succeeded</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Skipped</tt> </li> <li> <tt>Cancelled</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>result_summary</strong> </p> </td> <td> <p></p> </td> <td> <p> A short summary of the result. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p></p> </td> <td> <p> A short title for the report. </p> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p></p> </td> <td> <p> The external link of the status report. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="rock_base" title="rock_base">rock_base</h3> <p> A base for rocks. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building rock recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Distro series </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures that the rock base supports.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this base.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="rock_base-standard-methods" title="rock_base-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="rock_base-custom-POSTs" title="rock_base-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="rock_base-setProcessors" title="rock_base-setProcessors">setProcessors</h5> <p> Set the architectures that the rock base supports. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="rock_recipe" title="rock_recipe">rock_recipe</h3> <p> A buildable rock recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+rock/<var><recipe.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>auto_build</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically build when branch changes</p> <p>Whether this rock recipe is built automatically when the branch containing its rockcraft.yaml recipe changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this rock recipe. Currently only 'core', 'core18', 'core20', and 'rockcraft' keys are supported.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build path</p> <p>Subdirectory within the branch containing rockcraft.yaml.</p> </div> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build">rock_recipe_build</a> collection. </td> <td> <div> <p>All builds of this rock recipe.</p> <p>All builds of this rock recipe, sorted in descending order of finishing (or starting if not completed successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>can_upload_to_store</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can upload to the RockStore</p> <p>Whether everything is set up to allow uploading builds of this rockrecipe to the RockStore.</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build">rock_recipe_build</a> collection. </td> <td> <div> <p>Completed builds of this rock recipe.</p> <p>Completed builds of this rock recipe, sorted in descending order of finishing.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A description of the rock recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>failed_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build_request">rock_recipe_build_request</a> collection. </td> <td> <p> Failed build requests for this rock recipe. </p> </td> </tr> <tr> <td> <p> <strong>fetch_service_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>strict</tt> </li> <li> <tt>permissive</tt> </li> </ul> </td> <td> <div> <p>Fetch service policy</p> <p>Which policy to use when using the fetch service. Ignored if use_fetch_service flag is False.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_path</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git branch path</p> <p>The path of the Git branch containing a rockcraft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_ref_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td> <td> <div> <p>Git branch</p> <p>The Git branch containing a rockcraft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Git repository</p> <p>A Git repository with a branch containing a rockcraft.yaml recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a rockcraft.yaml at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this rock recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Rock recipe is stale and is due to be rebuilt. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Rock recipe name</p> <p>The name of the rock recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this rock recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build_request">rock_recipe_build_request</a> collection. </td> <td> <p> Pending build requests for this rock recipe. </p> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build">rock_recipe_build</a> collection. </td> <td> <div> <p>Pending builds of this rock recipe.</p> <p>Pending builds of this rock recipe, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Private</p> <p>Whether this rock recipe is private.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> The project that this rock recipe is associated with </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this rock recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build this rock recipe on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>store_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Store channels</p> <p>Channels to release this rock to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Registered store name</p> <p>The registered name of this rock in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically upload to store</p> <p>Whether builds of this rock recipe are automatically uploaded to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>use_fetch_service</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Use fetch service</p> <p>If set, Rock builds will use the fetch-service instead of the builder-proxy to access external resources.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="rock_recipe-standard-methods" title="rock_recipe-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="rock_recipe-custom-POSTs" title="rock_recipe-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="rock_recipe-requestBuilds" title="rock_recipe-requestBuilds">requestBuilds</h5><div> <p>Request that the rock recipe be built.</p> <p>This is an asynchronous operation; once the operation has finished, the resulting build request's C{status} will be "Completed" and its C{builds} collection will return the resulting builds.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuilds</var></p></td><td></td></tr><tr><td><p><strong>architectures</strong></p></td><td><p></p></td><td><p> The list of architectures to build for this recipe. </p></td></tr><tr><td><p><strong>channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels to use for these builds.</p> <p>A dictionary mapping snap names to channels to use for these builds. Currently only 'rockcraft', 'core', 'core18', 'core20', and 'core22' keys are supported.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#rock_recipe_build_request">rock_recipe_build_request</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="rock_recipe_build" title="rock_recipe_build">rock_recipe_build</h3> <p> A build record for a rock recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+rock/<var><recipe.name></var>/+build/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_metadata_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>URL of the build metadata file</p> <p>URL of the metadata file generated by the fetch service, if it exists.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Currently only 'core', 'core18', 'core20', and 'rockcraft' keys are supported.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture for which to build. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe">rock_recipe</a>. </td> <td> <p> The rock recipe to build. </p> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who requested this build. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Revision ID</p> <p>The revision ID of the branch used for this build, if available.</p> </div> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="rock_recipe_build-standard-methods" title="rock_recipe_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="rock_recipe_build-custom-GETs" title="rock_recipe_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="rock_recipe_build-getFileUrls" title="rock_recipe_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="rock_recipe_build-custom-POSTs" title="rock_recipe_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="rock_recipe_build-cancel" title="rock_recipe_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="rock_recipe_build-rescore" title="rock_recipe_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="rock_recipe_build-retry" title="rock_recipe_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="rock_recipe_build_request" title="rock_recipe_build_request">rock_recipe_build_request</h3> <p> A request to build a rock recipe. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/<var><project.name></var>/+rock/<var><recipe.name></var>/+build-request/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>architectures</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> If set, this request is limited to these architecture tags </p> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe_build">rock_recipe_build</a> collection. </td> <td> <p> Builds produced by this request </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request finished </p> </td> </tr> <tr> <td> <p> <strong>date_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request was made </p> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Error message </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>recipe_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#rock_recipe">rock_recipe</a>. </td> <td> <p> Rock recipe </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Completed</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="rock_recipe_build_request-standard-methods" title="rock_recipe_build_request-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="service_factory" title="service_factory">service_factory</h3> <p> Interface representing a factory used to access named services. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="service_factory-standard-methods" title="service_factory-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="sharing_service" title="sharing_service">sharing_service</h3> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the service, used to generate the url.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="sharing_service-standard-methods" title="sharing_service-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="sharing_service-custom-GETs" title="sharing_service-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="sharing_service-getPillarGranteeData" title="sharing_service-getPillarGranteeData">getPillarGranteeData</h5> <div> <p>Return people/teams who can see pillar artifacts.</p> <dl class="rst-docutils"> <dt>The result records are json data which includes:</dt> <dd><ul class="rst-first rst-last rst-simple"> <li>person name</li> <li>permissions they have for each information type.</li> </ul> </dd> </dl> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getPillarGranteeData</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>pillar</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td> <td> <p> Pillar </p> </td> </tr> </table> </div> <div class="method"><h5 id="sharing_service-getSharedBranches" title="sharing_service-getSharedBranches">getSharedBranches</h5><div> <p>Return the branches shared between the pillar and person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedBranches</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr><tr><td><p><strong>pillar</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td><td><p> Pillar </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="sharing_service-getSharedBugs" title="sharing_service-getSharedBugs">getSharedBugs</h5><div> <p>Return the bugs shared between the pillar and person.</p> <p>The result includes bugtasks rather than bugs since this is what the pillar filtering is applied to. The shared bug can be obtained simply by reading the bugtask.bug attribute.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedBugs</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr><tr><td><p><strong>pillar</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td><td><p> Pillar </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug">bug</a> collection. </p> </div> <div class="method"><h5 id="sharing_service-getSharedDistributions" title="sharing_service-getSharedDistributions">getSharedDistributions</h5><p> <dl class="rst-docutils"> <dt>Find distributions for which person has one or more access policy</dt> <dd>grants.</dd> </dl> </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedDistributions</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution">distribution</a> collection. </p> </div> <div class="method"><h5 id="sharing_service-getSharedGitRepositories" title="sharing_service-getSharedGitRepositories">getSharedGitRepositories</h5><div> <p>Return the Git repositories shared between the pillar and person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedGitRepositories</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr><tr><td><p><strong>pillar</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td><td><p> Pillar </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#git_repository">git_repository</a> collection. </p> </div> <div class="method"><h5 id="sharing_service-getSharedProjects" title="sharing_service-getSharedProjects">getSharedProjects</h5><div> <p>Find projects for which person has one or more access policy grants.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedProjects</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> <div class="method"><h5 id="sharing_service-getSharedSpecifications" title="sharing_service-getSharedSpecifications">getSharedSpecifications</h5><div> <p>Return the specifications shared between the pillar and person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSharedSpecifications</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td><p> Person </p></td></tr><tr><td><p><strong>pillar</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td><td><p> Pillar </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a> collection. </p> </div> </div> <div id="sharing_service-custom-POSTs" title="sharing_service-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="sharing_service-deletePillarGrantee" title="sharing_service-deletePillarGrantee">deletePillarGrantee</h5> <div> <p>Remove a grantee from a pillar.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePillarGrantee</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>grantee</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Grantee </p> </td> </tr> <tr> <td> <p> <strong>information_types</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>pillar</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td> <td> <p> Pillar </p> </td> </tr> </table> </div> <div class="method"> <h5 id="sharing_service-ensureAccessGrants" title="sharing_service-ensureAccessGrants">ensureAccessGrants</h5> <div> <p>Ensure a grantee has an access grant to the specified artifacts.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>ensureAccessGrants</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branches</strong> </p> </td> <td> <p></p> </td> <td> <p> Branches </p> </td> </tr> <tr> <td> <p> <strong>bugs</strong> </p> </td> <td> <p></p> </td> <td> <p> Bugs </p> </td> </tr> <tr> <td> <p> <strong>git_repositories</strong> </p> </td> <td> <p></p> </td> <td> <p> Git repositories </p> </td> </tr> <tr> <td> <p> <strong>grantees</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>ocirecipes</strong> </p> </td> <td> <p></p> </td> <td> <p> OCI recipes </p> </td> </tr> <tr> <td> <p> <strong>snaps</strong> </p> </td> <td> <p></p> </td> <td> <p> Snap recipes </p> </td> </tr> <tr> <td> <p> <strong>vulnerabilities</strong> </p> </td> <td> <p></p> </td> <td> <p> Vulnerabilities </p> </td> </tr> </table> </div> <div class="method"> <h5 id="sharing_service-revokeAccessGrants" title="sharing_service-revokeAccessGrants">revokeAccessGrants</h5> <div> <p>Remove a grantee's access to the specified artifacts.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>revokeAccessGrants</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branches</strong> </p> </td> <td> <p></p> </td> <td> <p> Branches </p> </td> </tr> <tr> <td> <p> <strong>bugs</strong> </p> </td> <td> <p></p> </td> <td> <p> Bugs </p> </td> </tr> <tr> <td> <p> <strong>git_repositories</strong> </p> </td> <td> <p></p> </td> <td> <p> Git repositories </p> </td> </tr> <tr> <td> <p> <strong>grantee</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Grantee </p> </td> </tr> <tr> <td> <p> <strong>ocirecipes</strong> </p> </td> <td> <p></p> </td> <td> <p> OCI recipes </p> </td> </tr> <tr> <td> <p> <strong>pillar</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td> <td> <p> Pillar </p> </td> </tr> <tr> <td> <p> <strong>snaps</strong> </p> </td> <td> <p></p> </td> <td> <p> Snap recipes </p> </td> </tr> <tr> <td> <p> <strong>specifications</strong> </p> </td> <td> <p></p> </td> <td> <p> Specifications </p> </td> </tr> <tr> <td> <p> <strong>vulnerabilities</strong> </p> </td> <td> <p></p> </td> <td> <p> Vulnerabilities </p> </td> </tr> </table> </div> <div class="method"> <h5 id="sharing_service-sharePillarInformation" title="sharing_service-sharePillarInformation">sharePillarInformation</h5> <div> <p>Ensure grantee has the grants for information types on a pillar.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>sharePillarInformation</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>grantee</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Grantee </p> </td> </tr> <tr> <td> <p> <strong>permissions</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>pillar</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td> <td> <p> Pillar </p> </td> </tr> </table> </div> <div class="method"> <h5 id="sharing_service-updatePillarSharingPolicies" title="sharing_service-updatePillarSharingPolicies">updatePillarSharingPolicies</h5> <div> <p>Update the sharing policies for a pillar.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>updatePillarSharingPolicies</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch_sharing_policy</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>bug_sharing_policy</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> </ul> </td> <td></td> </tr> <tr> <td> <p> <strong>pillar</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#pillar">pillar</a>. </td> <td> <p> Pillar </p> </td> </tr> <tr> <td> <p> <strong>specification_sharing_policy</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public, can be proprietary</tt> </li> <li> <tt>Proprietary, can be public</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed, can be proprietary</tt> </li> <li> <tt>Forbidden</tt> </li> </ul> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="snap" title="snap">snap</h3> <p> A buildable snap package. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/+snap/<var><snap.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>allow_internet</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Allow external network access</p> <p>Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically build when branch changes</p> <p>Whether this snap package is built automatically when the branch containing its snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe changes.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_archive_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Source archive for automatic builds</p> <p>The archive from which automatic builds of this snap package should be built.</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for automatic builds</p> <p>A dictionary mapping snap names to channels to use when building this snap package. Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'</p> </div> </td> </tr> <tr> <td> <p> <strong>auto_build_pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket for automatic builds</p> <p>The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <div> <p>Bazaar branch</p> <p>A Bazaar branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_source_tarball</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build source tarball</p> <p>Whether builds of this snap package should also build a tarball containing all source code, including external dependencies.</p> </div> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build">snap_build</a> collection. </td> <td> <div> <p>All builds of this snap package.</p> <p>All builds of this snap package, sorted in descending order of finishing (or starting if not completed successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>can_upload_to_store</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can upload to store</p> <p>Whether everything is set up to allow uploading builds of this snap package to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build">snap_build</a> collection. </td> <td> <div> <p>Completed builds of this snap package.</p> <p>Completed builds of this snap package, sorted in descending order of finishing.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A description of the snap package.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distro Series</p> <p>The series for which the snap package should be built. If not set, Launchpad will infer an appropriate series from snapcraft.yaml.</p> </div> </td> </tr> <tr> <td> <p> <strong>failed_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build_request">snap_build_request</a> collection. </td> <td> <p> Failed build requests for this snap package. </p> </td> </tr> <tr> <td> <p> <strong>fetch_service_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>strict</tt> </li> <li> <tt>permissive</tt> </li> </ul> </td> <td> <div> <p>Fetch service policy</p> <p>Which policy to use when using the fetch service. Ignored if use_fetch_service flag is False.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Git branch path</p> <p>The path of the Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_ref_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#git_ref">git_ref</a>. </td> <td> <div> <p>Git branch</p> <p>The Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <div> <p>Git repository</p> <p>A Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>git_repository_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Git repository URL</p> <p>The URL of a Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>The type of information contained in this Snap recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Snap package is stale and is due to be rebuilt. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Snap recipe name</p> <p>The name of the snap build recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of this snap package.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_build_requests_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build_request">snap_build_request</a> collection. </td> <td> <p> Pending build requests for this snap package. </p> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build">snap_build</a> collection. </td> <td> <div> <p>Pending builds of this snap package.</p> <p>Pending builds of this snap package, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Private</p> <p>Whether or not this snap is private.</p> </div> </td> </tr> <tr> <td> <p> <strong>pro_enable</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Enable Ubuntu Pro</p> <p>Allow building this snap recipe using dependencies from Ubuntu Pro, if configured for the corresponding snap base.</p> </div> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures for which the snap package should be built.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this snap package.</p> </div> </td> </tr> <tr> <td> <p> <strong>require_virtualized</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Require virtualized builders</p> <p>Only build this snap package on virtual builders.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>store_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Store channels</p> <p>Channels to release this snap package to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Registered store package name</p> <p>The registered name of this snap package in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#snappy_series">snappy_series</a>. </td> <td> <div> <p>Store series</p> <p>The series in which this snap package should be published in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Automatically upload to store</p> <p>Whether builds of this snap package are automatically uploaded to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>use_fetch_service</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Use fetch service</p> <p>If set, Snap builds will use the fetch-service instead of the builder-proxy to access external resources.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="snap-standard-methods" title="snap-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="snap-custom-GETs" title="snap-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="snap-getBuildByStoreRevision" title="snap-getBuildByStoreRevision">getBuildByStoreRevision</h5><p> <dl class="rst-docutils"> <dt>Returns the build (if any) of that snap recipe</dt> <dd>that has the given store_upload_revision.</dd> </dl> </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuildByStoreRevision</var></p></td><td></td></tr><tr><td><p><strong>store_upload_revision</strong></p></td><td><p><small>(required)</small></p></td><td><p> Store revision </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap_build">snap_build</a>. </p> </div> <div class="method"> <h5 id="snap-getBuildSummaries" title="snap-getBuildSummaries">getBuildSummaries</h5> <div> <p>Return a dictionary containing a summary of build information.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getBuildSummaries</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>build_ids</strong> </p> </td> <td> <p></p> </td> <td> <p> A list of snap build IDs. </p> </td> </tr> <tr> <td> <p> <strong>request_ids</strong> </p> </td> <td> <p></p> </td> <td> <p> A list of snap build request IDs. </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A dict of {"requests", "builds"}, consisting of the overall status summaries for the given snap build requests and snap builds respectively.</td> </p> </div> </div> <div id="snap-custom-POSTs" title="snap-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="snap-beginAuthorization" title="snap-beginAuthorization">beginAuthorization</h5> <div> <p>Begin authorizing uploads of this snap package to the store.</p> <p>This is intended for use by third-party sites integrating with Launchpad. Most users should visit <snap URL>/+authorize instead.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>beginAuthorization</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">The SSO caveat ID from the package_upload macaroon returned by the store. The third-party site should acquire a discharge macaroon for this caveat using OpenID and then call completeAuthorization.</td> </p> </div> <div class="method"> <h5 id="snap-completeAuthorization" title="snap-completeAuthorization">completeAuthorization</h5> <div> <p>Complete authorizing uploads of this snap package to the store.</p> <p>This is intended for use by third-party sites integrating with Launchpad.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>completeAuthorization</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>discharge_macaroon</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Serialized discharge macaroon</p> <p>Only required if root macaroon has SSO third-party caveat.</p> </div> </td> </tr> <tr> <td> <p> <strong>root_macaroon</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Serialized root macaroon</p> <p>Only required if not already set by beginAuthorization.</p> </div> </td> </tr> </table> </div> <div class="method"><h5 id="snap-newWebhook" title="snap-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> <div class="method"><h5 id="snap-requestAutoBuilds" title="snap-requestAutoBuilds">requestAutoBuilds</h5><div> <p>Create and return automatic builds for this snap package.</p> <p>This webservice API method is deprecated. It is normally better to use the requestBuilds method instead, which can make dispatching decisions based on the contents of snapcraft.yaml.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestAutoBuilds</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#snap_build">snap_build</a> collection. </p> </div> <div class="method"><h5 id="snap-requestBuild" title="snap-requestBuild">requestBuild</h5><div> <p>Request that the snap package be built.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuild</var></p></td><td></td></tr><tr><td><p><strong>archive</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'</p> </div></td></tr><tr><td><p><strong>distro_arch_series</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td></td></tr><tr><td><p><strong>snap_base</strong></p></td><td><p></p> Link to a <a href="#snap_base">snap_base</a>. </td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#snap_build">snap_build</a>. </p> </div> <div class="method"><h5 id="snap-requestBuilds" title="snap-requestBuilds">requestBuilds</h5><div> <p>Request that the snap package be built for relevant architectures.</p> <p>This is an asynchronous operation; once the operation has finished, the resulting build request's C{status} will be "Completed" and its C{builds} collection will return the resulting builds.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuilds</var></p></td><td></td></tr><tr><td><p><strong>archive</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>channels</strong></p></td><td><p></p></td><td><div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'</p> </div></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#snap_build_request">snap_build_request</a>. </p> </div> <div class="method"> <h5 id="snap-setProcessors" title="snap-setProcessors">setProcessors</h5> <p> Set the architectures for which the snap package should be built. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="snap_base" title="snap_base">snap_base</h3> <p> A base for snaps. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+snap-bases/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>build_channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels for builds</p> <p>A dictionary mapping snap names to channels to use when building snaps that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>dependencies_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive_dependency">archive_dependency</a> collection. </td> <td> <p> Archive dependencies for this snap base. </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Display name </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Distro series </p> </td> </tr> <tr> <td> <p> <strong>features</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Features supported by this base</p> <p>A dictionary designating the features supported by the base. Key is the name of a feature, value is a boolean indicating whether the feature is supported or not.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_default</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Is default?</p> <p>Whether this base is the default for snaps that do not specify a base.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Name </p> </td> </tr> <tr> <td> <p> <strong>processors_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#processor">processor</a> collection. </td> <td> <div> <p>Processors</p> <p>The architectures that the snap base supports.</p> </div> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this base.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="snap_base-standard-methods" title="snap_base-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="snap_base-custom-GETs" title="snap_base-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="snap_base-getArchiveDependency" title="snap_base-getArchiveDependency">getArchiveDependency</h5><div> <p>Return the IArchiveDependency object for the given dependency.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getArchiveDependency</var></p></td><td></td></tr><tr><td><p><strong>dependency</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_dependency">archive_dependency</a>. </p> </div> </div> <div id="snap_base-custom-POSTs" title="snap_base-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="snap_base-addArchiveDependency" title="snap_base-addArchiveDependency">addArchiveDependency</h5><div> <p>Add an archive dependency for this snap base.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addArchiveDependency</var></p></td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><p> Component name </p></td></tr><tr><td><p><strong>dependency</strong></p></td><td><p></p> Link to a <a href="#archive">archive</a>. </td><td><p> The archive set as a dependency. </p></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive_dependency">archive_dependency</a>. </p> <h6>Errors</h6><ul><li><td class="rst-field-body">ArchiveDependencyError if the given dependency does not fit this snap base.</td></li></ul></div> <div class="method"> <h5 id="snap_base-removeArchiveDependency" title="snap_base-removeArchiveDependency">removeArchiveDependency</h5> <div> <p>Remove the archive dependency on the given archive.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeArchiveDependency</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>dependency</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="snap_base-setProcessors" title="snap_base-setProcessors">setProcessors</h5> <p> Set the architectures that the snap base supports. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setProcessors</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>processors</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="snap_build" title="snap_build">snap_build</h3> <p> Build information for snap package builds. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/+snap/<var><snap.name></var>/+build/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>arch_tag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Architecture tag </p> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> The archive from which to build the snap package. </p> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_metadata_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>URL of the build metadata file</p> <p>URL of the metadata file generated by the fetch service, if it exists.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>channels</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Source snap channels to use for this build.</p> <p>A dictionary mapping snap names to channels to use for this build. Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_arch_series_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_arch_series">distro_arch_series</a>. </td> <td> <p> The series and architecture to build on. </p> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>The pocket for which to build.</p> <p>The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.</p> </div> </td> </tr> <tr> <td> <p> <strong>requester_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who requested this build. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>revision_id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Revision ID</p> <p>The revision ID of the branch used for this build, if available.</p> </div> </td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Score of the related build farm job (if any). </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>snap_base_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_base">snap_base</a>. </td> <td> <p> The snap base to use for this build. </p> </td> </tr> <tr> <td> <p> <strong>snap_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap">snap</a>. </td> <td> <p> The snap package to build. </p> </td> </tr> <tr> <td> <p> <strong>store_upload_error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store upload error message</p> <p>The error message, if any, from the last attempt to upload this snap build to the store. (Deprecated; use store_upload_error_messages instead.)</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload_error_messages</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store upload error messages</p> <p>A list of dict(message, link) where message is an error description and link, if any, is an external link to extra details, from the last attempt to upload this snap build to the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload_revision</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store revision</p> <p>The revision assigned to this package by the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>store_upload_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unscheduled</tt> </li> <li> <tt>Pending</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Failed to release to channels</tt> </li> <li> <tt>Uploaded</tt> </li> </ul> </td> <td> <p> Store upload status </p> </td> </tr> <tr> <td> <p> <strong>store_upload_url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Store URL</p> <p>The URL to use for managing this package in the store.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_architectures</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The target architectures to build for. </p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="snap_build-standard-methods" title="snap_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="snap_build-custom-GETs" title="snap_build-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="snap_build-getFileUrls" title="snap_build-getFileUrls">getFileUrls</h5> <div> <p>URLs for all the files produced by this build.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this build.</td> </p> </div> </div> <div id="snap_build-custom-POSTs" title="snap_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="snap_build-cancel" title="snap_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="snap_build-rescore" title="snap_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="snap_build-retry" title="snap_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="snap_build-scheduleStoreUpload" title="snap_build-scheduleStoreUpload">scheduleStoreUpload</h5> <div> <p>Schedule an upload of this build to the store.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>scheduleStoreUpload</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="snap_build_request" title="snap_build_request">snap_build_request</h3> <p> A request to build a snap package. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/+snap/<var><snap.name></var>/+build-request/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap_build">snap_build</a> collection. </td> <td> <p> Builds produced by this request </p> </td> </tr> <tr> <td> <p> <strong>date_finished</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request finished </p> </td> </tr> <tr> <td> <p> <strong>date_requested</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time when this request was made </p> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Error message </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>snap_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#snap">snap</a>. </td> <td> <p> Snap package </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Completed</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="snap_build_request-standard-methods" title="snap_build_request-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="snappy_series" title="snappy_series">snappy_series</h3> <p> A series for snap packages in the store. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/+snappy-series/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>can_infer_distro_series</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Can infer distro series?</p> <p>True if inferring a distro series from snapcraft.yaml is supported for this snappy series.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Display name </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Name </p> </td> </tr> <tr> <td> <p> <strong>preferred_distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Preferred distro series </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who registered this snappy series.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Active Development</tt> </li> <li> <tt>Pre-release Freeze</tt> </li> <li> <tt>Current Stable Release</tt> </li> <li> <tt>Supported</tt> </li> <li> <tt>Obsolete</tt> </li> <li> <tt>Future</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>usable_distro_series</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Usable distro series</p> <p>The distro series that can be used for this snappy series.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="snappy_series-standard-methods" title="snappy_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="social_account" title="social_account">social_account</h3> <p> Social Account </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>identity</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Identity</p> <p>A dictionary with the identity attributes and values for the social account. The format is specific for each platform. Matrix account attributes: username, homeserver</p> </div> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>platform</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Matrix platform</tt> </li> </ul> </td> <td> <p> Social Platform Type </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="social_account-standard-methods" title="social_account-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="source_package" title="source_package">source_package</h3> <p> A source package associated to a particular distribution series. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution.name></var>/<var><distro_series.name></var>/+source/<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_reported_acknowledgement</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>After reporting a bug, I can expect the following.</p> <p>This message of acknowledgement will be displayed to anyone after reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>bug_reporting_guidelines</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Helpful guidelines for reporting a bug</p> <p>These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.</p> </div> </td> </tr> <tr> <td> <p> <strong>content_templates</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Templates to use for reporting a bug</p> <p>This pre-defined template will be given to the users to guide them when reporting a bug.</p> </div> </td> </tr> <tr> <td> <p> <strong>displayname</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Display name</p> <p>A displayname, constructed, for this package</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>The distribution for this source package.</p> </div> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution Series</p> <p>The DistroSeries for this SourcePackage</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>latest_published_component_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The name of the component in which the package was last published. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Name</p> <p>The text name of this source package.</p> </div> </td> </tr> <tr> <td> <p> <strong>official_bug_tags</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Official Bug Tags</p> <p>The list of bug tags defined as official.</p> </div> </td> </tr> <tr> <td> <p> <strong>productseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td> <div> <p>Project series</p> <p>The registered project series that this source package is based on. This series may be the same as the one that earlier versions of this source packages were based on.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="source_package-standard-methods" title="source_package-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="source_package-custom-GETs" title="source_package-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="source_package-getBranch" title="source_package-getBranch">getBranch</h5><div> <p>Get the official branch for this package in the given pocket.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranch</var></p></td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td><p> Pocket </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a>. </p> </div> <div class="method"><h5 id="source_package-getBranches" title="source_package-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="source_package-getMergeProposals" title="source_package-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="source_package-getTranslationImportQueueEntries" title="source_package-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="source_package-getTranslationTemplates" title="source_package-getTranslationTemplates">getTranslationTemplates</h5><div> <p>Return an iterator over all its translation templates.</p> <p>The returned templates are either obsolete or current.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationTemplates</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_template">translation_template</a> collection. </p> </div> <div class="method"> <h5 id="source_package-linkedBranches" title="source_package-linkedBranches">linkedBranches</h5> <div> <p>Get the official branches for this package.</p> <p>This operation returns a {Pocket-name : IBranch} dict.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkedBranches</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A {Pocket-name : IBranch} dict.</td> </p> </div> <div class="method"><h5 id="source_package-searchTasks" title="source_package-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <div id="source_package-custom-POSTs" title="source_package-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="source_package-deletePackaging" title="source_package-deletePackaging">deletePackaging</h5> <p> Delete the packaging for this sourcepackage. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>deletePackaging</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="source_package-newCodeImport" title="source_package-newCodeImport">newCodeImport</h5><div> <p>Create a new code import.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newCodeImport</var></p></td><td></td></tr><tr><td><p><strong>branch_name</strong></p></td><td><p></p></td><td><p> Name of branch to create </p></td></tr><tr><td><p><strong>cvs_module</strong></p></td><td><p></p></td><td><p> CVS module to import </p></td></tr><tr><td><p><strong>cvs_root</strong></p></td><td><p></p></td><td><p> CVS root URL </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Owner of the resulting branch </p></td></tr><tr><td><p><strong>rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Concurrent Versions System</tt></li><li><tt>Subversion via CSCVS</tt></li><li><tt>Subversion via bzr-svn</tt></li><li><tt>Git</tt></li><li><tt>Mercurial</tt></li><li><tt>Bazaar</tt></li></ul></td><td></td></tr><tr><td><p><strong>target_rcs_type</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Bazaar</tt></li><li><tt>Git</tt></li></ul></td><td></td></tr><tr><td><p><strong>url</strong></p></td><td><p></p></td><td><p> Foreign VCS URL </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#code_import">code_import</a>. </p> </div> <div class="method"> <h5 id="source_package-setBranch" title="source_package-setBranch">setBranch</h5> <div> <p>Set the official branch for the given pocket of this package.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setBranch</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch</strong> </p> </td> <td><p></p> Link to a <a href="#branch">branch</a>. </td> <td> <p> Branch </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <p> Pocket </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">None</td> </p> </div> <div class="method"> <h5 id="source_package-setPackaging" title="source_package-setPackaging">setPackaging</h5> <p> Update the existing packaging record, or create a new packaging record, that links the source package to the given productseries, and record that it was done by the owner. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setPackaging</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>productseries</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="source_package_publishing_history" title="source_package_publishing_history">source_package_publishing_history</h3> <p> A source package publishing history record. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><distribution></var>/+archive/<var><name></var>/+sourcepub/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Archive ID </p> </td> </tr> <tr> <td> <p> <strong>component_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Component Name </p> </td> </tr> <tr> <td> <p> <strong>copied_from_archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> Original archive ID where this package was copied from. </p> </td> </tr> <tr> <td> <p> <strong>creator_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Publication Creator</p> <p>The IPerson who created this publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record was created </p> </td> </tr> <tr> <td> <p> <strong>date_made_pending</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record was set as pending removal </p> </td> </tr> <tr> <td> <p> <strong>date_published</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record was published </p> </td> </tr> <tr> <td> <p> <strong>date_removed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record was removed from the published set </p> </td> </tr> <tr> <td> <p> <strong>date_superseded</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record was marked superseded </p> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Text representation of the current record.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> The distro series being published into </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>package_creator_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Package Creator</p> <p>The IPerson who created the source package.</p> </div> </td> </tr> <tr> <td> <p> <strong>package_maintainer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Package Maintainer</p> <p>The IPerson who maintains the source package.</p> </div> </td> </tr> <tr> <td> <p> <strong>package_signer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Package Signer</p> <p>The IPerson who signed the source package.</p> </div> </td> </tr> <tr> <td> <p> <strong>packageupload_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#package_upload">package_upload</a>. </td> <td> <div> <p>Package upload</p> <p>The Package Upload that caused the creation of this publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The pocket into which this entry is published</p> </div> </td> </tr> <tr> <td> <p> <strong>removal_comment</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Reason why this publication is going to be removed. </p> </td> </tr> <tr> <td> <p> <strong>removed_by_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The IPerson responsible for the removal </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>scheduled_deletion_date</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date on which this record is scheduled for deletion </p> </td> </tr> <tr> <td> <p> <strong>section_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Section Name </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>source_package_name</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source Package Name </p> </td> </tr> <tr> <td> <p> <strong>source_package_version</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Source Package Version </p> </td> </tr> <tr> <td> <p> <strong>sponsor_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Publication sponsor</p> <p>The IPerson who sponsored the creation of this publication.</p> </div> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Pending</tt> </li> <li> <tt>Published</tt> </li> <li> <tt>Superseded</tt> </li> <li> <tt>Deleted</tt> </li> <li> <tt>Obsolete</tt> </li> </ul> </td> <td> <div> <p>Package Publishing Status</p> <p>The status of this publishing record</p> </div> </td> </tr> </table> </div> <div id="source_package_publishing_history-standard-methods" title="source_package_publishing_history-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="source_package_publishing_history-custom-GETs" title="source_package_publishing_history-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="source_package_publishing_history-binaryFileUrls" title="source_package_publishing_history-binaryFileUrls">binaryFileUrls</h5> <div> <p>URLs for this source publication's binary files.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>binaryFileUrls</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this source.</td> </p> </div> <div class="method"> <h5 id="source_package_publishing_history-changelogUrl" title="source_package_publishing_history-changelogUrl">changelogUrl</h5> <div> <p>The URL for this source package release's changelog.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>changelogUrl</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">the changelog file URL for this source (a string).</td> </p> </div> <div class="method"> <h5 id="source_package_publishing_history-changesFileUrl" title="source_package_publishing_history-changesFileUrl">changesFileUrl</h5> <div> <p>The .changes file URL for this source publication.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>changesFileUrl</var></p> </td> <td></td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">the .changes file URL for this source (a string).</td> </p> </div> <div class="method"><h5 id="source_package_publishing_history-getBuilds" title="source_package_publishing_history-getBuilds">getBuilds</h5><div> <p>Return a list of IBuild objects in this publishing context.</p> <p>The builds are ordered by DistroArchSeries.architecturetag.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBuilds</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#build">build</a> collection. </p> </div> <div class="method"><h5 id="source_package_publishing_history-getPublishedBinaries" title="source_package_publishing_history-getPublishedBinaries">getPublishedBinaries</h5><div> <p>Return all resulted IBinaryPackagePublishingHistory.</p> <p>Follow the build record and return every binary publishing record for any DistroArchSeries in this DistroSeries and in the same IArchive and Pocket, ordered by architecture tag. If active_binaries_only is True (the default), then only return PUBLISHED or PENDING binary publishing records.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPublishedBinaries</var></p></td><td></td></tr><tr><td><p><strong>active_binaries_only</strong></p></td><td><p></p></td><td><p> Only return active publications </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#binary_package_publishing_history">binary_package_publishing_history</a> collection. </p> </div> <div class="method"> <h5 id="source_package_publishing_history-hasRestrictedFiles" title="source_package_publishing_history-hasRestrictedFiles">hasRestrictedFiles</h5> <p> Return whether or not a given source files has restricted files. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>hasRestrictedFiles</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="source_package_publishing_history-packageDiffUrl" title="source_package_publishing_history-packageDiffUrl">packageDiffUrl</h5> <div> <p>URL of the debdiff file between this and the supplied version.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>packageDiffUrl</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>to_version</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> To Version </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A URL to the librarian file containing the diff.</td> </p> </div> <div class="method"> <h5 id="source_package_publishing_history-sourceFileUrls" title="source_package_publishing_history-sourceFileUrls">sourceFileUrls</h5> <div> <p>URLs for this source publication's uploaded source files.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>sourceFileUrls</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>include_meta</strong> </p> </td> <td> <p></p> </td> <td> <p> Include Metadata </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A collection of URLs for this source.</td> </p> </div> </div> <div id="source_package_publishing_history-custom-POSTs" title="source_package_publishing_history-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="source_package_publishing_history-changeOverride" title="source_package_publishing_history-changeOverride">changeOverride</h5><div> <p>Change the component and/or section of this publication.</p> <p>It is changed only if the argument is not None.</p> <p>Return the overridden publishing record, a ISourcePackagePublishingHistory.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>changeOverride</var></p></td><td></td></tr><tr><td><p><strong>new_component</strong></p></td><td><p></p></td><td><p> The new component name. </p></td></tr><tr><td><p><strong>new_section</strong></p></td><td><p></p></td><td><p> The new section name. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_publishing_history">source_package_publishing_history</a>. </p> </div> <div class="method"> <h5 id="source_package_publishing_history-requestDeletion" title="source_package_publishing_history-requestDeletion">requestDeletion</h5> <div> <p>Delete this source and its binaries.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>requestDeletion</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>removal_comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Removal comment </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="source_package_recipe" title="source_package_recipe">source_package_recipe</h3> <div> <p>An ISourcePackageRecipe describes how to build a source package.</p> <p>More precisely, it describes how to combine a number of branches into a debianized source tree.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>base_branch_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <p> The base branch used by this recipe. </p> </td> </tr> <tr> <td> <p> <strong>base_git_repository_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#git_repository">git_repository</a>. </td> <td> <p> The base Git repository used by this recipe. </p> </td> </tr> <tr> <td> <p> <strong>build_daily</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Built daily</p> <p>Automatically build each day, if the source has changed.</p> </div> </td> </tr> <tr> <td> <p> <strong>builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe_build">source_package_recipe_build</a> collection. </td> <td> <div> <p>All builds of this recipe.</p> <p>All builds of this recipe, sorted in descending order of finishing (or starting if notcompleted successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>completed_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe_build">source_package_recipe_build</a> collection. </td> <td> <div> <p>The completed builds of this recipe.</p> <p>Completed builds of this recipe, sorted in descending order of finishing (or starting if notcompleted successfully).</p> </div> </td> </tr> <tr> <td> <p> <strong>daily_build_archive_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <p> The archive to use for daily builds. </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>deb_version_template</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>deb-version template</p> <p>The template that will be used to generate a deb version.</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>A short description of the recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>distroseries</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Default distribution series</p> <p>If built daily, these are the distribution versions that the recipe will be built for.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_stale</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Recipe is stale. </p> </td> </tr> <tr> <td> <p> <strong>last_build_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe_build">source_package_recipe_build</a>. </td> <td> <p> The the most recent build of this recipe. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the recipe is part of the URL and needs to be unique for the given owner.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The person or team who can edit this recipe.</p> </div> </td> </tr> <tr> <td> <p> <strong>pending_builds_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe_build">source_package_recipe_build</a> collection. </td> <td> <div> <p>The pending builds of this recipe.</p> <p>Pending builds of this recipe, sorted in descending order of creation.</p> </div> </td> </tr> <tr> <td> <p> <strong>recipe_text</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who created this recipe. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="source_package_recipe-standard-methods" title="source_package_recipe-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="source_package_recipe-custom-GETs" title="source_package_recipe-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="source_package_recipe-getPendingBuildInfo" title="source_package_recipe-getPendingBuildInfo">getPendingBuildInfo</h5> <div> <p>Find distroseries and archive data for pending builds.</p> <p>Return a list of dict( distroseries:distroseries.displayname archive:archive.token) The archive reference is as defined by the archive vocab. This information is used to construct the request builds popup form.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getPendingBuildInfo</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="source_package_recipe-custom-POSTs" title="source_package_recipe-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="source_package_recipe-performDailyBuild" title="source_package_recipe-performDailyBuild">performDailyBuild</h5> <p> Perform a build into the daily build archive. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>performDailyBuild</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="source_package_recipe-requestBuild" title="source_package_recipe-requestBuild">requestBuild</h5><div> <p>Request that the recipe be built in to the specified archive.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>requestBuild</var></p></td><td></td></tr><tr><td><p><strong>archive</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>pocket</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Release</tt></li><li><tt>Security</tt></li><li><tt>Updates</tt></li><li><tt>Proposed</tt></li><li><tt>Backports</tt></li></ul></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_recipe_build">source_package_recipe_build</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="source_package_recipe_build" title="source_package_recipe_build">source_package_recipe_build</h3> <p> A build of a source package. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Archive</p> <p>The Archive context for this build.</p> </div> </td> </tr> <tr> <td> <p> <strong>build_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Build Log URL</p> <p>A URL for the build log. None if there is no log available.</p> </div> </td> </tr> <tr> <td> <p> <strong>builder_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#builder">builder</a>. </td> <td> <div> <p>Builder</p> <p>The builder assigned to this job.</p> </div> </td> </tr> <tr> <td> <p> <strong>buildstate</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs building</tt> </li> <li> <tt>Successfully built</tt> </li> <li> <tt>Failed to build</tt> </li> <li> <tt>Dependency wait</tt> </li> <li> <tt>Chroot problem</tt> </li> <li> <tt>Build for superseded Source</tt> </li> <li> <tt>Currently building</tt> </li> <li> <tt>Failed to upload</tt> </li> <li> <tt>Uploading build</tt> </li> <li> <tt>Cancelling build</tt> </li> <li> <tt>Cancelled build</tt> </li> <li> <tt>Gathering build output</tt> </li> </ul> </td> <td> <div> <p>Status</p> <p>The current status of the job.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_cancelled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be cancelled</p> <p>Whether this build record can be cancelled.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_rescored</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be rescored</p> <p>Whether this build record can be rescored manually.</p> </div> </td> </tr> <tr> <td> <p> <strong>can_be_retried</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Can be retried</p> <p>Whether this build record can be retried.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_first_dispatched</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date started</p> <p>The timestamp when the build farm job was started.</p> </div> </td> </tr> <tr> <td> <p> <strong>datebuilt</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date finished</p> <p>The timestamp when the build farm job was finished.</p> </div> </td> </tr> <tr> <td> <p> <strong>datecreated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date created</p> <p>The timestamp when the build farm job was created.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Dependencies</p> <p>Debian-like dependency line that must be satisfied before attempting to build this request.</p> </div> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <div> <p>Distribution</p> <p>Shortcut for its distribution.</p> </div> </td> </tr> <tr> <td> <p> <strong>distro_series_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <div> <p>Distribution series</p> <p>Shortcut for its distribution series.</p> </div> </td> </tr> <tr> <td> <p> <strong>duration</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Duration</p> <p>Duration interval, calculated when the result gets collected.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>pocket</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Release</tt> </li> <li> <tt>Security</tt> </li> <li> <tt>Updates</tt> </li> <li> <tt>Proposed</tt> </li> <li> <tt>Backports</tt> </li> </ul> </td> <td> <div> <p>Pocket</p> <p>The build targeted pocket.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Title </p> </td> </tr> <tr> <td> <p> <strong>upload_log_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Upload Log URL</p> <p>A URL for failed upload logs.Will be None if there was no failure.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="source_package_recipe_build-standard-methods" title="source_package_recipe_build-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="source_package_recipe_build-custom-POSTs" title="source_package_recipe_build-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="source_package_recipe_build-cancel" title="source_package_recipe_build-cancel">cancel</h5> <div> <p>Cancel the build if it is either pending or in progress.</p> <p>Check the can_be_cancelled property prior to calling this method to find out if cancelling the build is possible.</p> <p>If the build is in progress, it is marked as CANCELLING until the buildd manager terminates the build and marks it CANCELLED. If the build is not in progress, it is marked CANCELLED immediately and is removed from the build queue.</p> <p>If the build is not in a cancellable state, this method is a no-op.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>cancel</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="source_package_recipe_build-rescore" title="source_package_recipe_build-rescore">rescore</h5> <p> Change the build's score. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>rescore</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>score</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Score </p> </td> </tr> </table> </div> <div class="method"> <h5 id="source_package_recipe_build-retry" title="source_package_recipe_build-retry">retry</h5> <div> <p>Restore the build record to its initial state.</p> <p>Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="specification" title="specification">specification</h3> <p> A Specification. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+spec/<var><specification.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>approver_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Approver</p> <p>The person responsible for approving the specification, and for reviewing the code when it's ready to be landed.</p> </div> </td> </tr> <tr> <td> <p> <strong>assignee_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Assignee</p> <p>The person responsible for implementing the feature.</p> </div> </td> </tr> <tr> <td> <p> <strong>bugs_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug">bug</a> collection. </td> <td> <p> Bugs related to this object. </p> </td> </tr> <tr> <td> <p> <strong>completer_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Starter</p> <p>The person who finally set the state of the spec to the values that we consider mark it as complete.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_completed</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Completed</p> <p>The date when this spec was marked complete. Note that complete also includes "obsolete" and superseded. Essentially, it is the state where no more work will be done on the feature.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>date_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date Started</p> <p>The date when this spec was marked started.</p> </div> </td> </tr> <tr> <td> <p> <strong>definition_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Approved</tt> </li> <li> <tt>Pending Approval</tt> </li> <li> <tt>Review</tt> </li> <li> <tt>Drafting</tt> </li> <li> <tt>Discussion</tt> </li> <li> <tt>New</tt> </li> <li> <tt>Superseded</tt> </li> <li> <tt>Obsolete</tt> </li> </ul> </td> <td> <div> <p>Definition Status</p> <p>The current status of the process to define the feature and get approval for the implementation plan.</p> </div> </td> </tr> <tr> <td> <p> <strong>dependencies_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <p> Specs on which this one depends. </p> </td> </tr> <tr> <td> <p> <strong>direction_approved</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Basic direction approved?</p> <p>Check this to indicate that the drafter and assignee have satisfied the approver that they are headed in the right basic direction with this specification.</p> </div> </td> </tr> <tr> <td> <p> <strong>drafter_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Drafter</p> <p>The person responsible for drafting the specification.</p> </div> </td> </tr> <tr> <td> <p> <strong>has_accepted_goal</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Series goal is accepted</p> <p>Is true if this specification has been proposed as a goal for a specific series, and the drivers of that series have accepted the goal.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>implementation_status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Not started</tt> </li> <li> <tt>Deferred</tt> </li> <li> <tt>Needs Infrastructure</tt> </li> <li> <tt>Blocked</tt> </li> <li> <tt>Started</tt> </li> <li> <tt>Slow progress</tt> </li> <li> <tt>Good progress</tt> </li> <li> <tt>Beta Available</tt> </li> <li> <tt>Needs Code Review</tt> </li> <li> <tt>Deployment</tt> </li> <li> <tt>Implemented</tt> </li> <li> <tt>Informational</tt> </li> </ul> </td> <td> <div> <p>Implementation Status</p> <p>The state of progress being made on the actual implementation or delivery of this feature.</p> </div> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information Type</p> <p>The type of information contained in this specification.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_complete</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Is started</p> <p>Is True if this spec is already completely implemented. Note that it is True for informational specs, since they describe general functionality rather than specific code to be written. It is also true of obsolete and superseded specs, since there is no longer any need to schedule work for them.</p> </div> </td> </tr> <tr> <td> <p> <strong>is_started</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Is started</p> <p>Is True if the spec is in a state which we consider to be "started". This looks at the delivery attribute, and also considers informational specs to be started when they are approved.</p> </div> </td> </tr> <tr> <td> <p> <strong>lifecycle_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Not started</tt> </li> <li> <tt>Started</tt> </li> <li> <tt>Complete</tt> </li> </ul> </td> <td> <p> Lifecycle Status </p> </td> </tr> <tr> <td> <p> <strong>linked_branches_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification_branch">specification_branch</a> collection. </td> <td> <p> Branches associated with this spec, usually branches on which this spec is being implemented. </p> </td> </tr> <tr> <td> <p> <strong>milestone_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#milestone">milestone</a>. </td> <td> <div> <p>Milestone</p> <p>The milestone in which we would like this feature to be delivered.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>May contain lower-case letters, numbers, and dashes. It will be used in the specification url. Examples: mozilla-type-ahead-find, postgres-smart-serial.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>priority</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Not</tt> </li> <li> <tt>Undefined</tt> </li> <li> <tt>Low</tt> </li> <li> <tt>Medium</tt> </li> <li> <tt>High</tt> </li> <li> <tt>Essential</tt> </li> </ul> </td> <td> <p> Priority </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>specification_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Specification URL</p> <p>The URL of the specification. This is usually a wiki page.</p> </div> </td> </tr> <tr> <td> <p> <strong>starter_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Starter</p> <p>The person who first set the state of the spec to the values that we consider mark it as started.</p> </div> </td> </tr> <tr> <td> <p> <strong>summary</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Summary</p> <p>A single-paragraph description of the feature. This will also be displayed in most feature listings.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#specification_target">specification_target</a>. </td> <td> <div> <p>For</p> <p>The project for which this proposal is being made.</p> </div> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>Describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>whiteboard</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Status Whiteboard</p> <p>Any notes on the status of this spec you would like to make. Your changes will override the current text.</p> </div> </td> </tr> <tr> <td> <p> <strong>workitems_text</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Work Items</p> <p>Work items for this specification input in a text format. Your changes will override the current work items.</p> </div> </td> </tr> </table> </div> <div id="specification-standard-methods" title="specification-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="specification-custom-POSTs" title="specification-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="specification-acceptGoal" title="specification-acceptGoal">acceptGoal</h5> <p> Mark the spec as being accepted for its current series goal. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>acceptGoal</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-declineGoal" title="specification-declineGoal">declineGoal</h5> <p> Mark the spec as being declined as a goal for the proposed series. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>declineGoal</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-linkBranch" title="specification-linkBranch">linkBranch</h5> <div> <p>Associate a branch with this bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkBranch</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch">branch</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-linkBug" title="specification-linkBug">linkBug</h5> <div> <p>Link a bug to this specification.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>linkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-proposeGoal" title="specification-proposeGoal">proposeGoal</h5> <p> Propose this spec for a series or distroseries. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>proposeGoal</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>goal</strong> </p> </td> <td><p></p> Link to a <a href="#bug_target">bug_target</a>. </td> <td> <p> Target </p> </td> </tr> </table> </div> <div class="method"> <h5 id="specification-subscribe" title="specification-subscribe">subscribe</h5> <p> Subscribe this person to the feature specification. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>subscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>essential</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Participation essential</p> <p>Check this if participation in the design of the feature is essential.</p> </div> </td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> <div class="method"> <h5 id="specification-unlinkBranch" title="specification-unlinkBranch">unlinkBranch</h5> <div> <p>Unlink a branch from this bug.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkBranch</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>branch</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#branch">branch</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-unlinkBug" title="specification-unlinkBug">unlinkBug</h5> <div> <p>Unlink a bug to this specification.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unlinkBug</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>bug</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#bug">bug</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="specification-unsubscribe" title="specification-unsubscribe">unsubscribe</h5> <p> Remove the person's subscription to this spec. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>unsubscribe</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="specification_branch" title="specification_branch">specification_branch</h3> <p> A branch linked to a specification. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+spec/<var><specification.name></var>/+branch/<var><branch.unique_name[1:]></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>branch_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#branch">branch</a>. </td> <td> <p> Branch </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who linked the bug to the branch </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>specification_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a>. </td> <td> <p> Blueprint </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="specification_branch-standard-methods" title="specification_branch-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="specification_branch-custom-POSTs" title="specification_branch-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="specification_branch-delete" title="specification_branch-delete">delete</h5> <p> Destroy this specification branch link </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>delete</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="specification_subscription" title="specification_subscription">specification_subscription</h3> <p> A subscription for a person to a specification. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><target.name></var>/+spec/<var><specification.name></var>/+subscription/<var><person.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> </table> </div> <div id="specification_subscription-standard-methods" title="specification_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="specification_subscription-custom-GETs" title="specification_subscription-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="specification_subscription-canBeUnsubscribedByUser" title="specification_subscription-canBeUnsubscribedByUser">canBeUnsubscribedByUser</h5> <p> Can the user unsubscribe the subscriber from the specification? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>canBeUnsubscribedByUser</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="specification_target" title="specification_target">specification_target</h3> <p> An interface for the objects which actually have unique specifications directly attached to them. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="specification_target-standard-methods" title="specification_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="specification_target-custom-GETs" title="specification_target-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="specification_target-getSpecification" title="specification_target-getSpecification">getSpecification</h5><p> Returns the specification with the given name, for this target, or None. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSpecification</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td><p> The name of the specification </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#specification">specification</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="ssh_key" title="ssh_key">ssh_key</h3> <p> SSH public key </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/<var><person.name></var>/+ssh-keys/<var><keyid></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Comment describing this key </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>keytext</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Key text </p> </td> </tr> <tr> <td> <p> <strong>keytype</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>RSA</tt> </li> <li> <tt>DSA</tt> </li> <li> <tt>ECDSA</tt> </li> <li> <tt>ED25519</tt> </li> </ul> </td> <td> <p> Key type </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="ssh_key-standard-methods" title="ssh_key-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="ssh_key-custom-GETs" title="ssh_key-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="ssh_key-getFullKeyText" title="ssh_key-getFullKeyText">getFullKeyText</h5> <p> Get the full text of the SSH key. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getFullKeyText</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="structural_subscription" title="structural_subscription">structural_subscription</h3> <p> A subscription to a Launchpad structure. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>bug_filters_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#bug_subscription_filter">bug_subscription_filter</a> collection. </td> <td> <p> List of bug filters that narrow this subscription. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The date on which this subscription was created. </p> </td> </tr> <tr> <td> <p> <strong>date_last_updated</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The date on which this subscription was last updated. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>subscribed_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscribed by</p> <p>The person creating the subscription.</p> </div> </td> </tr> <tr> <td> <p> <strong>subscriber_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Subscriber</p> <p>The person subscribed.</p> </div> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#structural_subscription_target">structural_subscription_target</a>. </td> <td> <p> The structure to which this subscription belongs. </p> </td> </tr> </table> </div> <div id="structural_subscription-standard-methods" title="structural_subscription-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="structural_subscription-custom-POSTs" title="structural_subscription-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="structural_subscription-newBugFilter" title="structural_subscription-newBugFilter">newBugFilter</h5><p> Returns a new BugSubscriptionFilter for this subscription. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newBugFilter</var></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="structural_subscription_target" title="structural_subscription_target">structural_subscription_target</h3> <p> A Launchpad Structure allowing users to subscribe to it. </p> <p> <label>URL:</label> <code> <em>depends on the underlying entry</em> </code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="structural_subscription_target-standard-methods" title="structural_subscription_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="structural_subscription_target-custom-GETs" title="structural_subscription_target-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"><h5 id="structural_subscription_target-getSubscription" title="structural_subscription_target-getSubscription">getSubscription</h5><p> Return the subscription for person, if it exists. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscription</var></p></td><td></td></tr><tr><td><p><strong>person</strong></p></td><td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="structural_subscription_target-getSubscriptions" title="structural_subscription_target-getSubscriptions">getSubscriptions</h5><div> <p>Return all the subscriptions with the specified levels.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#structural_subscription">structural_subscription</a> collection. </p> </div> <div class="method"> <h5 id="structural_subscription_target-userHasBugSubscriptions" title="structural_subscription_target-userHasBugSubscriptions">userHasBugSubscriptions</h5> <p> Is user subscribed, directly or via a team, to bug mail? </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>userHasBugSubscriptions</var></p> </td> <td></td> </tr> </table> </div> </div> <div id="structural_subscription_target-custom-POSTs" title="structural_subscription_target-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="structural_subscription_target-addBugSubscription" title="structural_subscription_target-addBugSubscription">addBugSubscription</h5><div> <p>Add a bug subscription for this structure.</p> <p>This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscription</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#structural_subscription">structural_subscription</a>. </p> </div> <div class="method"><h5 id="structural_subscription_target-addBugSubscriptionFilter" title="structural_subscription_target-addBugSubscriptionFilter">addBugSubscriptionFilter</h5><div> <p>Add a bug subscription filter for this structure.</p> <p>This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>addBugSubscriptionFilter</var></p></td><td></td></tr><tr><td><p><strong>subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td><p> Person to subscribe. If omitted, the requesting user will be subscribed. </p></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#bug_subscription_filter">bug_subscription_filter</a>. </p> </div> <div class="method"> <h5 id="structural_subscription_target-removeBugSubscription" title="structural_subscription_target-removeBugSubscription">removeBugSubscription</h5> <div> <p>Remove a subscription to bugs from this structure.</p> <p>This will delete all associated filters.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeBugSubscription</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>subscriber</strong> </p> </td> <td><p></p> Link to a <a href="#person">person</a>. </td> <td> <p> Person to unsubscribe. If omitted, the requesting user will be unsubscribed. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="team" title="team">team</h3> <div> <p>A group of people and other teams.</p> <p>Launchpadlib example of getting the date a user joined a team:</p> <pre class="rst-literal-block"> def get_join_date(team, user): team = launchpad.people[team] members = team.members_details for member in members: if member.member.name == user: return member.date_joined return None </pre> <p>Implementation notes:</p> <ul class="rst-simple"> <li>ITeam extends IPerson.</li> <li>The teamowner should never be None.</li> </ul> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>account_status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Placeholder</tt> </li> <li> <tt>Unactivated</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Suspended</tt> </li> <li> <tt>Closed</tt> </li> <li> <tt>Deceased</tt> </li> </ul> </td> <td> <p> The status of this person's account </p> </td> </tr> <tr> <td> <p> <strong>account_status_history</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Account status history </p> </td> </tr> <tr> <td> <p> <strong>admins_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> List of this team's admins. </p> </td> </tr> <tr> <td> <p> <strong>all_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>All specifications</p> <p>A list of all specifications, regardless of status or approval or completion, for this object.</p> </div> </td> </tr> <tr> <td> <p> <strong>archive_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a>. </td> <td> <div> <p>Default PPA</p> <p>The PPA named 'ppa' owned by this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>confirmed_email_addresses_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#email_address">email_address</a> collection. </td> <td> <div> <p>Confirmed emails of this person.</p> <p>Confirmed emails are the ones in the VALIDATED state</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date Created </p> </td> </tr> <tr> <td> <p> <strong>deactivated_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Former members of the team. </p> </td> </tr> <tr> <td> <p> <strong>default_membership_period</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Subscription period</p> <p>Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.</p> </div> </td> </tr> <tr> <td> <p> <strong>default_renewal_period</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Self renewal period</p> <p>Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).</p> </div> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.</p> </div> </td> </tr> <tr> <td> <p> <strong>display_name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Display Name</p> <p>Your name as you would like it displayed throughout Launchpad. Most people use their full name here.</p> </div> </td> </tr> <tr> <td> <p> <strong>expired_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Expired members of the team. </p> </td> </tr> <tr> <td> <p> <strong>gpg_keys_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#gpg_key">gpg_key</a> collection. </td> <td> <p> List of valid OpenPGP keys ordered by ID </p> </td> </tr> <tr> <td> <p> <strong>hide_email_addresses</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Hide my email addresses from other Launchpad users </p> </td> </tr> <tr> <td> <p> <strong>homepage_content</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Homepage Content</p> <p>Obsolete. Use description.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>ID</p> <p>Internal immutable identifier for this person. Only visible by privileged users.</p> </div> </td> </tr> <tr> <td> <p> <strong>invited_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> Other teams which have been invited to become members of this team. </p> </td> </tr> <tr> <td> <p> <strong>irc_nicknames_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#irc_id">irc_id</a> collection. </td> <td> <p> List of IRC nicknames of this Person. </p> </td> </tr> <tr> <td> <p> <strong>is_probationary</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Is this a probationary user? </p> </td> </tr> <tr> <td> <p> <strong>is_team</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Is this object a team? </p> </td> </tr> <tr> <td> <p> <strong>is_ubuntu_coc_signer</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Signed Ubuntu Code of Conduct </p> </td> </tr> <tr> <td> <p> <strong>is_valid</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> This is an active user or a team. </p> </td> </tr> <tr> <td> <p> <strong>jabber_ids_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#jabber_id">jabber_id</a> collection. </td> <td> <p> List of Jabber IDs of this Person. </p> </td> </tr> <tr> <td> <p> <strong>karma</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Karma</p> <p>The cached total karma for this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>languages_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#language">language</a> collection. </td> <td> <p> List of languages known by this person </p> </td> </tr> <tr> <td> <p> <strong>logo_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Logo</p> <p>An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>mailing_list_auto_subscribe_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Never subscribe to mailing lists</tt> </li> <li> <tt>Ask me when I join a team</tt> </li> <li> <tt>Always subscribe me to mailing lists</tt> </li> </ul> </td> <td> <div> <p>Mailing List Auto-subscription Policy</p> <p>This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.</p> </div> </td> </tr> <tr> <td> <p> <strong>members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> List of direct members with ADMIN or APPROVED status </p> </td> </tr> <tr> <td> <p> <strong>members_details_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <div> <p>Active TeamMemberships for this object's members.</p> <p>Active TeamMemberships are the ones with the ADMIN or APPROVED status. The results are ordered using Person.sortingColumns.</p> </div> </td> </tr> <tr> <td> <p> <strong>membership_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open Team</tt> </li> <li> <tt>Delegated Team</tt> </li> <li> <tt>Moderated Team</tt> </li> <li> <tt>Restricted Team</tt> </li> </ul> </td> <td> <div> <p>Membership policy</p> <p>The policies that describe who can be a member. The choice of policy reflects the need to build a community (inclusive) versus the need to control Launchpad projects, branches, and PPAs (exclusive).</p> </div> </td> </tr> <tr> <td> <p> <strong>memberships_details_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <p> All TeamMemberships for Teams this Team or Person is an active member of. </p> </td> </tr> <tr> <td> <p> <strong>mugshot_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a file resource. </td> <td> <div> <p>Mugshot</p> <p>A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.</p> </div> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.</p> </div> </td> </tr> <tr> <td> <p> <strong>open_membership_invitations_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team_membership">team_membership</a> collection. </td> <td> <div> <p>Open membership invitations.</p> <p>All TeamMemberships which represent an invitation (to join a team) sent to this person.</p> </div> </td> </tr> <tr> <td> <p> <strong>participants_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <div> <p>All participants of this team.</p> <p>List of all direct and indirect people and teams who, one way or another, are a part of this team. If you want a method to check if a given person is a member of a team, you should probably look at IPerson.inTeam().</p> </div> </td> </tr> <tr> <td> <p> <strong>ppas_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#archive">archive</a> collection. </td> <td> <div> <p>PPAs for this person.</p> <p>PPAs owned by the context person ordered by name.</p> </div> </td> </tr> <tr> <td> <p> <strong>preferred_email_address_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#email_address">email_address</a>. </td> <td> <div> <p>Preferred email address</p> <p>The preferred email address for this person. The one we'll use to communicate with them.</p> </div> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>This team is private</p> <p>Private teams are visible only to their members.</p> </div> </td> </tr> <tr> <td> <p> <strong>proposed_members_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a> collection. </td> <td> <p> People who have applied to join the team. </p> </td> </tr> <tr> <td> <p> <strong>recipes_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package_recipe">source_package_recipe</a> collection. </td> <td> <p> All recipes associated with the object. </p> </td> </tr> <tr> <td> <p> <strong>renewal_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>invite them to apply for renewal</tt> </li> <li> <tt>invite them to renew their own membership</tt> </li> </ul> </td> <td> <p> When someone's membership is about to expire, notify them and </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>social_accounts_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#social_account">social_account</a> collection. </td> <td> <p> List of Social Accounts of this Person. </p> </td> </tr> <tr> <td> <p> <strong>sshkeys_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#ssh_key">ssh_key</a> collection. </td> <td> <p> List of SSH keys </p> </td> </tr> <tr> <td> <p> <strong>sub_teams_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team">team</a> collection. </td> <td> <div> <p>All subteams of this team.</p> <p>A subteam is any team that is a member (either directly or indirectly) of this team. As an example, let's say we have this hierarchy of teams:</p> <dl class="rst-docutils"> <dt>Rosetta Translators</dt> <dd><dl class="rst-first rst-last rst-docutils"> <dt>Rosetta pt Translators</dt> <dd>Rosetta pt_BR Translators</dd> </dl> </dd> </dl> <p>In this case, both 'Rosetta pt Translators' and 'Rosetta pt_BR Translators' are subteams of the 'Rosetta Translators' team, and all members of both subteams are considered members of "Rosetta Translators".</p> </div> </td> </tr> <tr> <td> <p> <strong>subscription_policy</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Open Team</tt> </li> <li> <tt>Delegated Team</tt> </li> <li> <tt>Moderated Team</tt> </li> <li> <tt>Restricted Team</tt> </li> </ul> </td> <td> <div> <p>Membership policy</p> <p>Obsolete: use membership_policy</p> </div> </td> </tr> <tr> <td> <p> <strong>super_teams_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#team">team</a> collection. </td> <td> <div> <p>All superteams of this team.</p> <p>A superteam is any team that this team is a member of. For example, let's say we have this hierarchy of teams, and we are the "Rosetta pt_BR Translators":</p> <dl class="rst-docutils"> <dt>Rosetta Translators</dt> <dd><dl class="rst-first rst-last rst-docutils"> <dt>Rosetta pt Translators</dt> <dd>Rosetta pt_BR Translators</dd> </dl> </dd> </dl> <p>In this case, we will return both 'Rosetta pt Translators' and 'Rosetta Translators', because we are member of both of them.</p> </div> </td> </tr> <tr> <td> <p> <strong>team_description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Team Description</p> <p>Obsolete. Use description.</p> </div> </td> </tr> <tr> <td> <p> <strong>team_owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team Owner </p> </td> </tr> <tr> <td> <p> <strong>time_zone</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The time zone of this object. </p> </td> </tr> <tr> <td> <p> <strong>valid_specifications_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#specification">specification</a> collection. </td> <td> <div> <p>Valid specifications</p> <p>All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal</p> </div> </td> </tr> <tr> <td> <p> <strong>visibility</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Private</tt> </li> </ul> </td> <td> <div> <p>Visibility</p> <p>Anyone can see a public team's data. Only team members can see private team data.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>wiki_names_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#wiki_name">wiki_name</a> collection. </td> <td> <p> All WikiNames of this Person, sorted alphabetically by URL. </p> </td> </tr> </table> </div> <div id="team-standard-methods" title="team-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="team-custom-GETs" title="team-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="team-getArchiveSubscriptionURLs" title="team-getArchiveSubscriptionURLs">getArchiveSubscriptionURLs</h5> <div> <p>Return private archive URLs that this person can see.</p> <p>For each of the private archives (PPAs) that this person can see, return a URL that includes the HTTP basic auth data. The URL returned is suitable for including in a sources.list file.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getArchiveSubscriptionURLs</var></p> </td> <td></td> </tr> </table> </div> <div class="method"><h5 id="team-getArchiveSubscriptions" title="team-getArchiveSubscriptions">getArchiveSubscriptions</h5><p> Return (private) archives subscription for this person. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getArchiveSubscriptions</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive_subscriber">archive_subscriber</a> collection. </p> </div> <div class="method"><h5 id="team-getBranches" title="team-getBranches">getBranches</h5><div> <p>Returns all branches with the given lifecycle status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBranches</var></p></td><td></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Limit the branches to those modified since this date. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of branch lifecycle statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch">branch</a> collection. </p> </div> <div class="method"><h5 id="team-getBugSubscriberPackages" title="team-getBugSubscriberPackages">getBugSubscriberPackages</h5><div> <p>Return the packages for which this person is a bug subscriber.</p> <p>Returns a list of IDistributionSourcePackage's, ordered alphabetically (A to Z) by name.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getBugSubscriberPackages</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#distribution_source_package">distribution_source_package</a> collection. </p> </div> <div class="method"><h5 id="team-getDirectAnswerQuestionTargets" title="team-getDirectAnswerQuestionTargets">getDirectAnswerQuestionTargets</h5><div> <p>Return a list of IQuestionTargets that a person is subscribed to.</p> <p>This will return IQuestionTargets that the person is registered as an answer contact because they subscribed themselves.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getDirectAnswerQuestionTargets</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question_target">question_target</a> collection. </p> </div> <div class="method"><h5 id="team-getMembersByStatus" title="team-getMembersByStatus">getMembersByStatus</h5><div> <p>Return the people whose membership on this team match :status:.</p> <p>If no orderby is provided, Person.sortingColumns is used.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMembersByStatus</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p><small>(required)</small></p><p><em>One of:</em></p><ul><li><tt>Proposed</tt></li><li><tt>Approved</tt></li><li><tt>Administrator</tt></li><li><tt>Deactivated</tt></li><li><tt>Expired</tt></li><li><tt>Declined</tt></li><li><tt>Invited</tt></li><li><tt>Invitation declined</tt></li></ul></td><td><p> The state of this membership </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#person">person</a> collection. </p> </div> <div class="method"><h5 id="team-getMergeProposals" title="team-getMergeProposals">getMergeProposals</h5><div> <p>Returns all merge proposals of a given status.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getMergeProposals</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"><h5 id="team-getOwnedProjects" title="team-getOwnedProjects">getOwnedProjects</h5><div> <p>Projects owned by this person or teams to which they belong.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOwnedProjects</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#project">project</a> collection. </p> </div> <div class="method"><h5 id="team-getOwnedTeams" title="team-getOwnedTeams">getOwnedTeams</h5><div> <p>Return the teams that this person owns.</p> <p>The iterator includes the teams that the user owns, but it not a member of.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getOwnedTeams</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#team">team</a> collection. </p> </div> <div class="method"><h5 id="team-getPPAByName" title="team-getPPAByName">getPPAByName</h5><div> <p>Return a PPA with the given name if it exists.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getPPAByName</var></p></td><td></td></tr><tr><td><p><strong>distribution</strong></p></td><td><p></p> Link to a <a href="#distribution">distribution</a>. </td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#archive">archive</a>. </p> </div> <div class="method"><h5 id="team-getRecipe" title="team-getRecipe">getRecipe</h5><p> Return the person's recipe with the given name. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRecipe</var></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#source_package_recipe">source_package_recipe</a>. </p> </div> <div class="method"><h5 id="team-getRequestedReviews" title="team-getRequestedReviews">getRequestedReviews</h5><div> <p>Returns merge proposals where a person was asked to review.</p> <p>This does not include merge proposals that were requested from teams that the person is part of. If status is not passed then it will return proposals that are in the "Needs Review" state.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getRequestedReviews</var></p></td><td></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> A list of merge proposal statuses to filter by. </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#branch_merge_proposal">branch_merge_proposal</a> collection. </p> </div> <div class="method"> <h5 id="team-getSocialAccountsByPlatform" title="team-getSocialAccountsByPlatform">getSocialAccountsByPlatform</h5> <p> Return Social Accounts associated to the user. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getSocialAccountsByPlatform</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>platform</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Matrix platform</tt> </li> </ul> </td> <td> <p> Social Platform Type </p> </td> </tr> </table> </div> <div class="method"><h5 id="team-getTeamAnswerQuestionTargets" title="team-getTeamAnswerQuestionTargets">getTeamAnswerQuestionTargets</h5><div> <p>Return a list of IQuestionTargets that are indirect subscriptions.</p> <p>This will return IQuestionTargets that the person or team is registered as an answer contact because of their membership in a team.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTeamAnswerQuestionTargets</var></p></td><td></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question_target">question_target</a> collection. </p> </div> <div class="method"><h5 id="team-getTranslationImportQueueEntries" title="team-getTranslationImportQueueEntries">getTranslationImportQueueEntries</h5><div> <p>Return entries in the translation import queue for this entity.</p> <p>If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>getTranslationImportQueueEntries</var></p></td><td></td></tr><tr><td><p><strong>file_extension</strong></p></td><td><p></p></td><td><div> <p>Filename extension</p> <p>Show only entries with this filename suffix</p> </div></td></tr><tr><td><p><strong>import_status</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Approved</tt></li><li><tt>Imported</tt></li><li><tt>Deleted</tt></li><li><tt>Failed</tt></li><li><tt>Needs Review</tt></li><li><tt>Blocked</tt></li><li><tt>Needs Information</tt></li></ul></td><td><div> <p>Status</p> <p>Show only entries with this status</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#translation_import_queue_entry">translation_import_queue_entry</a> collection. </p> </div> <div class="method"><h5 id="team-searchQuestions" title="team-searchQuestions">searchQuestions</h5><div> <p>Search the person's questions.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchQuestions</var></p></td><td></td></tr><tr><td><p><strong>language</strong></p></td><td><p></p></td><td><p> Language </p></td></tr><tr><td><p><strong>needs_attention</strong></p></td><td><p></p></td><td><p> Needs attentions from </p></td></tr><tr><td><p><strong>participation</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Owner</tt></li><li><tt>Subscriber</tt></li><li><tt>Assignee</tt></li><li><tt>Commenter</tt></li><li><tt>Answerer</tt></li></ul></td><td><p> Participation </p></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Search text </p></td></tr><tr><td><p><strong>sort</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>by relevancy</tt></li><li><tt>by status</tt></li><li><tt>newest first</tt></li><li><tt>oldest first</tt></li><li><tt>recently updated first</tt></li></ul></td><td><p> Sort </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><p> Status </p></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#question">question</a> collection. </p> </div> <div class="method"><h5 id="team-searchTasks" title="team-searchTasks">searchTasks</h5><div> <p>Search the IBugTasks reported on this entity.</p> <p>Return an iterable of matching results.</p> <p>Note: milestone is currently ignored for all IBugTargets except IProduct.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>searchTasks</var></p></td><td></td></tr><tr><td><p><strong>affected_user</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>assignee</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_commenter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_reporter</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>bug_supervisor</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>component</strong></p></td><td><p></p></td><td><div> <p>Component</p> <p>Distribution package archive grouping. E.g. main, universe, multiverse</p> </div></td></tr><tr><td><p><strong>created_before</strong></p></td><td><p></p></td><td><p> Search for bugs that were created before the given date. </p></td></tr><tr><td><p><strong>created_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been created since the given date. </p></td></tr><tr><td><p><strong>has_cve</strong></p></td><td><p></p></td><td><p> Show only bugs associated with a CVE </p></td></tr><tr><td><p><strong>has_no_package</strong></p></td><td><p></p></td><td><p> Exclude bugs with packages specified </p></td></tr><tr><td><p><strong>has_patch</strong></p></td><td><p></p></td><td><p> Show only bugs with patches available. </p></td></tr><tr><td><p><strong>importance</strong></p></td><td><p></p></td><td><div> <p>Importance</p> <p>Show only bugs with the given importance or list of importances.</p> </div></td></tr><tr><td><p><strong>information_type</strong></p></td><td><p></p></td><td><div> <p>Information Type</p> <p>Show only bugs with the given information type or list of information types.</p> </div></td></tr><tr><td><p><strong>linked_blueprints</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Blueprints</tt></li><li><tt>Show only Bugs without linked Blueprints</tt></li></ul></td><td><p> Search for bugs that are linked to blueprints or for bugs that are not linked to blueprints. </p></td></tr><tr><td><p><strong>linked_branches</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Show all bugs</tt></li><li><tt>Show only Bugs with linked Branches</tt></li><li><tt>Show only Bugs without linked Branches</tt></li></ul></td><td><p> Search for bugs that are linked to branches or for bugs that are not linked to branches. </p></td></tr><tr><td><p><strong>milestone</strong></p></td><td><p></p></td><td><div> <p>Milestone</p> <p>Show only bug tasks targeted to this milestone.</p> </div></td></tr><tr><td><p><strong>modified_since</strong></p></td><td><p></p></td><td><p> Search for bugs that have been modified since the given date. </p></td></tr><tr><td><p><strong>nominated_for</strong></p></td><td><p></p> Link to a <a href="#distro_series">distro_series</a>. </td><td></td></tr><tr><td><p><strong>omit_duplicates</strong></p></td><td><p></p></td><td><p> Omit bugs marked as duplicate, </p></td></tr><tr><td><p><strong>omit_targeted</strong></p></td><td><p></p></td><td><p> Omit bugs targeted to a series </p></td></tr><tr><td><p><strong>order_by</strong></p></td><td><p></p></td><td><p> List of fields by which the results are ordered. </p></td></tr><tr><td><p><strong>owner</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>search_text</strong></p></td><td><p></p></td><td><p> Bug ID or search text. </p></td></tr><tr><td><p><strong>status</strong></p></td><td><p></p></td><td><div> <p>Status</p> <p>Show only bugs with the given status value or list of values.</p> </div></td></tr><tr><td><p><strong>status_upstream</strong></p></td><td><p></p></td><td><div> <p>Status upstream</p> <p>Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.</p> </div></td></tr><tr><td><p><strong>structural_subscriber</strong></p></td><td><p></p> Link to a <a href="#person">person</a>. </td><td></td></tr><tr><td><p><strong>tags</strong></p></td><td><p></p></td><td><div> <p>Tags</p> <p>String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'</p> </div></td></tr><tr><td><p><strong>tags_combinator</strong></p></td><td><p></p><p><em>One of:</em></p><ul><li><tt>Any</tt></li><li><tt>All</tt></li></ul></td><td><div> <p>Tags combination</p> <p>Search for any or all of the tags specified.</p> </div></td></tr></table> <p class="response">Response contains an <code>application/json</code> representation of a <a href="#bug_task">bug_task</a> collection. </p> </div> </div> <div id="team-custom-POSTs" title="team-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="team-acceptInvitationToBeMemberOf" title="team-acceptInvitationToBeMemberOf">acceptInvitationToBeMemberOf</h5> <div> <p>Accept an invitation to become a member of the given team.</p> <p>There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to APPROVED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>acceptInvitationToBeMemberOf</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-addLanguage" title="team-addLanguage">addLanguage</h5> <div> <p>Add a language to this person's preferences.</p> <p>If the given language is one of the user's preferred languages already, nothing will happen.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addLanguage</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>language</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="team-addMember" title="team-addMember">addMember</h5> <div> <p>Add the given person as a member of this team.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>addMember</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>person</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Member </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p></p> <p> <em>One of:</em> </p> <ul> <li> <tt>Proposed</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Administrator</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Declined</tt> </li> <li> <tt>Invited</tt> </li> <li> <tt>Invitation declined</tt> </li> </ul> </td> <td> <p> The state of this membership </p> </td> </tr> </table> <h6>Response (application/json)</h6> <p> <td class="rst-field-body">A tuple containing a boolean indicating when the membership status changed and the current TeamMembershipStatus. This depends on the desired status passed as an argument, the membership policy and the user's privileges.</td> </p> </div> <div class="method"><h5 id="team-createPPA" title="team-createPPA">createPPA</h5><div> <p>Create a PPA.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createPPA</var></p></td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>displayname</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>distribution</strong></p></td><td><p></p> Link to a <a href="#distribution">distribution</a>. </td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>private</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>suppress_subscription_notifications</strong></p></td><td><p></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#archive">archive</a>. </p> </div> <div class="method"><h5 id="team-createRecipe" title="team-createRecipe">createRecipe</h5><div> <p>Create a SourcePackageRecipe owned by this person.</p> </div><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>createRecipe</var></p></td><td></td></tr><tr><td><p><strong>build_daily</strong></p></td><td><p></p></td><td></td></tr><tr><td><p><strong>daily_build_archive</strong></p></td><td><p></p> Link to a <a href="#archive">archive</a>. </td><td></td></tr><tr><td><p><strong>description</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>distroseries</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>name</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr><tr><td><p><strong>recipe_text</strong></p></td><td><p><small>(required)</small></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#source_package_recipe">source_package_recipe</a>. </p> </div> <div class="method"> <h5 id="team-declineInvitationToBeMemberOf" title="team-declineInvitationToBeMemberOf">declineInvitationToBeMemberOf</h5> <div> <p>Decline an invitation to become a member of the given team.</p> <p>There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to INVITATION_DECLINED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>declineInvitationToBeMemberOf</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-getArchiveSubscriptionURL" title="team-getArchiveSubscriptionURL">getArchiveSubscriptionURL</h5> <div> <p>Get a text line that is suitable to be used for a sources.list entry.</p> <p>It will create a new IArchiveAuthToken if one doesn't already exist.</p> <p>It raises Unauthorized if the context user does not have a valid subscription for the target archive or the caller is not context user itself.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getArchiveSubscriptionURL</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>archive</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#archive">archive</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="team-join" title="team-join">join</h5> <div> <p>Join the given team if its membership_policy is not RESTRICTED.</p> <p>Join the given team according to the policies and defaults of that team:</p> <ul class="rst-simple"> <li>If the team membership_policy is OPEN, the user is added as an APPROVED member with a NULL TeamMembership.reviewer.</li> <li>If the team membership_policy is MODERATED, the user is added as a PROPOSED member and one of the team's administrators have to approve the membership.</li> </ul> <p>If may_subscribe_to_list is True, then also attempt to subscribe to the team's mailing list, depending on the list status and the person's auto-subscribe settings.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>join</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-leave" title="team-leave">leave</h5> <div> <p>Leave the given team.</p> <p>This is a convenience method for retractTeamMembership() that allows a user to leave the given team, or to cancel a PENDING membership request.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>leave</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-removeLanguage" title="team-removeLanguage">removeLanguage</h5> <div> <p>Remove a language from this person's preferences.</p> <p>If the given language is not present, nothing will happen.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>removeLanguage</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>language</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#language">language</a>. </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="team-retractTeamMembership" title="team-retractTeamMembership">retractTeamMembership</h5> <div> <p>Retract this team's membership in the given team.</p> <p>If there's a membership entry for this team on the given team and its status is either APPROVED, ADMIN, PENDING, or INVITED, the status is changed and the relevant entries in TeamParticipation.</p> <p>APPROVED and ADMIN status are changed to DEACTIVATED. PENDING status is changed to DECLINED. INVITED status is changes to INVITATION_DECLINED.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retractTeamMembership</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td></td> </tr> <tr> <td> <p> <strong>team</strong> </p> </td> <td><p><small>(required)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-setAccountStatus" title="team-setAccountStatus">setAccountStatus</h5> <p> Set the status of this person's account. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setAccountStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> Status change comment </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Placeholder</tt> </li> <li> <tt>Unactivated</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Suspended</tt> </li> <li> <tt>Closed</tt> </li> <li> <tt>Deceased</tt> </li> </ul> </td> <td> <p> The status of this account </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team-setLocation" title="team-setLocation">setLocation</h5> <p> Specify the location and time zone of a person. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setLocation</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>latitude</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The latitude of this object. </p> </td> </tr> <tr> <td> <p> <strong>longitude</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The longitude of this object. </p> </td> </tr> <tr> <td> <p> <strong>time_zone</strong> </p> </td> <td> <p> <small>(required)</small> </p> </td> <td> <p> The time zone of this object. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="team_membership" title="team_membership">team_membership</h3> <div> <p>TeamMembership for Users.</p> <p>This table includes <em>direct</em> team members only. Indirect memberships are handled by the TeamParticipation table.</p> </div> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><team.name></var>/+member/<var><member.name></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_expires</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date expires </p> </td> </tr> <tr> <td> <p> <strong>date_joined</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date joined</p> <p>The date in which this membership was made active for the first time.</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>last_change_comment</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Comment on the last change </p> </td> </tr> <tr> <td> <p> <strong>last_changed_by_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Last person who change this </p> </td> </tr> <tr> <td> <p> <strong>member_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Member </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Proposed</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Administrator</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Declined</tt> </li> <li> <tt>Invited</tt> </li> <li> <tt>Invitation declined</tt> </li> </ul> </td> <td> <p> The state of this membership </p> </td> </tr> <tr> <td> <p> <strong>team_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Team </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="team_membership-standard-methods" title="team_membership-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="team_membership-custom-POSTs" title="team_membership-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="team_membership-setExpirationDate" title="team_membership-setExpirationDate">setExpirationDate</h5> <div> <p>Set this membership's expiration date.</p> <p>The given date must be None or in the future and the given user must be allowed to change this membership's expiration date as per the rules defined in canChangeExpirationDate().</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setExpirationDate</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>date</strong> </p> </td> <td> <p></p> </td> <td> <p> Date expires </p> </td> </tr> </table> </div> <div class="method"> <h5 id="team_membership-setStatus" title="team_membership-setStatus">setStatus</h5> <div> <p>Set the status of this membership.</p> <p>The user and comment are stored in last_changed_by and last_change_comment and may also be stored in proposed_by (and proponent_comment), reviewed_by (and reviewer_comment) or acknowledged_by (and acknowledger_comment), depending on the state transition.</p> <p>The given status must be different than the current status.</p> <p>Return True if the status got changed, otherwise False.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>comment</strong> </p> </td> <td> <p></p> </td> <td> <p> Reviewer comment </p> </td> </tr> <tr> <td> <p> <strong>silent</strong> </p> </td> <td> <p></p> </td> <td> <p> Do not send notifications of status change. For use by Launchpad administrators only. </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Proposed</tt> </li> <li> <tt>Approved</tt> </li> <li> <tt>Administrator</tt> </li> <li> <tt>Deactivated</tt> </li> <li> <tt>Expired</tt> </li> <li> <tt>Declined</tt> </li> <li> <tt>Invited</tt> </li> <li> <tt>Invitation declined</tt> </li> </ul> </td> <td> <p> The state of this membership </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="temporary_blob" title="temporary_blob">temporary_blob</h3> <p> A blob which we will store in the database temporarily. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>token</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> UUID </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="temporary_blob-standard-methods" title="temporary_blob-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="temporary_blob-custom-GETs" title="temporary_blob-custom-GETs" class="methods GETs"> <h4>Custom GET methods</h4> <div class="method"> <h5 id="temporary_blob-getProcessedData" title="temporary_blob-getProcessedData">getProcessedData</h5> <p> Returns a dict containing the processed blob data. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>getProcessedData</var></p> </td> <td></td> </tr> </table> </div> <div class="method"> <h5 id="temporary_blob-hasBeenProcessed" title="temporary_blob-hasBeenProcessed">hasBeenProcessed</h5> <p> Return True if this blob has been processed. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>hasBeenProcessed</var></p> </td> <td></td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="timeline_project_series" title="timeline_project_series">timeline_project_series</h3> <p> Minimal product series info for the timeline. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>is_development_focus</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Is series the development focus of the project </p> </td> </tr> <tr> <td> <p> <strong>landmarks</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> List of milestones and releases </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.</p> </div> </td> </tr> <tr> <td> <p> <strong>project_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#project">project</a>. </td> <td> <p> Project </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Experimental</tt> </li> <li> <tt>Active Development</tt> </li> <li> <tt>Pre-release Freeze</tt> </li> <li> <tt>Current Stable Release</tt> </li> <li> <tt>Supported</tt> </li> <li> <tt>Obsolete</tt> </li> <li> <tt>Future</tt> </li> </ul> </td> <td> <p> Status </p> </td> </tr> <tr> <td> <p> <strong>uri</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Series URI</p> <p>foo</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="timeline_project_series-standard-methods" title="timeline_project_series-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="translation_file" title="translation_file">translation_file</h3> <p> A translation file. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The translation file id. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="translation_file-standard-methods" title="translation_file-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="translation_group" title="translation_group">translation_group</h3> <p> A TranslationGroup. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Name</p> <p>Keep this name very short, unique, and descriptive, because it will be used in URLs. Examples: gnome-translation-project, ubuntu-translators.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>title</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Title</p> <p>Title of this Translation Group. This title is displayed at the top of the Translation Group page and in lists or reports of translation groups. Do not add "translation group" to this title, or it will be shown double.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="translation_group-standard-methods" title="translation_group-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="translation_import_queue_entry" title="translation_import_queue_entry">translation_import_queue_entry</h3> <p> An entry of the Translation Import Queue. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The timestamp when this queue entry was created. </p> </td> </tr> <tr> <td> <p> <strong>date_status_changed</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The timestamp when the status was changed. </p> </td> </tr> <tr> <td> <p> <strong>distroseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distro_series">distro_series</a>. </td> <td> <p> Series </p> </td> </tr> <tr> <td> <p> <strong>error_output</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Error output</p> <p>Output from most recent import attempt.</p> </div> </td> </tr> <tr> <td> <p> <strong>format</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>PO format</tt> </li> <li> <tt>MO format</tt> </li> <li> <tt>Mozilla XPI format</tt> </li> <li> <tt>KDE PO format</tt> </li> <li> <tt>XPI PO format</tt> </li> <li> <tt>Changes from imported translations in partial PO format</tt> </li> </ul> </td> <td> <p> The file format of the import. </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The entry ID </p> </td> </tr> <tr> <td> <p> <strong>path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Path</p> <p>The path to this file inside the source tree. Includes the filename.</p> </div> </td> </tr> <tr> <td> <p> <strong>productseries_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#project_series">project_series</a>. </td> <td> <p> Series </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>sourcepackage_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#source_package">source_package</a>. </td> <td> <p> The sourcepackage associated with this entry. </p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Approved</tt> </li> <li> <tt>Imported</tt> </li> <li> <tt>Deleted</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Needs Review</tt> </li> <li> <tt>Blocked</tt> </li> <li> <tt>Needs Information</tt> </li> </ul> </td> <td> <p> The status of the import. </p> </td> </tr> <tr> <td> <p> <strong>uploader_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Uploader</p> <p>The person that uploaded this file to Launchpad.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="translation_import_queue_entry-standard-methods" title="translation_import_queue_entry-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="translation_import_queue_entry-custom-POSTs" title="translation_import_queue_entry-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="translation_import_queue_entry-setStatus" title="translation_import_queue_entry-setStatus">setStatus</h5> <div> <p>Transition to a new status if possible.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setStatus</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>new_status</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Approved</tt> </li> <li> <tt>Imported</tt> </li> <li> <tt>Deleted</tt> </li> <li> <tt>Failed</tt> </li> <li> <tt>Needs Review</tt> </li> <li> <tt>Blocked</tt> </li> <li> <tt>Needs Information</tt> </li> </ul> </td> <td> <p> The status of the import. </p> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="translation_template" title="translation_template">translation_template</h3> <p> A translation template. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Template is active</p> <p>If unchecked, people can no longer change the template's translations.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_last_updated</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Date for last update </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Description</p> <p>Please provide a brief description of the content of this translation template, for example, telling translators if this template contains strings for end-users or other developers.</p> </div> </td> </tr> <tr> <td> <p> <strong>exported_in_languagepacks</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Include translations for this template in language packs?</p> <p>Check this box if this template is part of a language pack so its translations should be exported that way.</p> </div> </td> </tr> <tr> <td> <p> <strong>format</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>PO format</tt> </li> <li> <tt>MO format</tt> </li> <li> <tt>Mozilla XPI format</tt> </li> <li> <tt>KDE PO format</tt> </li> <li> <tt>XPI PO format</tt> </li> <li> <tt>Changes from imported translations in partial PO format</tt> </li> </ul> </td> <td> <p> File format for the source file </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The translation template id. </p> </td> </tr> <tr> <td> <p> <strong>language_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of languages for which we have translations. </p> </td> </tr> <tr> <td> <p> <strong>message_count</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The number of translation messages for this template. </p> </td> </tr> <tr> <td> <p> <strong>name</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Template name</p> <p>The name of this PO template, for example 'evolution-2.2'. Each translation template has a unique name in its package. It's important to get this correct, because Launchpad will recommend alternative translations based on the name.</p> </div> </td> </tr> <tr> <td> <p> <strong>owner_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Owner</p> <p>The owner of the template in Launchpad can edit the template and change it's status, and can also upload new versions of the template when a new release is made or when the translation strings have been changed during development.</p> </div> </td> </tr> <tr> <td> <p> <strong>path</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Path of the template in the source tree, including filename. </p> </td> </tr> <tr> <td> <p> <strong>priority</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Priority</p> <p>A number that describes how important this template is. Often there are multiple templates, and you can use this as a way of indicating which are more important and should be translated first. Pick any number - higher priority templates will generally be listed first.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>translation_domain</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Translation domain</p> <p>The translation domain for a translation template. Used with PO file format when generating MO files for inclusion in language pack or MO tarball exports.</p> </div> </td> </tr> <tr> <td> <p> <strong>translation_files_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#translation_file">translation_file</a> collection. </td> <td> <p> All translation files that exist for this template. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="translation_template-standard-methods" title="translation_template-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="vulnerability" title="vulnerability">vulnerability</h3> <p> A vulnerability. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>creator_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> The person who created the vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>cve_link</strong> </p> </td> <td><p><small>(writeable)</small></p> Link to a <a href="#cve">cve</a>. </td> <td> <p> External CVE reference corresponding to this vulnerability, if any. </p> </td> </tr> <tr> <td> <p> <strong>date_coordinated_release</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Coordinated Release Date. </p> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The date this vulnerability was created. </p> </td> </tr> <tr> <td> <p> <strong>date_made_public</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> The date this vulnerability was made public. </p> </td> </tr> <tr> <td> <p> <strong>date_notice_issued</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Date when a security notice was issued for this vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>description</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> A short description of the vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>distribution_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#distribution">distribution</a>. </td> <td> <p> Distribution </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>id</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> ID </p> </td> </tr> <tr> <td> <p> <strong>importance</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Unknown</tt> </li> <li> <tt>Undecided</tt> </li> <li> <tt>Critical</tt> </li> <li> <tt>High</tt> </li> <li> <tt>Medium</tt> </li> <li> <tt>Low</tt> </li> <li> <tt>Wishlist</tt> </li> </ul> </td> <td> <p> Indicates the work priority, not the severity </p> </td> </tr> <tr> <td> <p> <strong>importance_explanation</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Used to explain why our importance differs from somebody else's CVSS score. </p> </td> </tr> <tr> <td> <p> <strong>information_type</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Public</tt> </li> <li> <tt>Public Security</tt> </li> <li> <tt>Private Security</tt> </li> <li> <tt>Private</tt> </li> <li> <tt>Proprietary</tt> </li> <li> <tt>Embargoed</tt> </li> </ul> </td> <td> <div> <p>Information type</p> <p>Indicates the privacy of the vulnerability.</p> </div> </td> </tr> <tr> <td> <p> <strong>mitigation</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Explains why we're ignoring this vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>notes</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Free-form notes for this vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>private</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Private</p> <p>Private vulnerabilities are visible only to their subscribers.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>status</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> <p> <em>One of:</em> </p> <ul> <li> <tt>Needs triage</tt> </li> <li> <tt>Active</tt> </li> <li> <tt>Ignored</tt> </li> <li> <tt>Retired</tt> </li> </ul> </td> <td> <p> The status of the vulnerability. </p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="vulnerability-standard-methods" title="vulnerability-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="webhook" title="webhook">webhook</h3> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>active</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_last_modified</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date last modified </p> </td> </tr> <tr> <td> <p> <strong>deliveries_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook_delivery">webhook_delivery</a> collection. </td> <td> <p> Recent deliveries for this webhook. </p> </td> </tr> <tr> <td> <p> <strong>delivery_url</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Delivery URL </p> </td> </tr> <tr> <td> <p> <strong>event_types</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Event types </p> </td> </tr> <tr> <td> <p> <strong>git_ref_pattern</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <div> <p>Git ref pattern</p> <p>Pattern to match against git-ref/branch name of an event, to filter webhook triggers</p> </div> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>registrant_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <div> <p>Registrant</p> <p>The person who created this webhook.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>target_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook_target">webhook_target</a>. </td> <td> <div> <p>Target</p> <p>The object for which this webhook receives events.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> </table> </div> <div id="webhook-standard-methods" title="webhook-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>DELETE</dt> <dd>Deletes the entry.</dd> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="webhook-custom-POSTs" title="webhook-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="webhook-ping" title="webhook-ping">ping</h5><p> Send a test event. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>ping</var></p></td><td></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook_delivery">webhook_delivery</a>. </p> </div> <div class="method"> <h5 id="webhook-setSecret" title="webhook-setSecret">setSecret</h5> <p> Set the secret used to sign deliveries. </p> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>setSecret</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>secret</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="webhook_delivery" title="webhook_delivery">webhook_delivery</h3> <p> A Job that delivers an event to a webhook consumer. </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>date_created</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Date created </p> </td> </tr> <tr> <td> <p> <strong>date_first_sent</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date first sent</p> <p>Timestamp of the first delivery attempt.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_scheduled</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date scheduled</p> <p>Timestamp of the next delivery attempt.</p> </div> </td> </tr> <tr> <td> <p> <strong>date_sent</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Date sent</p> <p>Timestamp of the last delivery attempt.</p> </div> </td> </tr> <tr> <td> <p> <strong>error_message</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Error message</p> <p>Details of the error encountered by the most recent delivery attempt.</p> </div> </td> </tr> <tr> <td> <p> <strong>event_type</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Event type </p> </td> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>payload</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> Event payload </p> </td> </tr> <tr> <td> <p> <strong>pending</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Pending</p> <p>Whether a delivery attempt is in progress.</p> </div> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>successful</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <div> <p>Successful</p> <p>Whether the most recent delivery attempt succeeded, or null if no attempts have been made yet.</p> </div> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhook_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a>. </td> <td> <div> <p>Webhook</p> <p>The webhook that this delivery is for.</p> </div> </td> </tr> </table> </div> <div id="webhook_delivery-standard-methods" title="webhook_delivery-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="webhook_delivery-custom-POSTs" title="webhook_delivery-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"> <h5 id="webhook_delivery-retry" title="webhook_delivery-retry">retry</h5> <div> <p>Attempt to deliver the event again.</p> <p>Launchpad will automatically retry regularly for 24 hours, but this can be used after it gives up or to avoid waiting for the next automatic attempt.</p> </div> <h6>Parameters</h6> <table> <tr> <th>Parameter</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>ws.op</strong> </p> </td> <td> <p> <small>(required)</small> </p> <p> Fixed: <var>retry</var></p> </td> <td></td> </tr> <tr> <td> <p> <strong>reset</strong> </p> </td> <td> <p></p> </td> <td> <div> <p>Reset automatic retries</p> <p>Restart the 24 hour automatic retry window as well as trying again now.</p> </div> </td> </tr> </table> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="webhook_target" title="webhook_target">webhook_target</h3> <p> <label>URL:</label> <code>https://api.launchpad.net/devel</code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>web_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The canonical human-addressable web link to this resource. </p> </td> </tr> <tr> <td> <p> <strong>webhooks_collection_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#webhook">webhook</a> collection. </td> <td> <p> Webhooks for this target. </p> </td> </tr> </table> </div> <div id="webhook_target-standard-methods" title="webhook_target-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <div id="webhook_target-custom-POSTs" title="webhook_target-custom-POSTs" class="methods POSTs"> <h4>Custom POST methods</h4> <div class="method"><h5 id="webhook_target-newWebhook" title="webhook_target-newWebhook">newWebhook</h5><p> Create a new webhook. </p><h6>Parameters</h6><table><tr><th>Parameter</th><th>Value</th><th>Description</th></tr><tr><td><p><strong>ws.op</strong></p></td><td><p><small>(required)</small></p><p> Fixed: <var>newWebhook</var></p></td><td></td></tr><tr><td><p><strong>active</strong></p></td><td><p></p></td><td><div> <p>Active</p> <p>Deliver details of subscribed events.</p> </div></td></tr><tr><td><p><strong>delivery_url</strong></p></td><td><p><small>(required)</small></p></td><td><p> Delivery URL </p></td></tr><tr><td><p><strong>event_types</strong></p></td><td><p><small>(required)</small></p></td><td><p> Event types </p></td></tr><tr><td><p><strong>secret</strong></p></td><td><p></p></td><td><div> <p>Secret</p> <p>An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.</p> </div></td></tr></table> <p>On success, the response status will be 201 and the <var>Location</var> header will contain the link to the newly created <a href="#webhook">webhook</a>. </p> </div> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> <h3 id="wiki_name" title="wiki_name">wiki_name</h3> <p> Wiki for Users </p> <p> <label>URL:</label> <code>https://api.launchpad.net/devel/~<var><person.name></var>/+wikiname/<var><id></var></code> </p> <div class="representation"> <h4>Default representation (application/json)</h4> <table> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> <tr> <td> <p> <strong>http_etag</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The value of the HTTP ETag for this resource. </p> </td> </tr> <tr> <td> <p> <strong>person_link</strong> </p> </td> <td><p><small>(read-only)</small></p> Link to a <a href="#person">person</a>. </td> <td> <p> Owner </p> </td> </tr> <tr> <td> <p> <strong>resource_type_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The link to the WADL description of this resource. </p> </td> </tr> <tr> <td> <p> <strong>self_link</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p>The canonical link to this resource.</p> </td> </tr> <tr> <td> <p> <strong>url</strong> </p> </td> <td> <p> <small>(read-only)</small> </p> </td> <td> <p> The URL for this wiki home page. </p> </td> </tr> <tr> <td> <p> <strong>wiki</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Wiki host </p> </td> </tr> <tr> <td> <p> <strong>wikiname</strong> </p> </td> <td> <p> <small>(writeable)</small> </p> </td> <td> <p> Wikiname </p> </td> </tr> </table> </div> <div id="wiki_name-standard-methods" title="wiki_name-standard-methods" class="methods standard"> <h4>Standard methods</h4> <dl> <dt>GET</dt> <dd>Response contains the default <code>application/json</code> representation for this entry. </dd> <dt>PATCH</dt> <dd>Entity body should contain a represention encoded using <code>application/json</code> of the entry fields to update. Any fields of the default representation marked as writeable can be included. </dd> <dt>PUT</dt> <dd>Entity body should contain a representation encoded using <code>application/json</code> of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified. </dd> </dl> </div> <a href="#toc" class="toc-link">(back to Table of Contents)</a> </body> </html>

CINXE.COM

About this service