launchpad-reviewers team mailing list archive

[Colin Watson <cjwatson@xxxxxxxxxxxxx>]

Colin Watson has proposed merging lp:~cjwatson/launchpad/api-document-delete into lp:launchpad.

Commit message:
Document the standard DELETE method in the apidoc.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)
Related bugs:
  Bug #753334 in Launchpad itself: "apidoc doesn't mention DELETE methods"
  https://bugs.launchpad.net/launchpad/+bug/753334

For more details, see:
https://code.launchpad.net/~cjwatson/launchpad/api-document-delete/+merge/292738

Document the standard DELETE method in the apidoc.  While I was at it, I fixed a whitespace bug that I introduced a while ago.
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~cjwatson/launchpad/api-document-delete into lp:launchpad.

=== modified file 'lib/lp/services/webservice/wadl-to-refhtml.xsl'
--- lib/lp/services/webservice/wadl-to-refhtml.xsl	2015-04-13 19:55:37 +0000
+++ lib/lp/services/webservice/wadl-to-refhtml.xsl	2016-04-24 23:45:09 +0000
@@ -798,6 +798,12 @@
         </dd>
     </xsl:template>
 
+    <!-- Documentation for the standard DELETE on an entry -->
+    <xsl:template match="wadl:method[@name='DELETE']" mode="standard-method">
+        <dt><xsl:value-of select="@name" /></dt>
+        <dd>Deletes the entry.</dd>
+    </xsl:template>
+
     <!-- Documentation for the custom GET operations of the resource type -->
     <xsl:template name="custom-GETs">
         <xsl:variable name="operations" select="wadl:method[
@@ -1052,7 +1058,7 @@
             representation of a
             <a href="#{$resource_type}"><xsl:value-of
                 select="$resource_type"
-            /></a><xsl:if test="contains($id, '-page')">collection</xsl:if>.
+            /></a><xsl:if test="contains($id, '-page')"> collection</xsl:if>.
         </p>
     </xsl:template>