Skip to content

Commit

Permalink
Merge pull request #69 from haly-leshchuk/docsedit
Browse files Browse the repository at this point in the history
editing the standard
  • Loading branch information
annawzz committed Sep 18, 2017
2 parents deac949 + 85b0219 commit de4ca44
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/source/standard/award.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Schema
The date of the contract award.

:value:
List of :ref:`ESCOValue` objects, auto-generated, read-only
List of :ref:`Value` objects, auto-generated, read-only

|ocdsDescription|
The total value of this award.
Expand Down
8 changes: 1 addition & 7 deletions docs/source/standard/bid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,7 @@ Schema
* `deleted`

:value:
:ref:`ESCOValue`, required

Validation rules:

* `amount` should be greater than `Tender.minValue.amout`
* `currency` should either be absent or match `Tender.minValue.currency`
* `valueAddedTaxIncluded` should either be absent or match `Tender.minValue.valueAddedTaxIncluded`
:ref:`Value`, required

:subcontractingDetails:
string
Expand Down
2 changes: 1 addition & 1 deletion docs/source/standard/contract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Schema
List of :ref:`Organization` objects, auto-generated, read-only

:value:
`ESCOValue` object, auto-generated, read-only
`Value` object, auto-generated, read-only

|ocdsDescription|
The total value of this contract.
Expand Down
13 changes: 1 addition & 12 deletions docs/source/standard/item.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,8 @@ Schema
Description of the unit which the good comes in e.g. hours, kilograms.
Made up of a unit name, and the value of a single unit.

:quantity:
integer

|ocdsDescription|
The number of units required

:deliveryDate:
:ref:`Period`, required

Period during which the item should be delivered.

:deliveryAddress:
:ref:`Address`, required
:ref:`Address`, not required

Address, where the item should be delivered.

Expand Down
35 changes: 23 additions & 12 deletions docs/source/standard/lot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,15 @@ Schema

Detailed description of tender lot.

:minValue:
:ref:`minValue`, required

Total available tender lot budget. Bids smaller then ``minValue`` will be rejected.

:guarantee:
:ref:`Guarantee`

Bid guarantee

:minimalStep:
:ref:`value`, required
:minimalStepPercentage:
float, required

The minimal step of auction (reduction). Validation rules:

* `amount` should be less then `Lot.minValue.amount`
* `currency` should either be absent or match `Lot.minValue.currency`
* `valueAddedTaxIncluded` should either be absent or match `Lot.minValue.valueAddedTaxIncluded`
Minimum step increment of the energy service contract performance indicator during auction that is calculated on participant’s bid. Possible values: from 0.05 to 0.3 (from 0.5% to 3% respectively) with 3-digit precision after comma.

:auctionPeriod:
:ref:`period`, read-only
Expand All @@ -66,6 +57,26 @@ Schema
Cancelled tender lot

Status of the Lot.

:fundingKind:
string, required

Lot funding source. Possible values:
* budget - Budget funding.
* other - Supplier funding.
Default value: other

:yearlyPaymentsPercentageRange:
float, required

Fixed percentage of participant's cost reduction sum, with 3-digit precision after comma.

Possible values:
* from 0.8 to 1 (from 80% to 100% respectively) if lot:fundingKind:other. - Default value.
* from 0 to 0.8 (from 0% to 80% respectively) if lot:fundingKind:budget.

Input precision - 3-digit after comma.


Workflow
--------
Expand Down
37 changes: 22 additions & 15 deletions docs/source/standard/tender.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,12 @@ Schema
|ocdsDescription|
The entity managing the procurement, which may be different from the buyer who is paying / using the items being procured.

:minValue:
:ref:`minValue`, required

Calculated minimal energy service contract performance indicator. Bids smaller then ``minValue`` will be rejected.

|ocdsDescription|
The total estimated minValue of the procurement.

:NBUdiscountRate:
float, required

NBU Discount Rate.
NBU Discount Rate as of tender notice publication date. Possible values: from 0 to 0.99 (from 0% to 99% respectively), with 3-digit precision after comma (e.g. 00.000). NBUdiscountRate change is interpreted as a change of tender conditions.

:guarantee:
:ref:`Guarantee`

Expand Down Expand Up @@ -101,14 +95,11 @@ Schema
|ocdsDescription|
A list of all the companies who entered submissions for the tender.

:minimalStep:
:ref:`value`, required
:minimalStepPercentage:
:ref:`value`, Float, required.

The minimal step of auction (reduction). Validation rules:

* `amount` should be less then `Tender.minValue.amount`
* `currency` should either be absent or match `Tender.minValue.currency`
* `valueAddedTaxIncluded` should either be absent or match `Tender.minValue.valueAddedTaxIncluded`
Minimum step increment of the energy service contract performance indicator during auction that is calculated from participant’s bid.
Possible values: from 0.05 to 0.3 (from 0.5% to 3%), with 3-digit precision after comma.

:awards:
List of :ref:`award` objects
Expand Down Expand Up @@ -217,3 +208,19 @@ Schema
* `tenderPeriod.startDate`
* `enquiryPeriod.endDate`
* `tenderPeriod.endDate`

:fundingKind:
String, required.

Tender funding source. Possible values:
* budget - Budget funding.
* other - exclusively supplier’s funding.

Default value: other

:yearlyPaymentsPercentageRange:
float, required

Fixed percentage of participant's cost reduction sum, with 3-digit precision after comma. Possible values:
* from 0.8 to 1 (from 80% to 100% respectively) if tender:fundingKind:other. - Default value.
* from 0 to 0.8 (from 0% to 80% respectively) if tender:fundingKind:budget.
63 changes: 26 additions & 37 deletions docs/source/standard/util.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,22 @@ Value
Schema
------

:amount:
float, required

|ocdsDescription|
Amount as a number.

Should be positive.
:amountPerformance:
float, autogenerated

Calculated energy service contract performance indicator. Calculated by the energy service contract performance indicator energy service contract performance indicator formula.

:yearlyPaymentsPercentage:
float, autogenerated

The percentage of annual payments in favor of Bidder.

Possible values:
* from 0.8 to 1 (from 80% to 100% respectively) if fundingKind:other. - Default value.
* from 0 to 0.8 (from 0% to 80% respectively) if fundingKind:budget.

Input precision - 3 digits after comma.

:currency:
string, required

Expand All @@ -57,43 +65,24 @@ Schema
:valueAddedTaxIncluded:
bool, required

.. index:: ESCOValue
.. _escovalue:

ESCOValue
=========

Schema
------

:amount:
:amount:
float, autogenerated

Calculated energy service contract value. Calculated by the energy service

|ocdsDescription|
Amount as a number.

Should be positive.
:ContractDuration:
value, required.

:currency:
string, required

|ocdsDescription|
The currency in 3-letter ISO 4217 format.

:valueAddedTaxIncluded:
bool, required

:yearlyPayments:
float, required
Contract duration.
* Years: integer, required. Possible values: 0-15.
* Days: string, not required. Possible values: 0-364. Default value: 0.

:annualCostsReduction:
float, required
list of Floats, required.

Buyer’s annual costs reduction. A 21-element array where the 1st element indicates cost reduction starting from the period of tender notice publication date till the end of the year. Value can be changed only during active tendering period (active.tendering).

:contractDuration:
integer, required

.. index:: Revision, Change Tracking
.. _revision:

Revision
========
Expand Down

0 comments on commit de4ca44

Please sign in to comment.