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

schema/reference.md: remmove reference to contracts.relatedProcesses #1721

Open
wants to merge 3 commits into
base: 1.2-dev
Choose a base branch
from

Conversation

odscjen
Copy link
Contributor

@odscjen odscjen commented Nov 25, 2024

closes #1713

The language referring to "tender processes" will be covered by #1639 no longer relevant as these references have been removed entirely

Copy link
Contributor

@duncandewhurst duncandewhurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the note about adding a copy of the procurement plan to documents, I don't think the Markdown content above or below the jsonschema directive adds anything to the descriptions in the schema and codelist. Repeating all the information means that we have to keep it in sync with any future changes so I think it would be best to remove most of it and replace it with a quoted description of RelatedProcess (using the field-description directive) and a reference to the codelist, followed by the example and jsonschema directive e.g.

A RelatedProcess is defined as:

A reference to a related, preceding contracting (or planning) process. For example, the contracting process may refer to its planning process(es). In multi-stage procedures (e.g. framework agreements with reopening of competition), the contracting process for a later stage may refer to the contracting process for the first stage.

The Related Process codelist defines the possible types of relationship. Contracting processes should refer to related processes using the codes in the codelist.

As well as providing a machine-readable link between processes, publishers may also provide a link to human-readable documentation in the relevant documents array. For example, when a contracting process refers to a planning process, a link to the procurement plan can be provided in tender/documents.


There's a conflict between the Markdown, which says that relatedProcess should be used in the cases in the list, and the schema descriptions which say that contracting processes may refer to planning processes and earlier stages.

I think should is the correct normative strength so we should update the schema descriptions (of relatedProcesses and RelatedProcess) too.


Sound good?

@odscjen
Copy link
Contributor Author

odscjen commented Nov 28, 2024

That all sounds good to me, I'll make those changes

Copy link
Contributor

@duncandewhurst duncandewhurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy for you to request a review from James once my suggestions are applied.

docs/schema/reference.md Outdated Show resolved Hide resolved
docs/schema/reference.md Outdated Show resolved Hide resolved
@odscjen odscjen requested a review from jpmckinney November 29, 2024 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update schema reference for Contract.relatedProcesses
2 participants