Skip to content

Commit

Permalink
deploy: a9dff55
Browse files Browse the repository at this point in the history
  • Loading branch information
tkrop committed Oct 26, 2023
1 parent 8b145c7 commit abb4ff8
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1539,7 +1539,7 @@ <h2 id="_zalando_restful_api_and_event_guidelines"><a class="link" href="#_zalan
</li>
<li><a href="#headers">11. REST Basics - HTTP headers</a>
<ul class="sectlevel2">
<li><a href="#using--headers">Using Standard Header definitions</a></li>
<li><a href="#using-headers">Using Standard Header definitions</a></li>
<li><a href="#133"><span class="may-keyword"><strong>MAY</strong></span> use standard headers</a></li>
<li><a href="#132"><span class="should-keyword"><strong>SHOULD</strong></span> use kebab-case with uppercase separate words for HTTP headers</a></li>
<li><a href="#178"><span class="must-keyword"><strong>MUST</strong></span> use <code>Content-*</code> headers correctly</a></li>
Expand Down Expand Up @@ -5004,10 +5004,13 @@ <h3 id="236"><a class="link" href="#236"><span class="should-keyword"><strong>SH
<div class="paragraph">
<p>How query parameters are named and used is up to individual API designers, here
are a few tips that could help to decide whether to use simple or more complex
query language:
1. Consider using simple query language when API is built to be used
by others (external teams):</p>
query language:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Consider using simple query language when API is built to be used
by others (external teams):</p>
<div class="ulist">
<ul>
<li>
Expand All @@ -5020,8 +5023,10 @@ <h3 id="236"><a class="link" href="#236"><span class="should-keyword"><strong>SH
</li>
<li>
<p>easy to read, no learning curve</p>
<div class="olist arabic">
<ol class="arabic">
</li>
</ul>
</div>
</li>
<li>
<p>For internal usage or specific use case a more complex query language
can be used (such as <code>price gt 10</code> or <code>price[gt]=10</code> or <code>price&gt;10</code> etc.).
Expand All @@ -5030,9 +5035,6 @@ <h3 id="236"><a class="link" href="#236"><span class="should-keyword"><strong>SH
</li>
</ol>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>The following examples should serve as ideas for simple query language:</p>
</div>
Expand Down Expand Up @@ -6055,7 +6057,7 @@ <h2 id="headers"><a class="link" href="#headers">11. REST Basics - HTTP headers<
endpoint and response to clarify what is supported in a certain context.</p>
</div>
<div class="sect2">
<h3 id="using--headers"><a class="link" href="#using--headers">Using Standard Header definitions</a></h3>
<h3 id="using-headers"><a class="link" href="#using-headers">Using Standard Header definitions</a></h3>
<div class="paragraph">
<p>Usually, you can the standard HTTP request and response header definition
provided by the guideline to simplify API by using well recognized patterns.
Expand Down Expand Up @@ -6644,7 +6646,7 @@ <h3 id="183"><a class="link" href="#183"><span class="should-keyword"><strong>SH
<div class="paragraph">
<p>As part of the guidelines we provide the default definition of all proprietary
headers, so you can simply reference them when defining the API endpoint. For
details see <a href="#using-headers">[using-headers]</a>.</p>
details see <a href="#using-headers">Using Standard Header definitions</a>.</p>
</div>
<div class="paragraph">
<p><strong>Hint:</strong> This guideline does not standardize proprietary headers for our
Expand Down Expand Up @@ -10721,7 +10723,7 @@ <h3 id="rule-changes"><a class="link" href="#rule-changes">Rule Changes</a></h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-10-18 13:54:30 UTC
Last updated 2023-10-26 09:05:34 UTC
</div>
</div>
</body>
Expand Down

0 comments on commit abb4ff8

Please sign in to comment.