Skip to content

Commit

Permalink
Edits to the conneg-by-p document
Browse files Browse the repository at this point in the history
  • Loading branch information
agbeltran committed Nov 6, 2018
1 parent d0953eb commit 6fe5c94
Showing 1 changed file with 19 additions and 20 deletions.
39 changes: 19 additions & 20 deletions conneg-by-ap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<section id="abstract">
<h2>Abstract</h2>
<p>
This document describes how Internet clients may request negotiate for content provided by servers according to
This document describes how Internet clients may negotiate for content provided by servers according to
<em>profiles</em>. This is distinct from negotiating by Media Type or Language: the <em>profile</em> is expected
to specify the content of information returned, which may be a subset of what the responding server contains.
</p>
Expand All @@ -33,32 +33,31 @@ <h3>Overview of DXWG documents on profiles</h3>
</p>
<ul>
<li>[[PROF-GUIDE]] the top-level general profiling guidance document giving an overview of all other documents</li>
<li>[[PROF-ONT]] formal ontology describing objects related to profiles</li>
<li><strong>[PROF-CONNEG] this document, specific guidance on how to negotiate for Internet resource content using profiles</strong></li>
<li>[[PROF-IETF]] (<a href="http://www.ietf.org">IETF</a> <a href="http://www.ietf.org/standards/ids/">Internet-Draft</a>), HTTP Headers for HTTP content negotiation by profile</li>
<li>[[PROF-ONT]] a document describing a formal ontology for describing objects related to profiles</li>
<li><strong>[PROF-CONNEG] this document, including specific guidance on how to negotiate for Internet resource content using profiles</strong></li>
<li>[[PROF-IETF]] a (<a href="http://www.ietf.org">IETF</a> <a href="http://www.ietf.org/standards/ids/">Internet-Draft</a>) defining two HTTP Headers for HTTP content negotiation by profile</li>
</ul>
</section>
</section>
<section id="introduction" class="informative">
<h1>Introduction</h1>
<p>
Content delivered by dereferencing Internet identifiers has long been able to be negotiated for in different
ways. When using the HTTP protocol [[rfc7230]], a client may set an <code>Accept</code> header specifying
preferred Media Types which the server may or may not supply. So too resources available in different languages
ways. When using the HTTP protocol [[RFC7230]], a client may set an <code>Accept</code> header specifying
preferred Media Types which the server may or may not supply. Thus, resources available in different languages
may be requested by setting an HTTP <code>Accept-Language</code> header. Until now, clients have not had a
defined way to negotiate for content based on its adherence to an information model - standard, specification or
<a>profile</a> - and this document addresses that.
defined way to negotiate for content based on its adherence to an information model - a standard, a specification or
a <a>profile</a> - and this document addresses this functionality.
</p>
<p>
When information online about a resource adheres to one or more profiles, methods described here allow
clients to list those models adhered to and request content according to one or more of them in preference order.
For example, information about a book online might adhere to the as the Dublin Core Terms [[DCTERMS]] medatadata
specifications with each field of information, such as <em>title</em>, <em>description</em>, <em>author</em> etc.,
When online information about a resource adheres to one or more profiles, methods described here allow
clients to list those profiles and request content according to one or more of them in order of preference.
For example, information about an online book might adhere to the Dublin Core Terms [[DCTERMS]] metadata
specification with each field of information, such as <em>title</em>, <em>description</em>, <em>author</em> etc.,
being defined and formatted according to various Dublin Core elements (<code>dct:title</code>,
<code>dct:description</code> &amp; <code>dct:creator</code>, respectively). A request then for this book may ask for
the list of profiles the book is available according to or it may ask specifically for a response adhering to the
Dublin Core Terms profile. When a requested for a non-existent or unsupported profile is requested, a server
returns default content.
<code>dct:description</code> &amp; <code>dct:creator</code>, respectively). Then, a request for the informatoin about this
book may ask for the list of profiles according to which the metadata is available, or it may ask specifically for a response adhering to the
Dublin Core Terms profile. When a non-existent or unsupported profile is requested, a server returns default content.
</p>
<p>
When selecting content negotiation mechanics, an Internet client may use the HTTP protocol but it may also use
Expand Down Expand Up @@ -119,11 +118,11 @@ <h2>Definitions</h2>
<dt><dfn>client</dfn></dt>
<dd>
a program that establishes a connection to a server for the purpose of sending one or more HTTP requests
[[rfc7230]]
[[RFC7230]]
</dd>
<dt><dfn>server</dfn></dt>
<dd>
a program that accepts connections in order to service HTTP requests by sending HTTP responses [[rfc7230]]
a program that accepts connections in order to service HTTP requests by sending HTTP responses [[RFC7230]]
</dd>
<dt><dfn>resource</dfn></dt>
<dd>
Expand All @@ -133,9 +132,9 @@ <h2>Definitions</h2>
<dt><dfn>metadata</dfn></dt>
<dd>additional information be supplied about a resource [[rfc3986]]</dd>
<dt><dfn>request</dfn></dt>
<dd>a message sent over the Internet, from a <em>client</em> to a <em>server</em>, for a information about a <em>resource</em> [[rfc7230]]</dd>
<dd>a message sent over the Internet, from a <em>client</em> to a <em>server</em>, for a information about a <em>resource</em> [[RFC7230]]</dd>
<dt><dfn>response</dfn></dt>
<dd>a message sent over the Internet, from a <em>server</em> to a <em>client</em> answering a <em>request</em> for information about a <em>resource</em> [[rfc7230]]</dd>
<dd>a message sent over the Internet, from a <em>server</em> to a <em>client</em> answering a <em>request</em> for information about a <em>resource</em> [[RFC7230]]</dd>
<dt><dfn>token</dfn></dt>
<dd>a short name identifying something, in this situation a <a>profile</a></dd>
</dl>
Expand Down

0 comments on commit 6fe5c94

Please sign in to comment.