Amplify Platform API v1.0.0 — usage

naftiko: 1.0.0-alpha2
info:
  label: Amplify Platform API v1.0.0 — usage
  description: 'Amplify Platform API v1.0.0 — usage. 5 operations. Lead operation: Axway Organization Usage. Self-contained
    Naftiko capability covering one Axway business surface.'
  tags:
  - Axway
  - usage
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AXWAY_API_KEY: AXWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: amplify-platform-usage
    baseUri: https://platform.axway.com/api/v1
    description: Amplify Platform API v1.0.0 — usage business capability. Self-contained, no shared references.
    resources:
    - name: org-org_id-usage
      path: /org/{org_id}/usage
      operations:
      - name: orgfindusage
        method: GET
        description: Axway Organization Usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          required: true
        - name: entitlement
          in: query
          type: string
        - name: from
          in: query
          type: string
        - name: month
          in: query
          type: number
        - name: skipcache
          in: query
          type: boolean
        - name: to
          in: query
          type: string
        - name: year
          in: query
          type: number
        - name: x-auth-token
          in: header
          type: string
    - name: usage
      path: /usage
      operations:
      - name: usagefind
        method: GET
        description: Axway Fetches Usage Reports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: endDate
          in: query
          type: number
        - name: env_guid
          in: query
          type: string
        - name: org_id
          in: query
          type: string
        - name: received
          in: query
          type: boolean
        - name: startDate
          in: query
          type: number
        - name: status
          in: query
          type: string
        - name: uploadMethod
          in: query
          type: string
        - name: limit
          in: query
          type: number
        - name: page
          in: query
          type: number
        - name: skip
          in: query
          type: number
      - name: usageupload
        method: POST
        description: Axway Uploads a Usage Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: usage-automatic
      path: /usage/automatic
      operations:
      - name: usageuploadautomatic
        method: POST
        description: Axway Uploads an Automatic Usage Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: usage-file_id
      path: /usage/{file_id}
      operations:
      - name: usagedownload
        method: GET
        description: Axway Downloads a Usage Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file_id
          in: path
          type: string
          required: true
        - name: org_guid
          in: query
          type: string
          required: true
        - name: timestamp
          in: query
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.AXWAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: amplify-platform-usage-rest
    port: 8080
    description: REST adapter for Amplify Platform API v1.0.0 — usage. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/org/{org-id}/usage
      name: org-org-id-usage
      description: REST surface for org-org_id-usage.
      operations:
      - method: GET
        name: orgfindusage
        description: Axway Organization Usage
        call: amplify-platform-usage.orgfindusage
        with:
          org_id: rest.org_id
          entitlement: rest.entitlement
          from: rest.from
          month: rest.month
          skipcache: rest.skipcache
          to: rest.to
          year: rest.year
          x-auth-token: rest.x-auth-token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/usage
      name: usage
      description: REST surface for usage.
      operations:
      - method: GET
        name: usagefind
        description: Axway Fetches Usage Reports
        call: amplify-platform-usage.usagefind
        with:
          endDate: rest.endDate
          env_guid: rest.env_guid
          org_id: rest.org_id
          received: rest.received
          startDate: rest.startDate
          status: rest.status
          uploadMethod: rest.uploadMethod
          limit: rest.limit
          page: rest.page
          skip: rest.skip
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: usageupload
        description: Axway Uploads a Usage Report
        call: amplify-platform-usage.usageupload
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/usage/automatic
      name: usage-automatic
      description: REST surface for usage-automatic.
      operations:
      - method: POST
        name: usageuploadautomatic
        description: Axway Uploads an Automatic Usage Report
        call: amplify-platform-usage.usageuploadautomatic
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/usage/{file-id}
      name: usage-file-id
      description: REST surface for usage-file_id.
      operations:
      - method: GET
        name: usagedownload
        description: Axway Downloads a Usage Report
        call: amplify-platform-usage.usagedownload
        with:
          file_id: rest.file_id
          org_guid: rest.org_guid
          timestamp: rest.timestamp
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: amplify-platform-usage-mcp
    port: 9090
    transport: http
    description: MCP adapter for Amplify Platform API v1.0.0 — usage. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: axway-organization-usage
      description: Axway Organization Usage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: amplify-platform-usage.orgfindusage
      with:
        org_id: tools.org_id
        entitlement: tools.entitlement
        from: tools.from
        month: tools.month
        skipcache: tools.skipcache
        to: tools.to
        year: tools.year
        x-auth-token: tools.x-auth-token
      outputParameters:
      - type: object
        mapping: $.
    - name: axway-fetches-usage-reports
      description: Axway Fetches Usage Reports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: amplify-platform-usage.usagefind
      with:
        endDate: tools.endDate
        env_guid: tools.env_guid
        org_id: tools.org_id
        received: tools.received
        startDate: tools.startDate
        status: tools.status
        uploadMethod: tools.uploadMethod
        limit: tools.limit
        page: tools.page
        skip: tools.skip
      outputParameters:
      - type: object
        mapping: $.
    - name: axway-uploads-usage-report
      description: Axway Uploads a Usage Report
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: amplify-platform-usage.usageupload
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: axway-uploads-automatic-usage-report
      description: Axway Uploads an Automatic Usage Report
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: amplify-platform-usage.usageuploadautomatic
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: axway-downloads-usage-report
      description: Axway Downloads a Usage Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: amplify-platform-usage.usagedownload
      with:
        file_id: tools.file_id
        org_guid: tools.org_guid
        timestamp: tools.timestamp
      outputParameters:
      - type: object
        mapping: $.