38 lines
9 KiB
HTML
38 lines
9 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
||
"">
|
||
<html><head><meta charset="UTF-8" /><title>Validation Faults in ActivityPub documents</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Dog-and-duck</span> <span class="project-version">0.1.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Desiderata.html"><div class="inner"><span>Desiderata</span></div></a></li><li class="depth-1 "><a href="Using_ActivityPub.html"><div class="inner"><span>Using ActivityPub</span></div></a></li><li class="depth-1 current"><a href="Validation_Faults.html"><div class="inner"><span>Validation Faults in ActivityPub documents</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>The Old Dog and Duck</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dog-and-duck</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>quack</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.quack.cli.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cli</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.picky.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>picky</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.collections.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>collections</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.constants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>constants</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.control-variables.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>control-variables</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.distribution.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>distribution</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.objects.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>objects</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-4"><a href="dog-and-duck.quack.picky.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.quack.html"><div class="inner"><span class="tree" style="top: -269px;"><span class="top" style="height: 278px;"></span><span class="bottom"></span></span><span>quack</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -362px;"><span class="top" style="height: 371px;"></span><span class="bottom"></span></span><span>scratch</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.scratch.parser.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parser</span></div></a></li><li class="depth-3"><a href="dog-and-duck.scratch.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>utils</span></div></div></li><li class="depth-3"><a href="dog-and-duck.utils.process.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>process</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#validation-faults-in-activitypub-documents" name="validation-faults-in-activitypub-documents"></a>Validation Faults in ActivityPub documents</h1>
|
||
<h2><a href="#motivation" name="motivation"></a>Motivation</h2>
|
||
<p>This document is intended to provide an extension vocabulary for <a href="https://www.w3.org/TR/activitystreams-core/">ActivityStreams</a> documents, which provides vocabulary for categorising and describing faults in <a href="https://www.w3.org/TR/activitypub/">ActivityPub</a> documents.</p>
|
||
<p>The motivation is to be able to serialise a validation report on an ActivityPub document as an ActivityStreams document.</p>
|
||
<h2><a href="#intepretation" name="intepretation"></a>Intepretation</h2>
|
||
<h3><a href="#conformance" name="conformance"></a>Conformance</h3>
|
||
<p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
|
||
<p>The key words MAY, MUST, MUST NOT, SHOULD, and SHOULD NOT are to be interpreted as described in [RFC2119].</p>
|
||
<h3><a href="#the-spec" name="the-spec"></a>‘the spec’</h3>
|
||
<p>Where the phrase ‘the spec’ is used in this document, it refers to a concatenation of the ActivityStreams specification and the ActivityPub specification.</p>
|
||
<h2><a href="#the-object-type" name="the-object-type"></a>The <code>Fault</code> object type</h2>
|
||
<p>The <code>Fault</code> object type is a novel object type introduced by this document to describe validation faults. Objects with the <code>Fault</code> object type MUST have at least the following fields (additional fields are not required but are optional):</p>
|
||
<ol>
|
||
<li><code>:@context</code> whose value shall be the URL of a document specifying this vocabulary;</li>
|
||
<li><code>:type</code> whose value shall be <code>Fault</code>;</li>
|
||
<li><code>:severity</code> whose value shall be one of <code>minor</code>, <code>should</code>, <code>must</code> or <code>critical</code>;</li>
|
||
<li><code>:fault</code> whose value shall be a unique token representing the particular fault type;</li>
|
||
<li><code>:narrative</code> whose value shall be a natural language description of the fault type.</li>
|
||
</ol>
|
||
<h3><a href="#the-fields" name="the-fields"></a>The Fields</h3>
|
||
<h4><a href="#context" name="context"></a>Context</h4>
|
||
<p>The value of the <code>@context</code> field of a fault report object shall be the URL of this document, currently <code>https://simon-brooke.github.io/dog-and-duck/codox/Validation_Faults.html</code>.</p>
|
||
<h4><a href="#type" name="type"></a>Type</h4>
|
||
<p>The value of the <code>type</code> field of a fault report object MUST be <code>Fault</code>.</p>
|
||
<h4><a href="#severity" name="severity"></a>Severity</h4>
|
||
<p>Each fault report object MUST have a <code>severity</code> field whose value MUST be one of</p>
|
||
<ol>
|
||
<li><code>:info</code> things which are not actuallys fault, but issues noted during validation;</li>
|
||
<li><code>:minor</code> things which I consider to be faults, but which don’t actually breach the spec;</li>
|
||
<li><code>:should</code> instances where the spec says something SHOULD be done, which isn’t;</li>
|
||
<li><code>:must</code> instances where the spec says something MUST be done, which isn’t;</li>
|
||
<li><code>:critical</code> instances where I believe the fault means that the object cannot be meaningfully processed.</li>
|
||
</ol>
|
||
<h4><a href="#fault" name="fault"></a>Fault</h4>
|
||
<p>Unique codes shall be assigned to each fault type, and shall be documented in this section.</p>
|
||
<p>It is intended that there should ultimately be a well known site at which the fault codes can be resolved to natural language explanations in as many natural languages as possible of the nature of the particular fault.</p></div></div></div></body></html> |