WSO2 API Manager - Governance — Rulesets

naftiko: 1.0.0-alpha2
info:
  label: WSO2 API Manager - Governance — Rulesets
  description: 'WSO2 API Manager - Governance — Rulesets. 7 operations. Lead operation: Retrieves a list of rulesets.. Self-contained
    Naftiko capability covering one Wso2 business surface.'
  tags:
  - Wso2
  - Rulesets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WSO2_API_KEY: WSO2_API_KEY
capability:
  consumes:
  - type: http
    namespace: governance-rulesets
    baseUri: https://apis.wso2.com/api/am/governance/v1
    description: WSO2 API Manager - Governance — Rulesets business capability. Self-contained, no shared references.
    resources:
    - name: rulesets
      path: /rulesets
      operations:
      - name: getrulesets
        method: GET
        description: Retrieves a list of rulesets.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: 'You can search for rulesets using the following format:'
      - name: createruleset
        method: POST
        description: Create a new ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rulesets-rulesetId
      path: /rulesets/{rulesetId}
      operations:
      - name: getrulesetbyid
        method: GET
        description: Retrieves details of a specific ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updaterulesetbyid
        method: PUT
        description: Updates a specific ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteruleset
        method: DELETE
        description: Deletes a specific ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rulesets-rulesetId-content
      path: /rulesets/{rulesetId}/content
      operations:
      - name: getrulesetcontent
        method: GET
        description: Retrieves the content of a specific ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rulesets-rulesetId-usage
      path: /rulesets/{rulesetId}/usage
      operations:
      - name: getrulesetusage
        method: GET
        description: Retrieves the policy usage of a specific ruleset.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WSO2_API_KEY}}'
  exposes:
  - type: rest
    namespace: governance-rulesets-rest
    port: 8080
    description: REST adapter for WSO2 API Manager - Governance — Rulesets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/rulesets
      name: rulesets
      description: REST surface for rulesets.
      operations:
      - method: GET
        name: getrulesets
        description: Retrieves a list of rulesets.
        call: governance-rulesets.getrulesets
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createruleset
        description: Create a new ruleset.
        call: governance-rulesets.createruleset
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}
      name: rulesets-rulesetid
      description: REST surface for rulesets-rulesetId.
      operations:
      - method: GET
        name: getrulesetbyid
        description: Retrieves details of a specific ruleset.
        call: governance-rulesets.getrulesetbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterulesetbyid
        description: Updates a specific ruleset.
        call: governance-rulesets.updaterulesetbyid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteruleset
        description: Deletes a specific ruleset.
        call: governance-rulesets.deleteruleset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}/content
      name: rulesets-rulesetid-content
      description: REST surface for rulesets-rulesetId-content.
      operations:
      - method: GET
        name: getrulesetcontent
        description: Retrieves the content of a specific ruleset.
        call: governance-rulesets.getrulesetcontent
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rulesets/{rulesetid}/usage
      name: rulesets-rulesetid-usage
      description: REST surface for rulesets-rulesetId-usage.
      operations:
      - method: GET
        name: getrulesetusage
        description: Retrieves the policy usage of a specific ruleset.
        call: governance-rulesets.getrulesetusage
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: governance-rulesets-mcp
    port: 9090
    transport: http
    description: MCP adapter for WSO2 API Manager - Governance — Rulesets. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-list-rulesets
      description: Retrieves a list of rulesets.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-rulesets.getrulesets
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-ruleset
      description: Create a new ruleset.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: governance-rulesets.createruleset
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-details-specific-ruleset
      description: Retrieves details of a specific ruleset.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-rulesets.getrulesetbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-specific-ruleset
      description: Updates a specific ruleset.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: governance-rulesets.updaterulesetbyid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-specific-ruleset
      description: Deletes a specific ruleset.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: governance-rulesets.deleteruleset
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-content-specific-ruleset
      description: Retrieves the content of a specific ruleset.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-rulesets.getrulesetcontent
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-policy-usage-specific-ruleset
      description: Retrieves the policy usage of a specific ruleset.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-rulesets.getrulesetusage
      outputParameters:
      - type: object
        mapping: $.