Skip to content

Commit

Permalink
Deprecate POST method for API search
Browse files Browse the repository at this point in the history
  • Loading branch information
horazont committed Oct 1, 2019
1 parent c6dd390 commit 4d31b57
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions muchopper/web/templates/for_developers.html
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ <h4>API calls</h4>
<ul>
<li><a href="#api-1.0-rooms">Complete room listing</a> (<code>GET /api/1.0/rooms</code>)</li>
<li><a href="#api-1.0-rooms/unsafe">Quick (unsafe) room listing</a> (<code>GET /api/1.0/rooms/unsafe</code>)</li>
<li><a href="#api-1.0-search">Search for rooms</a> (<code>POST /api/1.0/search</code>)</li>
<li><a href="#api-1.0-search">Search for rooms</a> (<code>GET /api/1.0/search</code>)</li>
<li><a href="#api-1.0-badge">SVG "badges" for rooms</a> (<code>GET /api/1.0/badge</code>)</li>
</ul>
<section class="api-call">
Expand Down Expand Up @@ -306,13 +306,16 @@ <h6>Response</h6>
</p>
</section>
<section class="api-call">
<h4><a name="api-1.0-search"></a><code>POST /api/1.0/search</code></h4>
<h4><a name="api-1.0-search"></a><code>GET /api/1.0/search</code></h4>
<h6>Description</h6>
<p class="box warning"><strong>Warning:</strong> This API is experimental and may change in incompatible ways without notice.</p>
<p>Execute a room search like on the website.</p>
<p class="box warning">
<strong>Warning:</strong> The search result is not safe against insert/reorder/delete race conditions when fetching multiple pages. This means that rooms can be missing or can be duplicated in the result.
</p>
<p class="box info">
<strong>Note:</strong> The use of the POST method for searching is supported, but deprecated.
</p>
<h6>Payload</h6>
<p>The payload must be JSON-formatted string. It <em>must</em> be sent with <code>Content-Type: application/json</code> and be encoded for the wire using UTF-8.</p>
<p>The object can have the following keys:</p>
Expand Down

0 comments on commit 4d31b57

Please sign in to comment.