Discovery Change Proposal-9
<< Back to the Discovery Change Proposals page
DCP-9: Identifying Version of ESIP Discovery Conformance
- Progress (fill in the dates as the process moves forward)
- Submitted on: 2012-08-21
- Review period: the review period
- Revision: when revisions are being made based on feedback
- Vote: the voting period
- Final review: when final adjustments are being made and final review
- Ratified: when approved.
- Rejected: or when rejected.
- Facilitator: the primary editor to help the DCP move along the process.
Description
As the ESIP Discovery conventions evolve, it becomes necessary for clients to understand what version of the ESIP conventions a particular server is conforming to. This Discovery Change Proposal describes how servers can advertise their conformance with one ESIP Discovery version or another.
Problem Addressed
What is the problem to solve?
Proposed Solution
(1) The ESIP Discovery Version with which a provider complies would be identified by declaring an ESIP namespace within the root element of the document, i.e.: a) the <feed> element for Atom responses b) the <OpenSearchDescription> element for OpenSearch Description documents
(2) The namespace prefix shall by convention be "esipdiscovery".
(3) The namespace URI shall be http://commons.esipfed.org/ns/discovery/<version>/.
(4) Thus, the opening element for an ESIP-compliant atom feed may look like:
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xmlns:esipdiscovery="http://commons.esipfed.org/ns/discovery/1.2/">
Note that the rather long "esipdiscovery" namespace is used in preference to the simpler "esip" to allow for other ESIP efforts (e.g. semantic web) to carve out their own namespaces within ESIP.
(5) The namespace URI will be dereferencible to the text describing the ESIP discovery conventions for that version.
Rationale for the Solution
Why this solution?
Discussions
May link to medium where proposal is openly discussed.
Consensus
Voting results.