SOAX Proxy Management API — Geo Targeting

naftiko: 1.0.0-alpha2
info:
  label: SOAX Proxy Management API — Geo Targeting
  description: 'SOAX Proxy Management API — Geo Targeting. 4 operations. Lead operation: List Mobile Carriers. Self-contained
    Naftiko capability covering one Soax business surface.'
  tags:
  - Soax
  - Geo Targeting
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SOAX_API_KEY: SOAX_API_KEY
capability:
  consumes:
  - type: http
    namespace: proxy-management-geo-targeting
    baseUri: https://partner.api.soax.com
    description: SOAX Proxy Management API — Geo Targeting business capability. Self-contained, no shared references.
    resources:
    - name: v1-geo-carriers
      path: /v1/geo/carriers
      operations:
      - name: listmobilecarriers
        method: GET
        description: List Mobile Carriers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: Filter carriers by country code
    - name: v1-geo-cities
      path: /v1/geo/cities
      operations:
      - name: listcities
        method: GET
        description: List Cities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: Filter cities by country code
    - name: v1-geo-isps
      path: /v1/geo/isps
      operations:
      - name: listwifiisps
        method: GET
        description: List WiFi ISPs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: Filter ISPs by country code
    - name: v1-geo-regions
      path: /v1/geo/regions
      operations:
      - name: listregions
        method: GET
        description: List Regions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: Filter regions by country code
    authentication:
      type: apikey
      key: api-key
      value: '{{env.SOAX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: proxy-management-geo-targeting-rest
    port: 8080
    description: REST adapter for SOAX Proxy Management API — Geo Targeting. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/geo/carriers
      name: v1-geo-carriers
      description: REST surface for v1-geo-carriers.
      operations:
      - method: GET
        name: listmobilecarriers
        description: List Mobile Carriers
        call: proxy-management-geo-targeting.listmobilecarriers
        with:
          country: rest.country
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/geo/cities
      name: v1-geo-cities
      description: REST surface for v1-geo-cities.
      operations:
      - method: GET
        name: listcities
        description: List Cities
        call: proxy-management-geo-targeting.listcities
        with:
          country: rest.country
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/geo/isps
      name: v1-geo-isps
      description: REST surface for v1-geo-isps.
      operations:
      - method: GET
        name: listwifiisps
        description: List WiFi ISPs
        call: proxy-management-geo-targeting.listwifiisps
        with:
          country: rest.country
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/geo/regions
      name: v1-geo-regions
      description: REST surface for v1-geo-regions.
      operations:
      - method: GET
        name: listregions
        description: List Regions
        call: proxy-management-geo-targeting.listregions
        with:
          country: rest.country
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: proxy-management-geo-targeting-mcp
    port: 9090
    transport: http
    description: MCP adapter for SOAX Proxy Management API — Geo Targeting. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-mobile-carriers
      description: List Mobile Carriers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proxy-management-geo-targeting.listmobilecarriers
      with:
        country: tools.country
      outputParameters:
      - type: object
        mapping: $.
    - name: list-cities
      description: List Cities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proxy-management-geo-targeting.listcities
      with:
        country: tools.country
      outputParameters:
      - type: object
        mapping: $.
    - name: list-wifi-isps
      description: List WiFi ISPs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proxy-management-geo-targeting.listwifiisps
      with:
        country: tools.country
      outputParameters:
      - type: object
        mapping: $.
    - name: list-regions
      description: List Regions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proxy-management-geo-targeting.listregions
      with:
        country: tools.country
      outputParameters:
      - type: object
        mapping: $.