Skip to content

Commit

Permalink
schema: Review description of release and ocid
Browse files Browse the repository at this point in the history
release:
- Change the first sentence to what OCDS is used for (not releases specifically, defined later).
- Remove sentence about what concepts releases cover, as this is done by the rest of the schema.
- Move "many releases" sentence before "previous releases" sentence, for better flow.
- Small copy-edit.

ocid:
- Restore two-sentence construction, to distinguish primary and secondary use cases.
- Clarify that the secondary use cases are alternative, not additional, semantics.
- Clarify the relationship between the release and process.
- Use "internal identifier" consistently.
  • Loading branch information
jpmckinney committed Jul 30, 2021
1 parent c211c6c commit 4abc3af
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions schema/release-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"id": "https://standard.open-contracting.org/schema/1__1__5/release-schema.json",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Schema for an Open Contracting Release",
"description": "OCDS releases are used for contracts in public procurement (including design contests), concessions, public-private partnerships, government asset sales and other contexts. A \"release\" provides data about a single contracting or planning process at a particular point in time. Releases inform about new tenders, awards, contracts and other updates. Releases may repeat or update information provided previously in this process. One process may have many releases.\\n\\nA \"compiled release\" follows the same structure as a release, but combines information about a contracting or planning process from multiple points in time into a single summary.\\n\\nOCDS defines a \"contracting process\" as: \"All the actions aimed at implementing one or more contracts. This covers tendering, awarding, contracting and implementation. It does not include actions linked to planning, as these are often less structured and may be linked to multiple contracting processes. In multiple stage procedures (e.g. framework agreements with reopening of competition), each round of competition is treated as a separate contracting process.\\n\\nProcedures that failed and were restarted are considered new processes.\\n\\nBoundaries between processes (e.g. whether two contracts result from a single process or from two processes) are set by buyers depending on their needs (e.g. efficient division of labor, clear communication with the market) and legislation (e.g. rules on using procedures and lots).\"\\n\\nOCDS defines a \"planning process\" as: \"All the actions aimed at planning one or more contracting processes. This covers, for example, establishing the rationale for the procurement, giving the market a general description of the purchase, getting the necessary budget, forecasting and conducting market research.\\n\\nPlanning processes are often less structured than contracting processes, so one or more planning processes may lead to one or more contracting processes.\"",
"description": "OCDS is used for contracts in public procurement (including design contests), concessions, public-private partnerships, government asset sales and other contexts. A \"release\" describes a single contracting or planning process at a particular point in time. One process may be described by many releases. A release may repeat or update the information provided in previous releases about the process.\\n\\nA \"compiled release\" follows the same structure as a release, but combines information about a contracting or planning process from multiple points in time into a single summary.\\n\\nOCDS defines a \"contracting process\" as: \"All the actions aimed at implementing one or more contracts. This covers tendering, awarding, contracting and implementation. It does not include actions linked to planning, as these are often less structured and may be linked to multiple contracting processes. In multiple stage procedures (e.g. framework agreements with reopening of competition), each round of competition is treated as a separate contracting process.\\n\\nProcedures that failed and were restarted are considered new processes.\\n\\nBoundaries between processes (e.g. whether two contracts result from a single process or from two processes) are set by buyers depending on their needs (e.g. efficient division of labor, clear communication with the market) and legislation (e.g. rules on using procedures and lots).\"\\n\\nOCDS defines a \"planning process\" as: \"All the actions aimed at planning one or more contracting processes. This covers, for example, establishing the rationale for the procurement, giving the market a general description of the purchase, getting the necessary budget, forecasting and conducting market research.\\n\\nPlanning processes are often less structured than contracting processes, so one or more planning processes may lead to one or more contracting processes.\"",
"type": "object",
"properties": {
"ocid": {
"title": "Open Contracting ID",
"description": "A globally unique identifier for this contracting process, this planning process, or this single stage of a multiple stage procedure. It is composed of an ocid prefix and a local identifier. It is encouraged to separate the ocds prefix and the internal identifier with a hyphen (`-`). For more information see the [Open Contracting Identifier guidance](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/identifiers/)",
"description": "A globally unique identifier for the contracting process that the release describes. Alternatively, this identifier can refer to a planning process or a single stage of a multiple stage procedure. It is composed of an ocid prefix and an internal identifier. It is encouraged to separate the ocds prefix and the internal identifier with a hyphen (`-`). For more information, see the [identifiers](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/identifiers/) reference.",
"type": "string",
"minLength": 1
},
Expand Down

0 comments on commit 4abc3af

Please sign in to comment.