Skip to content

Commit

Permalink
Rearrange documentation of FDSN EHs to a separate section
Browse files Browse the repository at this point in the history
  • Loading branch information
chad-iris committed Dec 5, 2022
1 parent 10c9391 commit 68b730e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 14 deletions.
17 changes: 3 additions & 14 deletions extra-headers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,10 @@ Extra headers are specified and documented in `JSON Schema <http://json-schema.o
FDSN Reserved Headers
----------------------------

The key named **"FDSN"** with value of an JSON object in the root
container of the extra headers is reserved for definition by the FDSN.
The documentation and schema of these headers are specified in JSON
Schema here:
The **"FDSN"** key at the root of the extra headres are reserved for
definition by the FDSN.

.. raw:: html
:file: extra-headers/ExtraHeaders-FDSN-v1.0.schema.html

|
Download `FDSN Extra Header schema v1.0 <https://raw.githubusercontent.com/iris-edu/miniSEED3/main/extra-headers/ExtraHeaders-FDSN-v1.0.schema.json>`_.

When not present, the boolean values in the FDSN reserved headers
should be considered to be `false` unless otherwise documented. Such
values do not need to be included when the value is `false`.
See :ref:`fdsn-reserved-headers` for documentation of these headers.

See :ref:`example-fdsn-extra-headers` for an example of FDSN extra headers.

Expand Down
24 changes: 24 additions & 0 deletions fdsn-reserved.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _FDSN-reserved-headers:

======================
FDSN Reserved Headers
======================

The **"FDSN"** key at the root of the :ref:`extra-headers` are reserved for
definition by the FDSN. See :ref:`example-fdsn-extra-headers` for an example
of FDSN extra headers.

The FDSN reserved headers are defined and documented in `JSON Schema <http://json-schema.org/>`_.

Download the `FDSN Extra Header schema v1.0 <https://raw.githubusercontent.com/iris-edu/miniSEED3/main/extra-headers/ExtraHeaders-FDSN-v1.0.schema.json>`_.

The documentation and schema of these headers may be browsed here:

.. raw:: html
:file: extra-headers/ExtraHeaders-FDSN-v1.0.schema.html

|
When not present, the boolean values in the FDSN reserved headers
should be considered to be `false` unless otherwise documented. Such
values do not need to be included when the value is `false`.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ such as location, instrument response, etc.
definition
data-encodings
extra-headers
fdsn-reserved
background
appendix
software
Expand Down

0 comments on commit 68b730e

Please sign in to comment.