Merge pull request #42 from yevheniimoroziuk/assets

Docs: Update data standard
openprocurement · Aug 7, 2018 · a0401f2 · a0401f2
2 parents afc02f3 + 4333798
commit a0401f2
Show file tree

Hide file tree

Showing 7 changed files with 126 additions and 41 deletions.
diff --git a/docs/source/acceleration.rst b/docs/source/acceleration.rst
@@ -0,0 +1,29 @@
+.. _acceleration:
+
+Acceleration mode for sandbox
+=============================
+
+If you want to experiment with assets, you can use acceleration mode and start your assets name "TESTING".
+
+Acceleration mode was developed to enable testing in the sandbox and to reduce time frames of the periods. 
+
+To enable acceleration mode you will need to:
+    * add additional parameter `mode` with a value ``test``;
+    * set ``quick, accelerator=1440`` as text value for `sandboxParameters`. This parameter will accelerate auction periods. The number 1440 shows that restrictions and time frames will be reduced in 1440 times.
+
+**This mode will work only in the sandbox**.
+
+.............................
+
+Synchronization
+~~~~~~~~~~~~~~~
+
+* During normal auction synchronization via ``/auctions`` test auctions are not visible.
+
+* To get test auctions synchronize via ``/auctions?mode=test``.
+
+* If you synchronize via ``/auctions?mode=all``, then you will get all auctions.
+
+* Auction mode can be set only on lot creation (lots.auctions) phase, it can not be set later.
+
+.. note:: Can not be used for assets.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -33,6 +33,7 @@ Contents:
    performance
    dates
    errors
+   acceleration
 
 
 * :ref:`Authentication <openprocurementapi:authentication>`

diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -8,7 +8,7 @@ Features
 
 * Asset represents the initial information of an object to be privatized.
 * The object to be created should be switched from `draft` to `pending`.
-* Asset is being created with the automatically added `documentType: cancellationDetails`. 
+* Asset is being created with the automatically added `documentType: informationDetails`. 
 * Asset is a complicated entity the components of which are marked as items.
 * For the asset to be deleted, the specific document (`documentType: cancellationDetails`) has to be attached.
 
@@ -50,6 +50,12 @@ Documentation of related packages
 
 * `OpenProcurement API <http://api-docs.openprocurement.org/en/latest/>`_
 
+* `Lots Registry <http://lotsloki.api-docs.registry.ea2.openprocurement.io/en/latest/>`_
+
+* `Sellout.english <http://sellout-english.api-docs.ea2.openprocurement.io/en/latest/>`_
+
+* `Contracting <http://ceasefire.api-docs.ea2.openprocurement.io/en/latest/standard/contract.html>`_
+
 API stability
 -------------
 

diff --git a/docs/source/standard/asset.rst b/docs/source/standard/asset.rst
@@ -12,34 +12,36 @@ Schema
 ------
 
 :id:
-    string, auto-generated, read-only
+   uuid, auto-generated, read-only
+
+   Internal identifier for this asset.
 
 :assetID:
    string, auto-generated, read-only
 
    The asset identifier to refer to in the `paper` documentation. 
 
    |ocdsDescription|
-   AssetID is included to make the flattened data structure more convenient.
+   `AssetID` is included to make the flattened data structure more convenient.
 
 :date:
-    string, auto-generated, read-only
+    :ref:`Date`, auto-generated, read-only
 
     The date of asset creation/undoing.
 
-:owner:  
+:owner:
     string, auto-generated, read-only
 
     The entity whom the asset has been created by.
 
 :dateModified:
-    string, auto-generated, read-only
+    :ref:`Date`, auto-generated, read-only
 
     |ocdsDescription|
     Date when the asset was last modified.
 
 :rectificationPeriod:
-    :ref:`Period`, auto-generated
+    :ref:`Period`, auto-generated, read-only
 
     Period during which the owner of an asset can edit it.
 
@@ -50,22 +52,26 @@ Schema
 
     Possible values are:
 
-    * `draft`
-
-    * `pending`
-
-    * `verification`
-
-    * `active`
-
-    * `complete`
-
-    * `deleted`
++-------------------------+-------------------------------------+
+|        Status           |            Description              |
++=========================+=====================================+
+|  `draft`                | Asset created but not yet available |
++-------------------------+-------------------------------------+
+|  `pending`              | Asset entered in the register       |
++-------------------------+-------------------------------------+
+|  `verification`         | Asset availability check            |
++-------------------------+-------------------------------------+
+|  `active`               | Passes an auction on the asset      |
++-------------------------+-------------------------------------+
+|  `complete`             | Asset sold at auction               |
++-------------------------+-------------------------------------+
+|  `deleted`              | The asset has been deleted          |
++-------------------------+-------------------------------------+
 
 :relatedLot:
-    string, required in `active` status
+    uuid ,auto-generated, read-only
 
-    ID of the related Lot.
+    Internal id of the related Lot.
 
 :title:
     string, multilingual, required
@@ -76,7 +82,7 @@ Schema
 
     * ``title_ru`` (Russian) - Russian title
 
-    Oprionally can be mentioned in English/Russian.
+    Optionally can be mentioned in English/Russian.
 
 :description:
     string, multilingual, required
@@ -91,29 +97,34 @@ Schema
     * ``decription_ru`` (Russian) - Russian decription
 
 :documents:
-    array of :ref:`Documents`
+    Array of :ref:`Documents`, optional
 
     |ocdsDescription|
     All related documents and attachments.
 
 :assetCustodian:
    :ref:`Organization`, required
 
-   The entity managing the asset.
+   The entity managing the asset. For a small privatization, the role is carried out by the Privatization Authority.
 
 :assetHolder:
    :ref:`Organization`, optional
 
    The entity whom the asset was used to be owned by.
 
 :decisions:
-    array of :ref:`Decisions`, required
+    Array of :ref:`Decisions`, required
 
-:item:
-    array of :ref:`item`, required
+    The decision to privatize the asset. Approval of the terms of sale of the lot.
+
+:items:
+    Array of :ref:`items`, required
+
+    |ocdsDescription|
+    The goods, services, and any intangible outcomes in this contract.
 
 :mode:
-    optional
+    string, optional
 
     The additional parameter with a value `test`.
 
@@ -125,7 +136,7 @@ Schema
 :sandboxParameters:
    string, optional
 
-   Parameter that accelerates auction periods. Set quick, accelerator=1440 as text value for `sandboxParameters` for the time frames to be reduced in 1440 times.
+   Parameter that accelerates asset periods. Set quick, accelerator=1440 as text value for `sandboxParameters` for the time frames to be reduced in 1440 times.
 
 .. _decisions:
 
@@ -163,7 +174,7 @@ Schema
 .. _period:
 
 Period
-=======    
+======
 
 Schema
 ------

diff --git a/docs/source/standard/documents.rst b/docs/source/standard/documents.rst
@@ -12,7 +12,9 @@ Schema
 ------
 
 :id:
-    string, auto-generated
+    uuid, auto-generated, read-only
+
+    Internal identifier of the object within an array.
 
 :documentType:
     string, required
@@ -46,15 +48,36 @@ Schema
     * `x_dgfAssetFamiliarization` - **Asset Familiarization**
 
     Goods examination procedure rules / Asset familiarization procedure in data room. Contains information on where and when a given document can be examined offline.
-
+
+    * `clarifications` - **Clarifications to bidders questions**
+
+    Documentation that provides replies to issues raised in pre-bid conferences or an enquiry processes.
+
 :title:
     string, multilingual, required
 
+    * Ukrainian by default (required) - Ukrainian title
+
+    * ``title_en`` (English) - English title
+
+    * ``title_ru`` (Russian) - Russian title
+
+    Optionally can be mentioned in English/Russian.
+
     |ocdsDescription|
     The document title. 
 
 :description:
-    string, multilingual
+    string, multilingual, required
+
+    |ocdsDescription|
+    A description of the goods, services to be provided.
+
+    * Ukrainian by default - Ukrainian decription
+
+    * ``decription_en`` (English) - English decription
+
+    * ``decription_ru`` (Russian) - Russian decription
 
     |ocdsDescription|
     A short description of the document. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.
@@ -66,19 +89,19 @@ Schema
     The format of the document taken from the `IANA Media Types code list <http://www.iana.org/assignments/media-types/>`_, with the addition of one extra value for 'offline/print', used when this document entry is being used to describe the offline publication of a document. 
 
 :url:
-    string, auto-generated
+    string, auto-generated, read-only
 
     |ocdsDescription|
     Direct link to the document or attachment. 
 
 :datePublished:
-    string, :ref:`date`, auto-generated
+    :ref:`date`, auto-generated, read-only
 
     |ocdsDescription|
     The date on which the document was first published. 
 
 :dateModified:
-    string, :ref:`date`, auto-generated
+    :ref:`date`, auto-generated, read-only
 
     |ocdsDescription|
     Date that the document was last modified
@@ -95,9 +118,10 @@ Schema
     Possible values are:
 
     * `asset`
+    * `item`
 
 :relatedItem:
-    string, optional
+    uuid, optional
 
     Id of related :ref:`asset` or :ref:`item`.
 
@@ -108,4 +132,7 @@ Schema
     Sorting (display order) parameter used for illustrations. The smaller number is, the higher illustration is in the sorting. If index is not specified, illustration will be displayed the last. If two illustrations have the same index, they will be sorted depending on their publishing date.
 
 :accessDetails:
-    string, optional
+    string, optional
+
+    Required for `x_dgfAssetFamiliarization` document.
+
diff --git a/docs/source/standard/item.rst b/docs/source/standard/item.rst
@@ -3,7 +3,7 @@
 
 .. index:: Item, Parameter, Classification, CAV, Unit, registrationDetails
 
-.. _Item:
+.. _Items:
 
 Item
 ====
@@ -12,11 +12,22 @@ Schema
 ------
 
 :id:
-    string, auto-generated
+    uuid, auto-generated, read-only
+
+    Internal identifier for this item.
 
 :description:
     string, multilingual, required
-
+
+    |ocdsDescription|
+    A description of the goods, services to be provided.
+
+    * Ukrainian by default - Ukrainian decription
+
+    * ``decription_en`` (English) - English decription
+
+    * ``decription_ru`` (Russian) - Russian decription
+
     |ocdsDescription|
     A description of the goods, services to be provided.
 

diff --git a/docs/source/standard/organization.rst b/docs/source/standard/organization.rst
@@ -174,4 +174,4 @@ Schema
     |ocdsDescription|
     A web address for the contact point/person.
 
-Either `email` or `telephone` field has to be provided.
+.. note:: Either `email` or `telephone` field has to be provided.