Project

General

Profile

« Previous | Next » 

Revision 9255

Added by Jing Tao almost 9 years ago

Add a new version of this document from the svn trunk. The changes are all documentation.

View differences:

lib/schema/dataone/dataoneTypes_v2.0.xsd
132 132 
          <xs:sequence>
133 133 
            <xs:element name="seriesId" type="d1:Identifier" minOccurs="0">
134 134 
                <xs:annotation>
135 
                  <xs:documentation>The :term:`seriesId` is a unique Unicode
136 
                  string that can be used to identify an object revision chain
137 
                  in DataONE. When included, the seriesId can be used to
138 
                  reference the latest version of and object in the revision
139 
                  chain. API methods that rely on byte fixity (e.g. for content
140 
                  replication) will not accept seriesId in place of discrete
141 
                  identifiers.</xs:documentation>
135 
                  <xs:documentation>The :term:`seriesId` is an optional, unique
136 
                  Unicode string that identifies an object revision chain. A
137 
                  seriesId will resolve to the latest version of an object. A seriesId can not appear in any other revision chain.
138 
                  </xs:documentation>
142 139 
                  <xs:documentation>The values used for seriesId must be unique
143 140 
                  within DataONE and cannot be the same as the :term:`primary
144 141 
                  identifier` of an object. </xs:documentation>
......
160 157 
                      the associated ObjectFormat.
161 158 
                    </xs:documentation>
162 159 
                    <xs:documentation>When specified, the mediaType value here
163 
                      should be used in preference to the value recorded in the
164 
                      referenced :class:`ObjectFormat`.
160 
                      overrides the value recorded in the referenced
161 
                      :class:`ObjectFormat`.
165 162 
                    </xs:documentation>
166 163 
                    <xs:documentation>This value SHOULD be set by the content
167 164 
                    creator. It MAY be set by any receiving agent if the value
......
169 166 
                    specific, and a correct value is specified elsewhere such
170 167 
                    as by a HTTP Content-Type parameter.
171 168 
                    </xs:documentation>
172 
                    <xs:documentation>This value may only be changed to correct
173 
                      an erroneous entry.</xs:documentation>
169 
                    <xs:documentation>This value MAY be changed to correct an
170 
                    erroneous entry.</xs:documentation>
174 171 
                </xs:annotation>
175 172 
              </xs:element>
176 173 
              <xs:element name="fileName" type="xs:string" minOccurs="0">
177 174 
                <xs:annotation>
178 
                  <xs:documentation>Optional tough recommended value that
179 
                    provides a suggested file name for the object. Values should
175 
                  <xs:documentation>Optional though recommended value providing
176 
                    a suggested file name for the object. Values should
180 177 
                    conform to cross platform file naming conventions.
181 178 
                  </xs:documentation>
182 179 
                  <xs:documentation>This value SHOULD be set by the content
......
214 211 
  <xs:complexType name="Node">
215 212 
    <xs:annotation>
216 213 
      <xs:documentation>Extends the Version 1.x :class:`Types.Node` by adding
217 
        an optional unbounded parameter entry that can be used to provide
218 
        additional simple metadata relevant to a Node. </xs:documentation>
214 
        an optional unbounded parameter entry providing additional simple
215 
        metadata relevant to a Node. </xs:documentation>
219 216 
    </xs:annotation>
220 217 
    <xs:complexContent>
221 218 
      <xs:extension base="d1:Node">
......
240 237 
      <xs:annotation>
241 238 
        <xs:documentation>Additional Property elements can be included to
242 239 
          describe the Node in more detail. Some properties will come from
243 
          controlled vocabularies, indicated by the type attribute, while
240 
          controlled vocabularies indicated by the type attribute, while
244 241 
          others will be free-form key value pairs.</xs:documentation>
245 242 
      </xs:annotation>
246 243 
      <xs:simpleContent>
......
340 337 
          <xs:documentation>A unique identifier for this log entry. The
341 338 
          identifier should be unique for a particular node; This is not drawn
342 339 
          from the same value space as other identifiers in DataONE, and so is
343 
          not subjec to the same restrictions.</xs:documentation>
340 
          not subject to the same restrictions.</xs:documentation>
344 341 
        </xs:annotation>
345 342 
      </xs:element>
346 343 
      <xs:element name="identifier" type="d1:Identifier"
......
369 366 
        <xs:annotation>
370 367 
          <xs:documentation>The :term:`Subject` used for making the request.
371 368 
          This may be the DataONE :term:`public` user if the request is not
372 
          authenticated, otherwise it will be the *Subject* of the certificate
369 
          authenticated, otherwise it will be the *subject* of the certificate
373 370 
          used for authenticating the request.</xs:documentation>
374 371 
        </xs:annotation>
375 372 
      </xs:element>
376 373 
      <xs:element name="event" type="d1:NonEmptyString"
377 374 
          minOccurs="1" maxOccurs="1">
378 375 
        <xs:annotation>
379 
          <xs:documentation>A non-empty string that indicates the type of even
376 
          <xs:documentation>A non-empty string indicating the type of event
380 377 
            logged. A value from the :class:`Types.Event` enumeration is
381 
            recommended but no longer required for Version 2.x.
378 
            recommended though no longer required for Version 2.x.
382 379 
          </xs:documentation>
383 380 
        </xs:annotation>
384 381 
      </xs:element>
......
428 425 
    </xs:sequence>
429 426 
    <xs:attribute name="key" use="required" type="xs:string">
430 427 
      <xs:annotation>
431 
        <xs:documentation>A value that can be used with a DataONE
432 
        service. Key values must not contain any characters that need to be
433 
        URL escaped, and should be short and informative.
428 
        <xs:documentation>A value that can be used with a DataONE service. Key
429 
        values must not contain any characters that need to be URL escaped, and
430 
        should be short and informative.
434 431 
        </xs:documentation>
435 432 
      </xs:annotation>
436 433 
    </xs:attribute>
437 434 
    <xs:attribute name="description" use="required" type="xs:string">
438 435 
      <xs:annotation>
439 
        <xs:documentation>The description of an option, indicating its
440 
        intended use and impact on a DataONE service invocation.</xs:documentation>
436 
        <xs:documentation>The description of an option, indicating its intended
437 
          use and impact on a DataONE service invocation.</xs:documentation>
441 438 
      </xs:annotation>
442 439 
    </xs:attribute>
443 440 
  </xs:complexType>

Also available in: Unified diff