Skip to content

Commit

Permalink
codelists.md: add toctree
Browse files Browse the repository at this point in the history
  • Loading branch information
odscjen committed Nov 26, 2024
1 parent 0b468af commit 9e1ef69
Showing 1 changed file with 63 additions and 29 deletions.
92 changes: 63 additions & 29 deletions docs/schema/codelists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

Some schema fields refer to codelists, to limit and standardize the possible values of the fields, in order to promote data interoperability.

Codelists can either be open or closed. **Closed codelists** are intended to be comprehensive; for example, the [currency](#currency) codelist covers all currencies in the world. **Open codelists** are intended to be representative, but not comprehensive.
Codelists can either be open or closed;

* **Closed codelists** are intended to be comprehensive; for example, the [currency](#currency) codelist covers all currencies in the world.
* **Open codelists** are intended to be representative, but not comprehensive.

Publishers must use the codes in the codelists, unless no code is appropriate. If no code is appropriate and the codelist is **open**, then a publisher may use a new code outside those in the codelist. If no code is appropriate and the codelist is **closed**, then a publisher is encouraged to create an issue in the [OCDS GitHub repository](https://github.com/open-contracting/standard/issues) about adding a new code.

Expand All @@ -16,58 +19,89 @@ The release schema, in [JSON Schema](../../build/current_lang/release-schema.jso

Codes are case-sensitive, and are generally provided as English language camelCase. Codes must not be translated, though the OCDS team will work with publishers to translate code titles and definitions.

## All Codelists
[Contract Status](codelists/contractStatus.md)

[Award Criteria](codelists/awardCriteria.md)

### [Award Criteria](codelists/awardCriteria.md)
[Award Final Status](codelists/awardFinalStatus.md)

### [Award Final Status](codelists/awardFinalStatus.md)
[Award Status](codelists/awardStatus.md)

### [Award Status](codelists/awardStatus.md)
[Classification Scheme](codelists/classificationScheme.md)

### [Classification Scheme](codelists/classificationScheme.md)
[Contract Final Status](codelists/contractFinalStatus.md)

### [Contract Final Status](codelists/contractFinalStatus.md)
[Country](codelists/country.md)

### [Contract Status](codelists/contractStatus.md)
[Currency](codelists/currency.md)

### [Country](codelists/country.md)
[Document Type](codelists/documentType.md)

### [Currency](codelists/currency.md)
[Extended Procurement Category](codelists/extendedProcurementCategory.md)

### [Document Type](codelists/documentType.md)
[Initiation Type](codelists/initiationType.md)

### [Extended Procurement Category](codelists/extendedProcurementCategory.md)
[Language](codelists/language.md)

### [Initiation Type](codelists/initiationType.md)
[Link Relation Type](codelists/linkRelationType.md)

### [Language](codelists/language.md)
[Media Type](codelists/mediaType.md)

### [Link Relation Type](codelists/linkRelationType.md)
[Method](codelists/method.md)

### [Media Type](codelists/mediaType.md)
[Milestone Status](codelists/milestoneStatus.md)

### [Method](codelists/method.md)
[Milestone Type](codelists/milestoneType.md)

### [Milestone Status](codelists/milestoneStatus.md)
[Organization Identifier Scheme](codelists/organizationIdentifierScheme.md)

### [Milestone Type](codelists/milestoneType.md)
[Organization Role](codelists/partyRole.md)

### [Organization Identifier Scheme](codelists/organizationIdentifierScheme.md)
[Party Scale](codelists/partyScale.md)

### [Organization Role](codelists/partyRole.md)
[Procurement Category](codelists/procurementCategory.md)

### [Party Scale](codelists/partyScale.md)
[Release Tag](codelists/releaseTag.md)

### [Procurement Category](codelists/procurementCategory.md)
[Related Process](codelists/relatedProcess.md)

### [Release Tag](codelists/releaseTag.md)
[Related Process](codelists/relatedProcessScheme.md)

### [Related Process](codelists/relatedProcess.md)
[Submission Method](codelists/submissionMethod.md)

### [Related Process](codelists/relatedProcessScheme.md)
[Tender Final Status](codelists/tenderFinalStatus.md)

### [Submission Method](codelists/submissionMethod.md)
[Tender Status](codelists/tenderStatus.md)

### [Tender Final Status](codelists/tenderFinalStatus.md)
```{toctree}
:hidden:
### [Tender Status](codelists/tenderStatus.md)
codelists/awardCriteria
codelists/awardFinalStatus
codelists/awardStatus
codelists/classificationScheme
codelists/contractFinalStatus
codelists/contractStatus
codelists/country
codelists/currency
codelists/documentType
codelists/extendedProcurementCategory
codelists/initiationType
codelists/language
codelists/linkRelationType
codelists/mediaType
codelists/method
codelists/milestoneStatus
codelists/milestoneType
codelists/organizationIdentifierScheme
codelists/partyRole
codelists/partyScale
codelists/procurementCategory
codelists/relatedProcess
codelists/relatedProcessScheme
codelists/releaseTag
codelists/submissionMethod
codelists/tenderFinalStatus
codelists/tenderStatus
codelists/unitClassificationScheme
```

0 comments on commit 9e1ef69

Please sign in to comment.