Skip to content

Commit

Permalink
Merge branch '0.3-dev' into 198-nav-link-cove
Browse files Browse the repository at this point in the history
  • Loading branch information
Bjwebb committed Jun 23, 2023
2 parents 874c31b + ed8a68a commit f35ebb5
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/guidance/publication.md
Expand Up @@ -102,7 +102,7 @@ If you’re concerned about disclosing the exact location of fibre infrastructur

### How to add additional fields

The OFDS schema does not restrict the use of additional fields. If there is a data element that you wish to publish for which you cannot identify a suitable mapping in OFDS, you can add an additional field to your data.
The OFDS schema does not restrict the use of additional fields, except where noted in the [schema reference](../reference/schema.md). If there is a data element that you wish to publish for which you cannot identify a suitable mapping in OFDS, you can add an additional field to your data.

Before adding an additional field, you ought to search the [standard issue tracker](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/issues) to see if a similar concept has already been discussed. If there are no existing discussions, you ought to open a new issue and describe the concept that you want to publish and your proposed modelling.

Expand Down
1 change: 1 addition & 0 deletions docs/history/changelog.md
Expand Up @@ -30,6 +30,7 @@ Iterative improvements are made outside of the release cycle. They do not involv
- [#258](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/258) - Add unit to `Span.fibreLength` description.
- [#260](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/260) - Replace `id` with `$id` and `definitions` with `$defs` in schema files.
- [#261](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/261), [#270](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/270) - Replace `publisher` with an object.
- [#274](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/274) - Disallow additional properties in `Geometry` objects.

### Codelists

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/schema.md
Expand Up @@ -300,6 +300,8 @@ This component is referenced by the following properties:
- [`Node/location`](network-schema.json,/$defs/Node,location)
- [`Span/route`](network-schema.json,/$defs/Span,route)

Additional properties are not permitted within `Geometry` objects.

Each `Geometry` has the following fields:

::::{tab-set}
Expand Down
3 changes: 3 additions & 0 deletions manage.py
Expand Up @@ -455,6 +455,9 @@ def update_schema_docs(schema):
url += ','.join(ref)
definition["content"].append(f"- [`{'/'.join(ref)}`]({url})\n")

if definition.get('additionalProperties') == False:
definition["content"].append(f"\nAdditional properties are not permitted within `{defn}` objects.\n")

# Add schema table
definition["content"].extend([
f"\nEach `{defn}` has the following fields:\n\n",
Expand Down
4 changes: 1 addition & 3 deletions schema/network-schema.json
Expand Up @@ -1218,9 +1218,7 @@
"coordinates"
],
"minProperties": 1,
"propertyNames": {
"pattern": "^(?!(properties$|^features$))"
}
"additionalProperties": false
},
"OrganisationReference": {
"title": "Organisation reference",
Expand Down

0 comments on commit f35ebb5

Please sign in to comment.