Descriptive Sections

⚠️ FixSpec-Specific Vendor Extension

The descriptive section presented here is specific to FixSpec software and may not be supported by other implementations.

structure is the table of contents for the rendered documentation. It is an optional, ordered array of section objects. Each section has a label and an HTML content string.

json
"structure": [
  {
    "label": "Session Messages",
    "uri": "session-messages",
    "content": "<finspec data-type=\"message\" data-ref=\"abc123\"></finspec>"
  },
  {
    "label": "Application Messages",
    "content": "<p>The following messages are supported for order management.</p><finspec data-type=\"message\" data-ref=\"def456\"></finspec>"
  },
  {
    "label": "Re-usable Components",
    "content": "<finspec data-type=\"component\" data-ref=\"ghi789\"></finspec>"
  }
]

Embedding Fieldsets

⚠️ FixSpec Conformance Software Only!

Note that this reference to embedding fieldsets related only to FixSpec’s conformance software. For information on how to reference fieldsets in this portal software, see Inlined API & Schema References.

Within content, a custom HTML element of <finspec> is used to embed FIX messages (described elsewhere in the FinSpec). To achieve this, the renderer needs two, mandatory data- attributes:

Attribute Description
data-type The type of fieldset to render. Valid values are message, view, or component.
data-ref The unique key of the entry within the FinSpec.

Note that the <finspec> element typically has no internal content.