F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations

naftiko: 1.0.0-alpha2
info:
  label: F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations
  description: 'F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations. 2 operations. Lead operation: F5
    Load Balancer Submit a Declarative Onboarding declaration. Self-contained Naftiko capability covering one F5 Load Balancer
    business surface.'
  tags:
  - F5 Load Balancer
  - Declarations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    F5_LOAD_BALANCER_API_KEY: F5_LOAD_BALANCER_API_KEY
capability:
  consumes:
  - type: http
    namespace: declarative-onboarding-declarations
    baseUri: https://{bigip_host}/mgmt/shared/declarative-onboarding
    description: F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations business capability. Self-contained,
      no shared references.
    resources:
    - name: root
      path: /
      operations:
      - name: submitonboardingdeclaration
        method: POST
        description: F5 Load Balancer Submit a Declarative Onboarding declaration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getonboardingdeclaration
        method: GET
        description: F5 Load Balancer Retrieve the current DO declaration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: statusCodes
          in: query
          type: string
          description: When set to legacy, uses status codes compatible with older DO versions.
    authentication:
      type: apikey
      key: X-F5-Auth-Token
      value: '{{env.F5_LOAD_BALANCER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: declarative-onboarding-declarations-rest
    port: 8080
    description: REST adapter for F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1
      name: root
      description: REST surface for root.
      operations:
      - method: POST
        name: submitonboardingdeclaration
        description: F5 Load Balancer Submit a Declarative Onboarding declaration
        call: declarative-onboarding-declarations.submitonboardingdeclaration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getonboardingdeclaration
        description: F5 Load Balancer Retrieve the current DO declaration
        call: declarative-onboarding-declarations.getonboardingdeclaration
        with:
          statusCodes: rest.statusCodes
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: declarative-onboarding-declarations-mcp
    port: 9090
    transport: http
    description: MCP adapter for F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO) API — Declarations. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: f5-load-balancer-submit-declarative
      description: F5 Load Balancer Submit a Declarative Onboarding declaration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: declarative-onboarding-declarations.submitonboardingdeclaration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-retrieve-current
      description: F5 Load Balancer Retrieve the current DO declaration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: declarative-onboarding-declarations.getonboardingdeclaration
      with:
        statusCodes: tools.statusCodes
      outputParameters:
      - type: object
        mapping: $.