Skip to content

Commit c6d33e0

Browse files
myroslavmyroslav
committed
Adding stubs for role-based phase-centered sections
1 parent 4b5a6d5 commit c6d33e0

5 files changed

Lines changed: 225 additions & 0 deletions

File tree

‎docs/source/bidding.rst‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
.. _bidding:
2+
3+
Bidder Operations
4+
=================
5+
6+
Registration of Bid proposal
7+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8+
9+
.. sourcecode:: http
10+
11+
POST /tenders/64e93250be76435397e8c992ed4214d1/bidders/ HTTP/1.1
12+
13+
.. sourcecode:: http
14+
15+
HTTP/1.1 201 Created
16+
Location: /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607
17+
18+
Uploading Bid documents
19+
~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
.. sourcecode:: http
22+
23+
POST /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607/documents HTTP/1.1
24+
25+
.. sourcecode:: http
26+
27+
HTTP/1.1 201 Created
28+
Location: /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607/documents/bd2e4c64179445cab93987fff3d58d23
29+
30+
31+
Update of proposal
32+
~~~~~~~~~~~~~~~~~~
33+
34+
.. sourcecode:: http
35+
36+
PUT /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607 HTTP/1.1
37+
38+
.. sourcecode:: http
39+
40+
HTTP/1.1 200 OK
41+
42+
Updating Bid documents
43+
~~~~~~~~~~~~~~~~~~~~~~
44+
45+
.. sourcecode:: http
46+
47+
POST /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607/documents HTTP/1.1
48+
49+
.. sourcecode:: http
50+
51+
HTTP/1.1 201 Created
52+
Location: /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607/documents/bd2e4c64179445cab93987fff3d58d23
53+
54+
Cancelling the proposal
55+
~~~~~~~~~~~~~~~~~~~~~~~
56+
57+
.. sourcecode:: http
58+
59+
DELETE /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa607 HTTP/1.1
60+
61+
.. sourcecode:: http
62+
63+
HTTP/1.1 200 OK
64+
65+
Bids Listing
66+
~~~~~~~~~~~~
67+
68+
.. sourcecode:: http
69+
70+
GET /tenders/64e93250be76435397e8c992ed4214d1/bidders/ HTTP/1.1
71+
72+
.. sourcecode:: http
73+
74+
HTTP/1.1 200 OK
75+
76+
Retrieving the proposal
77+
~~~~~~~~~~~~~~~~~~~~~~~
78+
79+
.. sourcecode:: http
80+
81+
GET /tenders/64e93250be76435397e8c992ed4214d1/bidders/4879d3f8ee2443169b5fbbc9f89fa60 HTTP/1.1
82+
83+
.. sourcecode:: http
84+
85+
HTTP/1.1 200 OK

‎docs/source/index.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Contents:
2020
errors
2121
dates
2222
tutorial
23+
tenders
24+
procuring
25+
bidding
26+
qualification
2327
reference
2428

2529
Please report any problems or suggestions for improvement either via the

‎docs/source/procuring.rst‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
.. _procuring:
2+
3+
Procuring Entity Operations
4+
===========================
5+
6+
Registration of the Tender
7+
--------------------------
8+
Tender registration consist of primary record creation and documentation uploading.
9+
10+
Creating primary Tender record
11+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12+
When registering tender in the database, one has provide all primary tender details (except binary documents) in payload of request.
13+
14+
.. sourcecode:: http
15+
16+
POST /tenders HTTP/1.1
17+
18+
The response produced will have URL of the tender created in Location header of resoponse, and in ``data.id`` of body.
19+
20+
.. sourcecode:: http
21+
22+
HTTP/1.1 201 Created
23+
Location: /tenders/64e93250be76435397e8c992ed4214d1
24+
25+
Uploading documentation
26+
~~~~~~~~~~~~~~~~~~~~~~~
27+
All tender documentation should be uploaded following requests one request per document.
28+
29+
.. sourcecode:: http
30+
31+
POST /tenders/64e93250be76435397e8c992ed4214d1/documents HTTP/1.1
32+
33+
The response produced will have URL of the tender document uploaded in Location header of resoponse, and in ``data.id`` of body.
34+
35+
.. sourcecode:: http
36+
37+
HTTP/1.1 201 Created
38+
Location: /tenders/64e93250be76435397e8c992ed4214d1/documents/6a7d13bd8ec449e08882aeb92180d938
39+
40+
Changing the Tender
41+
-------------------
42+
Procuring Entity can change both the primary record and associated documentation.
43+
44+
.. If Tenders state does not allow such change the request will fail with Unauthorized response.
45+
46+
Changing primary Tender Record
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
Procuring Entity can change the Tender properties with following request. Data to change should be in payload of the message.
49+
50+
.. sourcecode:: http
51+
52+
PATCH /tenders/64e93250be76435397e8c992ed4214d1 HTTP/1.1
53+
54+
.. sourcecode:: http
55+
56+
HTTP/1.1 200 OK
57+
58+
Changing existing documents
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
60+
Procuring Entity can upload new versions of the tender documentation.
61+
62+
.. sourcecode:: http
63+
64+
PUT /tenders/64e93250be76435397e8c992ed4214d1/documents/6a7d13bd8ec449e08882aeb92180d938 HTTP/1.1
65+
66+
.. sourcecode:: http
67+
68+
HTTP/1.1 200 OK
69+
70+
Uploading additional documents
71+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72+
The same as Uploading documentation

‎docs/source/qualification.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _qualification:
2+
3+
Qualification Operations
4+
========================
5+
6+
Contract Awarding
7+
~~~~~~~~~~~~~~~~~
8+
9+
.. sourcecode:: http
10+
11+
POST /tenders/64e93250be76435397e8c992ed4214d1/awards HTTP/1.1
12+
13+
{
14+
"data":{
15+
"awardStatus": "pending"
16+
}
17+
}
18+
19+
.. sourcecode:: http
20+
21+
HTTP/1.1 201 Created
22+
Location: /tenders/64e93250be76435397e8c992ed4214d1/awards/ea36a10ad89649ccac253f23d8e0e80d HTTP/1.1
23+
24+
Disqualification
25+
~~~~~~~~~~~~~~~~
26+
27+
.. sourcecode:: http
28+
29+
POST /tenders/64e93250be76435397e8c992ed4214d1/awards HTTP/1.1
30+
31+
{
32+
"data":{
33+
"awardStatus": "unsuccessful"
34+
}
35+
}
36+
37+
.. sourcecode:: http
38+
39+
HTTP/1.1 201 Created
40+
Location: /tenders/64e93250be76435397e8c992ed4214d1/awards/ea36a10ad89649ccac253f23d8e0e80d HTTP/1.1

‎docs/source/tenders.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _tenders:
2+
3+
Retrieving Tender Information
4+
=============================
5+
6+
Getting list of all tenders
7+
---------------------------
8+
.. sourcecode:: http
9+
10+
GET /tenders HTTP/1.1
11+
12+
.. sourcecode:: http
13+
14+
HTTP/1.1 200 OK
15+
16+
Reading the individual tender information
17+
-----------------------------------------
18+
.. sourcecode:: http
19+
20+
GET /tenders/64e93250be76435397e8c992ed4214d1 HTTP/1.1
21+
22+
.. sourcecode:: http
23+
24+
HTTP/1.1 200 OK

0 commit comments

Comments
 (0)