Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Details field thresholdValue. #43

Closed
wants to merge 1 commit into from
Closed

Add Details field thresholdValue. #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 34 additions & 27 deletions draft-inadarei-api-health-check-03.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,11 +390,12 @@
<link href="#rfc.section.4.1" rel="Chapter" title="4.1 componentId">
<link href="#rfc.section.4.2" rel="Chapter" title="4.2 componentType">
<link href="#rfc.section.4.3" rel="Chapter" title="4.3 observedValue">
<link href="#rfc.section.4.4" rel="Chapter" title="4.4 observedUnit">
<link href="#rfc.section.4.5" rel="Chapter" title="4.5 status">
<link href="#rfc.section.4.6" rel="Chapter" title="4.6 time">
<link href="#rfc.section.4.7" rel="Chapter" title="4.7 output">
<link href="#rfc.section.4.8" rel="Chapter" title="4.8 links">
<link href="#rfc.section.4.4" rel="Chapter" title="4.4 thresholdValue">
<link href="#rfc.section.4.5" rel="Chapter" title="4.5 observedUnit">
<link href="#rfc.section.4.6" rel="Chapter" title="4.6 status">
<link href="#rfc.section.4.7" rel="Chapter" title="4.7 time">
<link href="#rfc.section.4.8" rel="Chapter" title="4.8 output">
<link href="#rfc.section.4.9" rel="Chapter" title="4.9 links">
<link href="#rfc.section.5" rel="Chapter" title="5 Example Output">
<link href="#rfc.section.6" rel="Chapter" title="6 Security Considerations">
<link href="#rfc.section.7" rel="Chapter" title="7 IANA Considerations">
Expand All @@ -407,12 +408,12 @@
<link href="#rfc.authors" rel="Chapter">


<meta name="generator" content="xml2rfc version 2.10.3 - https://tools.ietf.org/tools/xml2rfc" />
<meta name="generator" content="xml2rfc version 2.9.6 - https://tools.ietf.org/tools/xml2rfc" />
<link rel="schema.dct" href="http://purl.org/dc/terms/" />

<meta name="dct.creator" content="Nadareishvili, I." />
<meta name="dct.identifier" content="urn:ietf:id:draft-inadarei-api-health-check-03" />
<meta name="dct.issued" scheme="ISO8601" content="2018-27" />
<meta name="dct.issued" scheme="ISO8601" content="2018-26" />
<meta name="dct.abstract" content="This document proposes a service health check response format for HTTP APIs." />
<meta name="description" content="This document proposes a service health check response format for HTTP APIs." />

Expand All @@ -429,14 +430,14 @@
</tr>
<tr>
<td class="left">Internet-Draft</td>
<td class="right">October 27, 2018</td>
<td class="right">February 26, 2018</td>
</tr>
<tr>
<td class="left">Intended status: Informational</td>
<td class="right"></td>
</tr>
<tr>
<td class="left">Expires: April 30, 2019</td>
<td class="left">Expires: August 30, 2019</td>
<td class="right"></td>
</tr>

Expand All @@ -459,7 +460,7 @@ <h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
<p>This Internet-Draft will expire on April 30, 2019.</p>
<p>This Internet-Draft will expire on August 30, 2019.</p>
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
<p>Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>
Expand Down Expand Up @@ -501,15 +502,17 @@ <h1 class="np" id="rfc.toc"><a href="#rfc.toc">Table of Contents</a></h1>
</li>
<li>4.3. <a href="#rfc.section.4.3">observedValue</a>
</li>
<li>4.4. <a href="#rfc.section.4.4">observedUnit</a>
<li>4.4. <a href="#rfc.section.4.4">thresholdValue</a>
</li>
<li>4.5. <a href="#rfc.section.4.5">status</a>
<li>4.5. <a href="#rfc.section.4.5">observedUnit</a>
</li>
<li>4.6. <a href="#rfc.section.4.6">time</a>
<li>4.6. <a href="#rfc.section.4.6">status</a>
</li>
<li>4.7. <a href="#rfc.section.4.7">output</a>
<li>4.7. <a href="#rfc.section.4.7">time</a>
</li>
<li>4.8. <a href="#rfc.section.4.8">links</a>
<li>4.8. <a href="#rfc.section.4.8">output</a>
</li>
<li>4.9. <a href="#rfc.section.4.9">links</a>
</li>
</ul><li>5. <a href="#rfc.section.5">Example Output</a>
</li>
Expand Down Expand Up @@ -651,31 +654,35 @@ <h1 id="rfc.section.4.3">
</h1>
<p id="rfc.section.4.3.p.1">observedValue: (optional) could be any valid JSON value, such as: string, number, object, array or literal.</p>
<h1 id="rfc.section.4.4">
<a href="#rfc.section.4.4">4.4.</a> <a href="#observedunit" id="observedunit">observedUnit</a>
<a href="#rfc.section.4.4">4.4.</a> <a href="#thresholdvalue" id="thresholdvalue">thresholdValue</a>
</h1>
<p id="rfc.section.4.4.p.1">thresholdValue: (optional) could be any valid JSON value, such as: string, number, object, array or literal. Determines the value above (or below) which the status changes from &#8220;pass&#8221; state to &#8220;warn&#8221; state or back. thresholdValue MUST only be present if observedValue is also present.</p>
<h1 id="rfc.section.4.5">
<a href="#rfc.section.4.5">4.5.</a> <a href="#observedunit" id="observedunit">observedUnit</a>
</h1>
<p id="rfc.section.4.4.p.1">observedUnit (optional) SHOULD be present if observedValue is present. Calrifies the unit of measurement in which observedUnit is reported, e.g. for a time-based value it is important to know whether the time is reported in seconds, minutes, hours or something else. To make sure unit is denoted by a well-understood name or an abbreviation, it should be one of:</p>
<p id="rfc.section.4.5.p.1">observedUnit (optional) SHOULD be present if observedValue is present. Clarifies the unit of measurement in which observedValue and thresholdValue are reported, e.g. for a time-based value it is important to know whether the time is reported in seconds, minutes, hours or something else. To make sure unit is denoted by a well-understood name or an abbreviation, it should be one of:</p>
<p></p>

<ul>
<li>A common and standard term from a well-known source such as schema.org, IANA, microformats, or a standards document such as <a href="#RFC3339" class="xref">[RFC3339]</a>.</li>
<li>A URI that indicates extra semantics and processing rules that MAY be provided by a resource at the other end of the URI. URIs do not have to be dereferenceable, however. They are just a namespace, and the meaning of a namespace CAN be provided by any convenient means (e.g. publishing an RFC, Swagger document or a nicely printed book).</li>
</ul>
<h1 id="rfc.section.4.5">
<a href="#rfc.section.4.5">4.5.</a> <a href="#status-1" id="status-1">status</a>
</h1>
<p id="rfc.section.4.5.p.1">status (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<h1 id="rfc.section.4.6">
<a href="#rfc.section.4.6">4.6.</a> <a href="#time" id="time">time</a>
<a href="#rfc.section.4.6">4.6.</a> <a href="#status-1" id="status-1">status</a>
</h1>
<p id="rfc.section.4.6.p.1">time (optional) is the date-time, in ISO8601 format, at which the reading of the observedValue was recorded. This assumes that the value can be cached and the reading typically doesn&#8217;t happen in real time, for performance and scalability purposes.</p>
<p id="rfc.section.4.6.p.1">status (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<h1 id="rfc.section.4.7">
<a href="#rfc.section.4.7">4.7.</a> <a href="#output-1" id="output-1">output</a>
<a href="#rfc.section.4.7">4.7.</a> <a href="#time" id="time">time</a>
</h1>
<p id="rfc.section.4.7.p.1">output (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<p id="rfc.section.4.7.p.1">time (optional) is the date-time, in ISO8601 format, at which the reading of the observedValue was recorded. This assumes that the value can be cached and the reading typically doesn&#8217;t happen in real time, for performance and scalability purposes.</p>
<h1 id="rfc.section.4.8">
<a href="#rfc.section.4.8">4.8.</a> <a href="#links-1" id="links-1">links</a>
<a href="#rfc.section.4.8">4.8.</a> <a href="#output-1" id="output-1">output</a>
</h1>
<p id="rfc.section.4.8.p.1">output (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<h1 id="rfc.section.4.9">
<a href="#rfc.section.4.9">4.9.</a> <a href="#links-1" id="links-1">links</a>
</h1>
<p id="rfc.section.4.8.p.1">links (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<p id="rfc.section.4.9.p.1">links (optional) has the exact same meaning as the top-level &#8220;output&#8221; element, but for the sub-component/downstream dependency represented by the details object.</p>
<h1 id="rfc.section.5">
<a href="#rfc.section.5">5.</a> <a href="#example-output" id="example-output">Example Output</a>
</h1>
Expand Down
Loading