API Evangelist security overlay for the NEXTDC AXON API

overlay: 1.0.0
info:
  title: API Evangelist security overlay for the NEXTDC AXON API
  version: 1.0.0
extends: ../openapi/_original/nextdc-axon-openapi.yml
x-generated: '2026-10-22'
x-method: generated
x-source: https://www.nextdc.com/knowledge-articles/axon-api-documentation
x-rationale: The AXON Swagger 2.0 contract declares a single api_key securityDefinition passed in the QUERY, and
  it sets no root security requirement. NEXTDC's AXON API Documentation v1.2.5 says the key is passed in the "X-API-Key"
  HTTP header in the format key:digest (HMAC, sha256), with an increasing, never-repeated millisecond unix-timestamp
  nonce in the "X-API-TS" header. This overlay adds the documented header schemes and a root requirement without
  mutating the original. The original query scheme is left in place.
actions:
- target: $.securityDefinitions
  description: Add the header-based schemes documented in AXON API Documentation v1.2.5.
  update:
    axonApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: AXON API key in the form key:digest. The digest is an HMAC-SHA256 calculated over the request
        method, path and nonce, as described in the AXON API documentation. Keys are issued through a NEXTDC pre-sales
        representative and are bound to an AXON user and source-IP allow list.
    axonNonce:
      type: apiKey
      in: header
      name: X-API-TS
      description: Increasing, never-repeated nonce (a unix timestamp in milliseconds or finer) that guards against
        replay.
- target: $
  description: Require both documented headers on every operation.
  update:
    security:
    - axonApiKey: []
      axonNonce: []
- target: $.info
  description: Point at the provider documentation.
  update:
    x-documentation: https://www.nextdc.com/knowledge-articles/axon-api-documentation
    x-api-evangelist-note: Sandbox host sandbox-api.axonvx.com, as linked by NEXTDC as the Swagger API Explorer.