Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/schema/: create individual pages for all codelists #1718

Draft
wants to merge 4 commits into
base: 1.2-dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
385 changes: 67 additions & 318 deletions docs/schema/codelists.md

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions docs/schema/codelists/awardCriteria.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Award Criteria

{bdg-link-secondary}`open<../../codelists/#codelists>`

The award criteria codelist describes the basis on which contract awards will be made.

```{versionchanged} 1.1
Added all new codes. Deprecated all old codes, which were undefined.
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/awardCriteria.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/awardFinalStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Award Final Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/awardFinalStatus.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/awardStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Award Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{deprecated} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/awardStatus.csv
```
10 changes: 10 additions & 0 deletions docs/schema/codelists/classificationScheme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Classification Scheme

{bdg-link-secondary}`open<../../codelists/#codelists>`

The `classificationScheme` codelist is referenced by the `scheme` field of the `Classification` object, which can be used in multiple contexts. You can find the codes relevant to a given context by filtering the codelist by its `Category` column.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/classificationScheme.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/contractFinalStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contract Final Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/contractFinalStatus.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/contractStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contract Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{deprecated} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/contractStatus.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/country.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Country

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.2
```

The country codelist is used to provide the country component of an address, using uppercase two-letter codes from [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html). The country codelist adds a user-assigned code for Kosovo ('XK').

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/country.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/currency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Currency

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.1
```

The currency for each amount must be specified using the uppercase 3-letter currency code from [ISO4217](https://www.iso.org/iso-4217-currency-codes.html).

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/currency.csv
```
14 changes: 14 additions & 0 deletions docs/schema/codelists/documentType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Document Type

{bdg-link-secondary}`open<../../codelists/#codelists>`

The following list describes documents and documentation recommended for publication as part of an open contracting implementation. The codelist indicates the section of an OCDS release they are most likely to be applicable within.

The code descriptions are necessarily broad, to cover their usage in a range of contracting (or planning) processes, including for goods, services and works, and in other contexts, such as public private partnerships, infrastructure or concession contracts.

Publishers must map their existing document codes to this list, where possible. If using this list within a user interface, publishers can re-write the codelist titles and descriptions appropriately for the context they are being used in.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/documentType.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/extendedProcurementCategory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Extended Procurement Category

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.1
```

The extended procurement category codelist is used to provide additional detail about the focus of a contracting (or planning) process.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/extendedProcurementCategory.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/initiationType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Initiation Type

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{deprecated} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/initiationType.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Language

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.2
```

The language codelist is used to provide the default language used in text fields and the language of linked documents, using two-letter codes from [ISO639-1](https://id.loc.gov/vocabulary/iso639-1.html).

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/language.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/linkRelationType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Link Relation Type

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.2
```

The link relation type codelist is based on a subset of the [IANA Link Relation Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml) list.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/linkRelationType.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/mediaType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Media Type

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.2
```

The media type codelist is based on the [IANA Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml) list. The media type codelist adds an exceptional code for printed documents ('offline/print'), and omits any media type that is marked as deprecated or obsolete by IANA.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/mediaType.csv
```
14 changes: 14 additions & 0 deletions docs/schema/codelists/method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Method

{bdg-link-primary}`closed<../../codelists/#codelists>`

The procurement method describes which organizations can submit a bid. The method codelist draws upon [the definitions of open, selective and limited provided by the WTO Government Procurement Agreement](https://www.wto.org/english/docs_e/legal_e/rev-gpr-94_01_e.htm), and adds an additional 'direct' code for awards without competition.

```{versionchanged} 1.1
Added the 'direct' code.
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/method.csv
```
12 changes: 12 additions & 0 deletions docs/schema/codelists/milestoneStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Milestone Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionchanged} 1.1
Added the 'scheduled' code.
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/milestoneStatus.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/milestoneType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Milestone Type

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.1
```

The milestone block can be used to represent a wide variety of events in the lifetime of a contracting (or planning) process. The milestone type codelist is used to indicate the nature of each milestone.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/milestoneType.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/organizationIdentifierScheme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Organization Identifier Scheme

{bdg-link-secondary}`open<../../codelists/#codelists>`

![org-id.guide](../../_static/png/org-id_logo.png)

The Organization Identifier Scheme uses the codes from [org-id.guide](http://org-id.guide). The latest version of the codelist can be [downloaded](http://org-id.guide/download.csv) or [browsed](http://org-id.guide) from its website.

To add new codes to the codelist, contact the [Data Support Team](../../support/index).

```{versionchanged} 1.1
The `organizationIdentifierRegistrationAgency_iati.csv` file was removed. This list was formerly maintained by the International Aid Transparency Initiative.
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/partyRole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Organization Role

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.1
```

The organizations participating in a contracting (or planning) process are listed in the [parties section](../reference.md#parties). In a given process, a single organization can have one or more roles.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/partyRole.csv
```
24 changes: 24 additions & 0 deletions docs/schema/codelists/partyScale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Party Scale

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.2
```

The party scale codelist is used to indicate the size or scale of an organization, in particular commercial enterprises or economic operators.

The codes in the codelist do not have precise definitions. Instead, they defer to local laws and regulations, for example:

* [OECD: Small and Medium-Sized Enterprises (SMEs) definition](https://stats.oecd.org/glossary/detail.asp?ID=3123)
* [European Commission: What is an SME?](https://ec.europa.eu/growth/smes/sme-definition_en)

For small and medium-sized enterprises, if you can distinguish between the two sizes, use the 'small' and 'medium' codes. Otherwise, use the 'sme' code.

For self-employed individuals and sole traders, if you can distinguish them from micro enterprises, use the 'selfEmployed' code. Otherwise, use the 'micro' code.

For enterprises without employees, use the 'micro' code.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/partyScale.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/procurementCategory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Procurement Category

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.1
```

The procurement category codelist is used to indicate the **primary** focus of a contracting (or planning) process. Where a contracting (or planning) process covers more than one of the options below, publishers should use the `additionalProcurementCategories` field with an array of entries from the open [extendedProcurementCategory](extendedProcurementCategory.md) codelist.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/procurementCategory.csv
```
23 changes: 23 additions & 0 deletions docs/schema/codelists/relatedProcess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Related Process

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.1
```

```{versionchanged} 1.2
Added 'parent'. Deprecated 'subContract', 'replacementProcess' and 'renewalProcess'.
```

```{field-description} ../../../build/current_lang/release-schema.json /definitions/RelatedProcess
```

```{seealso}
* [Map: Contracting processes and planning processes](../../guidance/map/contracting_planning_processes.md)
* [Map: Framework agreements](../../guidance/map/framework_agreements.md)
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/relatedProcess.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/relatedProcessScheme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Related Process Scheme

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{versionadded} 1.1
```

The related process scheme describes the kind of identifier used to cross-reference another process.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/relatedProcessScheme.csv
```
16 changes: 16 additions & 0 deletions docs/schema/codelists/releaseTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Release Tag

{bdg-link-secondary}`open<../../codelists/#open-codelists>`

A contracting (or planning) process can result in a number of releases of information over time. A release must be tagged to indicate whether it is about a planning process or a contracting process and, if it is about the latter, to indicate the stage of the contracting process to which it relates.

Additional codes may be used to label releases, based on user needs: for example, to indicate the notice or form to which a release corresponds.

```{versionchanged} 1.1
Added the 'planningUpdate' code.
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/releaseTag.csv
```
13 changes: 13 additions & 0 deletions docs/schema/codelists/submissionMethod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Submission Method

{bdg-link-secondary}`open<../../codelists/#codelists>`

```{deprecated} 1.2
```

The submission method codelist is used to identify the mechanism through which a submission can be made.

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/submissionMethod.csv
```
11 changes: 11 additions & 0 deletions docs/schema/codelists/tenderFinalStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Tender Final Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{versionadded} 1.2
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/tenderFinalStatus.csv
```
15 changes: 15 additions & 0 deletions docs/schema/codelists/tenderStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Tender Status

{bdg-link-primary}`closed<../../codelists/#codelists>`

```{deprecated} 1.2
```

```{versionchanged} 1.1
Added the 'planning' and 'withdrawn' codes.
```

```{csv-table-no-translate}
:header-rows: 1
:file: ../../../build/current_lang/codelists/tenderStatus.csv
```
Loading
Loading