Skip to content

Commit

Permalink
Docs: Added URL to schema reference
Browse files Browse the repository at this point in the history
Added the URL object to the schema reference page, and also set
organization.additional_websites and service.additional_urls to be
collapsed in their relevant schema tables
  • Loading branch information
Matt Marshall committed Sep 26, 2024
1 parent 4625190 commit 09400fc
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions docs/hsds/schema_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Each `organization` object has the following fields:
:::{tab-item} Fields
```{jsonschema} ../../schema/compiled/service_with_definitions.json
:pointer: /definitions/organization
:collapse: funding,contacts,phones,locations,programs,organization_identifiers,attributes,metadata
:collapse: funding,contacts,phones,locations,programs,organization_identifiers,attributes,metadata,additional_websites
```
:::

Expand Down Expand Up @@ -73,7 +73,7 @@ Each `service` object has the following fields:

:::{tab-item} Fields
```{jsonschema} ../../schema/compiled/service_with_definitions.json
:collapse: phones,schedules,service_areas,service_at_locations,languages,organization,funding,cost_options,program,required_documents,contacts,attributes,metadata
:collapse: phones,schedules,service_areas,service_at_locations,languages,organization,funding,cost_options,program,required_documents,contacts,attributes,metadata,additional_urls
```
:::

Expand Down Expand Up @@ -679,6 +679,44 @@ Each `attribute` object has the following fields:

::::

### url

`url` is defined as:

```{jsoninclude-quote} ../../schema/compiled/service_with_definitions.json
:jsonpointer: /definitions/url/description
```

Each `url` object has the following fields:

::::{tab-set}

:::{tab-item} Fields
```{jsonschema} ../../schema/compiled/service_with_definitions.json
:pointer: /definitions/url
:collapse: taxonomy_term,metadata

```
:::

:::{tab-item} Schema
```{eval-rst}
.. jsoninclude:: ../../schema/url.json
:jsonpointer:
:title: url
```
:::

:::{tab-item} Example
```{eval-rst}
.. jsoninclude:: ../../examples/service_full.json
:jsonpointer: /url
:title: url
```

:::

::::

### metadata

Expand Down

0 comments on commit 09400fc

Please sign in to comment.