naftiko: 1.0.0-alpha2
info:
  label: FOSSology API — Groups
  description: 'FOSSology API — Groups. 8 operations. Lead operation: Get the list of groups. Self-contained Naftiko capability
    covering one Fossology business surface.'
  tags:
  - Fossology
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FOSSOLOGY_API_KEY: FOSSOLOGY_API_KEY
capability:
  consumes:
  - type: http
    namespace: fossology-groups
    baseUri: http://localhost/repo/api/v1
    description: FOSSology API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups
      path: /groups
      operations:
      - name: getgroups
        method: GET
        description: Get the list of groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: creategroup
        method: POST
        description: Create a new group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: header
          type: string
          description: Name of the new group
          required: true
    - name: groups-deletable
      path: /groups/deletable
      operations:
      - name: deletablegroups
        method: GET
        description: Give a list of deletable groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-id
      path: /groups/{id}
      operations:
      - name: deletegroupbyid
        method: DELETE
        description: Delete group by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-id-members
      path: /groups/{id}/members
      operations:
      - name: getgroupuserswithroles
        method: GET
        description: Get the users with their roles from a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-id-user-userId
      path: /groups/{id}/user/{userId}
      operations:
      - name: deletegroupmemberbygroupidanduserid
        method: DELETE
        description: Delete group member by groupId and userId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addmember
        method: POST
        description: Add user to a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatepermissionbygroupidanduserid
        method: PUT
        description: Update Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.FOSSOLOGY_API_KEY}}'
  exposes:
  - type: rest
    namespace: fossology-groups-rest
    port: 8080
    description: REST adapter for FOSSology API — Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/groups
      name: groups
      description: REST surface for groups.
      operations:
      - method: GET
        name: getgroups
        description: Get the list of groups
        call: fossology-groups.getgroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: Create a new group
        call: fossology-groups.creategroup
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/deletable
      name: groups-deletable
      description: REST surface for groups-deletable.
      operations:
      - method: GET
        name: deletablegroups
        description: Give a list of deletable groups
        call: fossology-groups.deletablegroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}
      name: groups-id
      description: REST surface for groups-id.
      operations:
      - method: DELETE
        name: deletegroupbyid
        description: Delete group by id
        call: fossology-groups.deletegroupbyid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}/members
      name: groups-id-members
      description: REST surface for groups-id-members.
      operations:
      - method: GET
        name: getgroupuserswithroles
        description: Get the users with their roles from a group
        call: fossology-groups.getgroupuserswithroles
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}/user/{userid}
      name: groups-id-user-userid
      description: REST surface for groups-id-user-userId.
      operations:
      - method: DELETE
        name: deletegroupmemberbygroupidanduserid
        description: Delete group member by groupId and userId
        call: fossology-groups.deletegroupmemberbygroupidanduserid
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addmember
        description: Add user to a group
        call: fossology-groups.addmember
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatepermissionbygroupidanduserid
        description: Update Permission
        call: fossology-groups.updatepermissionbygroupidanduserid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fossology-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for FOSSology API — Groups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-list-groups
      description: Get the list of groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-groups.getgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-group
      description: Create a new group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fossology-groups.creategroup
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: give-list-deletable-groups
      description: Give a list of deletable groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-groups.deletablegroups
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group-id
      description: Delete group by id
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fossology-groups.deletegroupbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: get-users-their-roles-group
      description: Get the users with their roles from a group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-groups.getgroupuserswithroles
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group-member-groupid-and
      description: Delete group member by groupId and userId
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fossology-groups.deletegroupmemberbygroupidanduserid
      outputParameters:
      - type: object
        mapping: $.
    - name: add-user-group
      description: Add user to a group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fossology-groups.addmember
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-permission
      description: Update Permission
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fossology-groups.updatepermissionbygroupidanduserid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.