Fireblocks · API Governance Rules

Fireblocks — fireblocks network link rules

Spectral linting rules defining API design standards and conventions for Fireblocks.

10 Rules error 10
View Rules File View on GitHub

Rule Categories

fb

Rules

error
fb-response-only-objects
Responses must be objects.
$.paths.*.*.responses.*.content.application/json.schema
error
fb-no-readonly-properties
Read-only properties are not allowed.
$.components.schemas..properties.*.readOnly
error
fb-no-writeonly-properties
Write-only properties are not allowed.
$.components.schemas..properties.*.writeOnly
error
fb-no-object-path-parameters
Path parameters that are objects are not allowed.
$.components.parameters.*.schema$.paths.*.*.parameters[*].schema
error
fb-header-api-key
Path must define X-FBAPI-KEY header parameter.
$.paths.*.*.parameters
error
fb-header-timestamp
Path must define X-FBAPI-TIMESTAMP header parameter.
$.paths.*.*.parameters
error
fb-header-nonce
Path must define X-FBAPI-NONCE header parameter.
$.paths.*.*.parameters
error
fb-header-signature
Path must define X-FBAPI-SIGNATURE header parameter.
$.paths.*.*.parameters
error
fb-tags-camelcase
All tag names must be camelCase.
$.tags[*].name
error
fb-operation-ids-camelcase
All operation IDs must be camelCase.
$.paths.*.*.operationId

Spectral Ruleset

Raw ↑
# harvested from https://github.com/fireblocks/fireblocks-network-link/blob/b2b60ccd079efe2f3ec327a632850791cddb9ee6/v2/openapi/fireblocks-openapi-ruleset.yaml on 2026-10-09 — a Spectral ruleset published in the provider's own GitHub repository (fireblocks/fireblocks-network-link); found by GitHub code search, fetched verbatim
x-method: harvested
x-stamped: 2026-10-09
x-source-url: https://github.com/fireblocks/fireblocks-network-link/blob/b2b60ccd079efe2f3ec327a632850791cddb9ee6/v2/openapi/fireblocks-openapi-ruleset.yaml
# Ruleset for Spectral OpenAPI linter
# Documentation: https://docs.stoplight.io/docs/spectral/e5b9616d6d50c-rulesets

extends: [[spectral:oas, all]]

rules:
  operation-description: off

  oas3-api-servers: off
  info-license: off
  license-url: off
  contact-properties: off
  openapi-tags-alphabetical: off

  fb-response-only-objects:
    description: Responses must be objects.
    severity: error
    given: "$.paths.*.*.responses.*.content.application/json.schema"
    then:
      field: type
      function: pattern
      functionOptions:
        match: "^object$"

  fb-no-readonly-properties:
    description: Read-only properties are not allowed.
    severity: error
    given: "$.components.schemas..properties.*.readOnly"
    then:
      function: falsy

  fb-no-writeonly-properties:
    description: Write-only properties are not allowed.
    severity: error
    given: "$.components.schemas..properties.*.writeOnly"
    then:
      function: falsy

  fb-no-object-path-parameters:
    description: Path parameters that are objects are not allowed.
    severity: error
    given:
      - "$.components.parameters.*.schema"
      - "$.paths.*.*.parameters[*].schema"
    then:
      field: type
      function: pattern
      functionOptions:
        notMatch: "^object$"

  fb-header-api-key:
    description: Path must define X-FBAPI-KEY header parameter.
    severity: error
    given: "$.paths.*.*.parameters"
    then:
      function: schema
      functionOptions:
        schema:
          type: array
          contains:
            required: [name]
            properties:
              name:
                const: X-FBAPI-KEY

  fb-header-timestamp:
    description: Path must define X-FBAPI-TIMESTAMP header parameter.
    severity: error
    given: "$.paths.*.*.parameters"
    then:
      function: schema
      functionOptions:
        schema:
          type: array
          contains:
            required: [name]
            properties:
              name:
                const: X-FBAPI-TIMESTAMP

  fb-header-nonce:
    description: Path must define X-FBAPI-NONCE header parameter.
    severity: error
    given: "$.paths.*.*.parameters"
    then:
      function: schema
      functionOptions:
        schema:
          type: array
          contains:
            required: [name]
            properties:
              name:
                const: X-FBAPI-NONCE

  fb-header-signature:
    description: Path must define X-FBAPI-SIGNATURE header parameter.
    severity: error
    given: "$.paths.*.*.parameters"
    then:
      function: schema
      functionOptions:
        schema:
          type: array
          contains:
            required: [name]
            properties:
              name:
                const: X-FBAPI-SIGNATURE

  fb-tags-camelcase:
    description: All tag names must be camelCase.
    severity: error
    given: "$.tags[*].name"
    then:
      function: casing
      functionOptions:
        type: camel
    message: "{{description}} But {{path}}: \"{{value}}\""

  fb-operation-ids-camelcase:
    description: All operation IDs must be camelCase.
    severity: error
    given: "$.paths.*.*.operationId"
    then:
      function: casing
      functionOptions:
        type: camel
    message: "{{description}} But {{property}}: \"{{value}}\""

overrides:
  - files:
      - '**#/paths/~1accounts~1%7BaccountId%7D~1transfers~1deposits~1addresses'
      - '**#/paths/~1accounts~1%7BaccountId%7D~1transfers~1deposits~1addresses~1%7Bid%7D'
    rules:
      operation-singular-tag: off

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset
curl "https://apis.io/api/v1/rules/fireblocks-fireblocks-network-link-spectral-rules"
All spectral rules
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.