Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ktarasz committed Jun 10, 2016
1 parent 9192fdd commit 8aef5d8
Show file tree
Hide file tree
Showing 82 changed files with 849 additions and 816 deletions.
7 changes: 7 additions & 0 deletions docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
"value": {
"amount": 500
},
"status": "draft",
'selfEligible': True, 'selfQualified': True,
}
}
Expand Down Expand Up @@ -437,6 +438,11 @@ def test_docs(self):
bids_access[bid1_id] = response.json['access']['token']
self.assertEqual(response.status, '201 Created')

with open('docs/source/tutorial/activate-bidder.http', 'w') as self.app.file_obj:
response = self.app.patch_json('/tenders/{}/bids/{}?acc_token={}'.format(
self.tender_id, bid1_id, bids_access[bid1_id]), {"data": {"status": "active"}})
self.assertEqual(response.status, '200 OK')

#### Proposal Uploading
#

Expand Down Expand Up @@ -831,6 +837,7 @@ def test_award_complaints(self):
owner_token = response.json['access']['token']
self.tender_id = tender['id']

del bid['data']['status']
response = self.app.post_json('/tenders/{}/bids'.format(self.tender_id), bid)
bid_id = response.json['data']['id']
bid_token = response.json['access']['token']
Expand Down
3 changes: 2 additions & 1 deletion docs/source/standard/bid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Schema
string

Possible values are:


* `draft`
* `active`
* `invalid`
* `deleted`
Expand Down
7 changes: 6 additions & 1 deletion docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,16 @@ Registering bid

Tender status ``active.tendering`` allows registration of bids.

Bidder can register a bid:
Bidder can register a bid with draft status:

.. include:: tutorial/register-bidder.http
:code:

And activate a bid:

.. include:: tutorial/activate-bidder.http
:code:

Proposal Uploading
~~~~~~~~~~~~~~~~~~

Expand Down
16 changes: 16 additions & 0 deletions docs/source/tutorial/activate-bidder.http
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
PATCH /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/bids/e3cb06706d594846884fa7992e39158b?acc_token=142b755892374b0dbb628b556725c28e HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 30
Content-Type: application/json
Host: api-sandbox.openprocurement.org
DATA:
{
"data": {
"status": "active"
}
}

Response: 200 OK
Content-Type: application/json; charset=UTF-8
null

22 changes: 11 additions & 11 deletions docs/source/tutorial/active-cancellation.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/cancellations/de0380a2c83e49a5a6fb829c1301279b?acc_token=d2d5e9957a024ac2a7edb7cfddef84d3 HTTP/1.0
PATCH /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/cancellations/399e6b4aef4d45edaa2bb0c555eb38b4?acc_token=e374c63118b7417ca5a812b0c89b71cc HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 30
Content-Type: application/json
Expand All @@ -19,29 +19,29 @@ Content-Type: application/json; charset=UTF-8
{
"description": "Changed description",
"title": "Notice.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/cancellations/de0380a2c83e49a5a6fb829c1301279b/documents/9cfc64571a8948178ebfbf371e43d1cf?download=6f43e76c14db4806ba4986f562ca3bfb",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/cancellations/399e6b4aef4d45edaa2bb0c555eb38b4/documents/d392b397680747d59c1530ac791fc390?download=451860b8c7354c549cd1be83f69e667d",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-04-25T14:47:05.591231+03:00",
"id": "9cfc64571a8948178ebfbf371e43d1cf",
"dateModified": "2016-04-25T14:47:05.591276+03:00"
"datePublished": "2016-06-10T15:46:41.469405+03:00",
"id": "d392b397680747d59c1530ac791fc390",
"dateModified": "2016-06-10T15:46:41.469445+03:00"
},
{
"description": "Changed description",
"title": "Notice-2.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/cancellations/de0380a2c83e49a5a6fb829c1301279b/documents/9cfc64571a8948178ebfbf371e43d1cf?download=c1b07443a51d4b4fa75caf1a2f1bf32a",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/cancellations/399e6b4aef4d45edaa2bb0c555eb38b4/documents/d392b397680747d59c1530ac791fc390?download=d59fba2191184ef9888436a40142361f",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-04-25T14:47:05.591231+03:00",
"id": "9cfc64571a8948178ebfbf371e43d1cf",
"dateModified": "2016-04-25T14:47:06.063047+03:00"
"datePublished": "2016-06-10T15:46:41.469405+03:00",
"id": "d392b397680747d59c1530ac791fc390",
"dateModified": "2016-06-10T15:46:41.848012+03:00"
}
],
"reason": "cancellation reason",
"reasonType": "unsuccessful",
"date": "2016-04-25T14:47:05.206374+03:00",
"date": "2016-06-10T15:46:41.119927+03:00",
"cancellationOf": "tender",
"id": "de0380a2c83e49a5a6fb829c1301279b"
"id": "399e6b4aef4d45edaa2bb0c555eb38b4"
}
}

6 changes: 3 additions & 3 deletions docs/source/tutorial/answer-question.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/questions/82ee4fb0f71c43dcb503dd38a55335de?acc_token=d2d5e9957a024ac2a7edb7cfddef84d3 HTTP/1.0
PATCH /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/questions/c61901c6bc9841f09b86256fcdca3bcd?acc_token=e374c63118b7417ca5a812b0c89b71cc HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 162
Content-Type: application/json
Expand All @@ -16,9 +16,9 @@ Content-Type: application/json; charset=UTF-8
"data": {
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2016-04-25T14:47:00.936780+03:00",
"date": "2016-06-10T15:46:36.990524+03:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "82ee4fb0f71c43dcb503dd38a55335de",
"id": "c61901c6bc9841f09b86256fcdca3bcd",
"questionOf": "tender"
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
POST /api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/questions HTTP/1.0
POST /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/questions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 1506
Content-Type: application/json
Expand Down
8 changes: 4 additions & 4 deletions docs/source/tutorial/ask-question.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
POST /api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/questions HTTP/1.0
POST /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/questions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 1506
Content-Type: application/json
Expand Down Expand Up @@ -34,7 +34,7 @@ DATA:

Response: 201 Created
Content-Type: application/json; charset=UTF-8
Location: http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/questions/82ee4fb0f71c43dcb503dd38a55335de
Location: http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/questions/c61901c6bc9841f09b86256fcdca3bcd
{
"data": {
"description": "Просимо додати таблицю потрібної калорійності харчування",
Expand All @@ -60,8 +60,8 @@ Location: http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e421
}
},
"title": "Калорійність",
"date": "2016-04-25T14:47:00.936780+03:00",
"id": "82ee4fb0f71c43dcb503dd38a55335de",
"date": "2016-06-10T15:46:36.990524+03:00",
"id": "c61901c6bc9841f09b86256fcdca3bcd",
"questionOf": "tender"
}
}
Expand Down
66 changes: 33 additions & 33 deletions docs/source/tutorial/auction-url.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
GET /api/2.3/tenders/ecc90314cd2e42198d4effc825696a97 HTTP/1.0
GET /api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: api-sandbox.openprocurement.org

Expand All @@ -8,18 +8,18 @@ Content-Type: application/json; charset=UTF-8
"data": {
"procurementMethod": "open",
"complaintPeriod": {
"startDate": "2016-04-09T14:46:44.063881+03:00",
"endDate": "2016-04-21T14:46:44.063881+03:00"
"startDate": "2016-05-25T15:46:21.092158+03:00",
"endDate": "2016-06-06T15:46:21.092158+03:00"
},
"auctionUrl": "http://auction-sandbox.openprocurement.org/tenders/ecc90314cd2e42198d4effc825696a97",
"auctionUrl": "http://auction-sandbox.openprocurement.org/tenders/fd9fbaf7245d44b0b8706d5aa48817ab",
"enquiryPeriod": {
"startDate": "2016-04-09T14:46:44.063881+03:00",
"clarificationsUntil": "2016-04-20T14:46:44.063881+03:00",
"endDate": "2016-04-15T14:46:44.063881+03:00",
"invalidationDate": "2016-04-25T14:47:02.237434+03:00"
"startDate": "2016-05-25T15:46:21.092158+03:00",
"clarificationsUntil": "2016-06-03T15:46:21.092158+03:00",
"endDate": "2016-05-31T15:46:21.092158+03:00",
"invalidationDate": "2016-06-10T15:46:38.296658+03:00"
},
"submissionMethod": "electronicAuction",
"next_check": "2016-04-25T15:22:44.063881+03:00",
"next_check": "2016-06-10T16:22:21.092158+03:00",
"procuringEntity": {
"contactPoint": {
"url": "http://sch10.edu.vn.ua/",
Expand All @@ -45,58 +45,58 @@ Content-Type: application/json; charset=UTF-8
{
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2016-04-25T14:47:00.936780+03:00",
"date": "2016-06-10T15:46:36.990524+03:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "82ee4fb0f71c43dcb503dd38a55335de",
"id": "c61901c6bc9841f09b86256fcdca3bcd",
"questionOf": "tender"
}
],
"owner": "broker",
"id": "ecc90314cd2e42198d4effc825696a97",
"id": "fd9fbaf7245d44b0b8706d5aa48817ab",
"guarantee": {
"currency": "USD",
"amount": 8.0
},
"documents": [
{
"title": "Notice.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/documents/1efdd6c781634e22a8c561703bf815fc?download=41173225a7224e028bae9210bfe3fbb9",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/documents/6c400e10ade540718f1fa8155e28ad42?download=627854ebbbb745e7940040a5819496b1",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-04-25T14:47:00.410570+03:00",
"id": "1efdd6c781634e22a8c561703bf815fc",
"dateModified": "2016-04-25T14:47:00.410613+03:00"
"datePublished": "2016-06-10T15:46:36.569448+03:00",
"id": "6c400e10ade540718f1fa8155e28ad42",
"dateModified": "2016-06-10T15:46:36.569480+03:00"
},
{
"title": "AwardCriteria.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/documents/a0d6c53b95744260acc6dab57d74f6ae?download=6f644415b14e4f9b9cb8d1243c53821e",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/documents/fe55dcb656b84b8592af9b73494bd665?download=cf3419d21e74422aa1afbfdb29060545",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-04-25T14:47:00.541552+03:00",
"id": "a0d6c53b95744260acc6dab57d74f6ae",
"dateModified": "2016-04-25T14:47:00.541600+03:00"
"datePublished": "2016-06-10T15:46:36.713257+03:00",
"id": "fe55dcb656b84b8592af9b73494bd665",
"dateModified": "2016-06-10T15:46:36.713290+03:00"
},
{
"title": "AwardCriteria-2.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/ecc90314cd2e42198d4effc825696a97/documents/a0d6c53b95744260acc6dab57d74f6ae?download=f27312e2649e4e7a87f72974c7d3de84",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/fd9fbaf7245d44b0b8706d5aa48817ab/documents/fe55dcb656b84b8592af9b73494bd665?download=0cab672c4cc14af59b173f6c68afc765",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-04-25T14:47:00.541552+03:00",
"id": "a0d6c53b95744260acc6dab57d74f6ae",
"dateModified": "2016-04-25T14:47:00.777672+03:00"
"datePublished": "2016-06-10T15:46:36.713257+03:00",
"id": "fe55dcb656b84b8592af9b73494bd665",
"dateModified": "2016-06-10T15:46:36.848942+03:00"
}
],
"title": "футляри до державних нагород",
"tenderID": "UA-2016-04-25-000001",
"dateModified": "2016-04-25T14:47:03.075096+03:00",
"tenderID": "UA-2016-06-10-000001",
"dateModified": "2016-06-10T15:46:39.138909+03:00",
"status": "active.auction",
"tenderPeriod": {
"startDate": "2016-04-09T14:46:44.063881+03:00",
"endDate": "2016-04-25T14:46:44.063881+03:00"
"startDate": "2016-05-25T15:46:21.092158+03:00",
"endDate": "2016-06-10T15:46:21.092158+03:00"
},
"auctionPeriod": {
"startDate": "2016-04-25T14:46:44.063881+03:00",
"shouldStartAfter": "2016-04-25T14:46:44.063881+03:00"
"startDate": "2016-06-10T15:46:21.092158+03:00",
"shouldStartAfter": "2016-06-10T15:46:21.092158+03:00"
},
"procurementMethodType": "aboveThresholdUA",
"minimalStep": {
Expand Down Expand Up @@ -127,10 +127,10 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Київ"
},
"deliveryDate": {
"startDate": "2016-05-15T14:46:44.085637+03:00",
"endDate": "2016-06-14T14:46:44.085681+03:00"
"startDate": "2016-06-30T15:46:21.093225+03:00",
"endDate": "2016-07-30T15:46:21.093258+03:00"
},
"id": "da79cf99a20c4d7887973ede2711e6f7",
"id": "679e7db9d7f44ead836426dc89b1db95",
"unit": {
"code": "44617100-9",
"name": "item"
Expand Down
20 changes: 10 additions & 10 deletions docs/source/tutorial/award-complaint-accept.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/tenders/264ee260a5a0475ba406ebdb81d9de43/awards/22c157bfe6a143458c873fda1914538f/complaints/c5b4c5656f21473d9790f1ba1cc68342 HTTP/1.0
PATCH /api/2.3/tenders/0ce93a11f6b14fdca10cf8cd620c0590/awards/2e1bea72fbdf4d7e95b7dfe9d2b3ec62/complaints/10efe858183443a8af16f184288e11d2 HTTP/1.0
Authorization: Basic cmV2aWV3ZXI6
Content-Length: 32
Content-Type: application/json
Expand All @@ -19,12 +19,12 @@ Content-Type: application/json; charset=UTF-8
{
"author": "complaint_owner",
"title": "Complaint_Attachement.pdf",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/264ee260a5a0475ba406ebdb81d9de43/awards/22c157bfe6a143458c873fda1914538f/complaints/c5b4c5656f21473d9790f1ba1cc68342/documents/9497e8532bbc4e77bb49c1b24f8481a7?download=44862360caf847a592ddf38c4c2c20e9",
"url": "http://api-sandbox.openprocurement.org/api/2.3/tenders/0ce93a11f6b14fdca10cf8cd620c0590/awards/2e1bea72fbdf4d7e95b7dfe9d2b3ec62/complaints/10efe858183443a8af16f184288e11d2/documents/74f77864a60e45efa174d287b86b9f1e?download=74fe6fc867d54affa21b98071f4ae800",
"format": "application/pdf",
"documentOf": "tender",
"datePublished": "2016-05-06T11:05:26.867756+03:00",
"id": "9497e8532bbc4e77bb49c1b24f8481a7",
"dateModified": "2016-05-06T11:05:26.867795+03:00"
"datePublished": "2016-06-10T15:46:23.344709+03:00",
"id": "74f77864a60e45efa174d287b86b9f1e",
"dateModified": "2016-06-10T15:46:23.344742+03:00"
}
],
"description": "Умови виставлені замовником не містять достатньо інформації, щоб заявка мала сенс.",
Expand All @@ -50,13 +50,13 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Вінниця"
}
},
"dateAccepted": "2016-05-06T11:05:28.141635+03:00",
"dateSubmitted": "2016-05-06T11:05:27.030158+03:00",
"complaintID": "UA-2016-05-06-000001.1",
"date": "2016-05-06T11:05:26.546604+03:00",
"dateAccepted": "2016-06-10T15:46:24.660040+03:00",
"dateSubmitted": "2016-06-10T15:46:23.504231+03:00",
"complaintID": "UA-2016-06-10-000002.1",
"date": "2016-06-10T15:46:23.040718+03:00",
"acceptance": true,
"type": "complaint",
"id": "c5b4c5656f21473d9790f1ba1cc68342"
"id": "10efe858183443a8af16f184288e11d2"
}
}

16 changes: 8 additions & 8 deletions docs/source/tutorial/award-complaint-accepted-stopped.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/tenders/264ee260a5a0475ba406ebdb81d9de43/awards/22c157bfe6a143458c873fda1914538f/complaints/274d481e0f744d5299123c91712e0835 HTTP/1.0
PATCH /api/2.3/tenders/0ce93a11f6b14fdca10cf8cd620c0590/awards/2e1bea72fbdf4d7e95b7dfe9d2b3ec62/complaints/cdb0daf55a064cef921875d95d19a0a6 HTTP/1.0
Authorization: Basic cmV2aWV3ZXI6
Content-Length: 217
Content-Type: application/json
Expand All @@ -16,13 +16,13 @@ Content-Type: application/json; charset=UTF-8
{
"data": {
"status": "stopped",
"dateDecision": "2016-05-06T11:05:29.674948+03:00",
"dateDecision": "2016-06-10T15:46:26.246702+03:00",
"description": "Умови виставлені замовником не містять достатньо інформації, щоб заявка мала сенс.",
"title": "Недостатньо інформації",
"decision": "Тендер скасовується замовником",
"acceptance": true,
"dateCanceled": "2016-05-06T11:05:29.674974+03:00",
"dateAccepted": "2016-05-06T11:05:28.791432+03:00",
"dateCanceled": "2016-06-10T15:46:26.246731+03:00",
"dateAccepted": "2016-06-10T15:46:25.300396+03:00",
"author": {
"contactPoint": {
"email": "soleksuk@gmail.com",
Expand All @@ -44,11 +44,11 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Вінниця"
}
},
"dateSubmitted": "2016-05-06T11:05:27.735380+03:00",
"complaintID": "UA-2016-05-06-000001.5",
"date": "2016-05-06T11:05:27.733941+03:00",
"dateSubmitted": "2016-06-10T15:46:24.217569+03:00",
"complaintID": "UA-2016-06-10-000002.5",
"date": "2016-06-10T15:46:24.215895+03:00",
"type": "complaint",
"id": "274d481e0f744d5299123c91712e0835"
"id": "cdb0daf55a064cef921875d95d19a0a6"
}
}

0 comments on commit 8aef5d8

Please sign in to comment.