diff --git a/README.md b/README.md index c1756aa..e93fbe9 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,43 @@ However, in cases where it is important to track documents on a milestone-by-mil Depending on the nature of the documents, publishers should consider duplicating information in the parent sections documents block also. +## Example + +During the implementation of a contract, the buyer sets milestones that the supplier needs to meet. Each of these milestones can have an associated document that offers more details about the met milestone: for example, a consultancy report: + +```json +{ + "contracts": [ + { + "id": "CO-40002-18-166811", + "awardID": "354469-jorge-augusto-zarate-leiva-1", + "implementation": { + "milestones": [ + { + "id": "fcrMXKIb3/o=", + "title": "Informe de Consultoria", + "type": "reporting", + "dueDate": "2020-02-13T00:00:00-04:00", + "dateMet": "2020-02-14T00:00:00-04:00", + "status": "met", + "documents": [ + { + "id": "QQ1cjJZ82Rk=", + "url": "https://www.contrataciones.gov.py/documentos/download/contrato_detalle_entregable/vki7v5RKGrA%253D", + "datePublished": "2020-02-17T13:38:25-04:00", + "language": "es", + "title": "informe_n__13_1581957505348.pdf", + "format": "application/pdf" + } + ] + } + ] + } + } + ] +} +``` + ## Issues Report issues for this extension in the [ocds-extensions repository](https://github.com/open-contracting/ocds-extensions/issues), putting the extension's name in the issue's title.