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

Add subschema descriptions #1711

Draft
wants to merge 7 commits into
base: 1.2-dev
Choose a base branch
from

Conversation

duncandewhurst
Copy link
Contributor

@duncandewhurst duncandewhurst commented Oct 24, 2024

Closes #1700

  • Add subschema descriptions
  • Remove Markdown content that duplicates information contained in a subschema description
  • Add introductory sentence before jsonschema directives
  • Remove erroneous extension list directive from Project subheading
  • Move Markdown content above jsonschema directives and examples

TO-DO:

  • Render new lines in release description (I copied the relevant part of the description from the release schema instead).
  • Check why some examples show parent object and some don't (e.g. ImmediateContainer)
  • Follow up on issue with the include option in the jsonschema directive (identifier is rendered when only id and name are specified in OrganizationReference) (PR created sphinxcontrib/jsonschema.py: Fix include and collapse logic OpenDataServices/sphinxcontrib-opendataservices-jsonschema#60)
  • Collapse objects that reference a subschema in jsonschema directives (e.g. Item/deliveryAddresses)
  • Consider moving more normative Markdown content to subschema descriptions
  • Check for additional information in reference descriptions, e.g. contracts vs Contract.

From #1467:

  • Move jsonschema directives and extension lists to the end of each section (in that order)
  • Link to guidance using seealso (replacing "For more information" sentences and note admonitions)

@duncandewhurst
Copy link
Contributor Author

duncandewhurst commented Nov 7, 2024

* [ ]  ~Render new lines in release description~ (I copied the relevant part of the description from the release schema instead).

Noting that we should check that the definitions of contracting and planning processes from the description of the release schema are featured prominently in the documentation.

Edit: I opened an issue: #1714

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

Release reference: Add subschema definitions
1 participant