Apache OpenMeetings REST API — GroupService

naftiko: 1.0.0-alpha2
info:
  label: Apache OpenMeetings REST API — GroupService
  description: 'Apache OpenMeetings REST API — GroupService. 7 operations. Lead operation: Apache OpenMeetings Get_1. Self-contained
    Naftiko capability covering one Apache Openmeetings business surface.'
  tags:
  - Apache Openmeetings
  - GroupService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_OPENMEETINGS_API_KEY: APACHE_OPENMEETINGS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-groupservice
    baseUri: https://{host}:5443/openmeetings/services
    description: Apache OpenMeetings REST API — GroupService business capability. Self-contained, no shared references.
    resources:
    - name: group
      path: /group
      operations:
      - name: get1
        method: GET
        description: Apache OpenMeetings Get_1
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
      - name: add1
        method: POST
        description: Apache OpenMeetings Add_1
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: name
          in: query
          type: string
          description: The name of the group
          required: true
    - name: group-users-id
      path: /group/users/{id}
      operations:
      - name: getusers
        method: GET
        description: Apache OpenMeetings GetUsers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: id
          in: path
          type: integer
          description: the group id
          required: true
        - name: start
          in: query
          type: integer
          description: first record
          required: true
        - name: max
          in: query
          type: integer
          description: max records
          required: true
        - name: orderby
          in: query
          type: string
          description: orderby clause
          required: true
        - name: asc
          in: query
          type: boolean
          description: asc or desc
          required: true
    - name: group-id
      path: /group/{id}
      operations:
      - name: delete2
        method: DELETE
        description: Apache OpenMeetings Delete_2
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: id
          in: path
          type: integer
          description: the id of the group
          required: true
    - name: group-id-rooms-add-roomid
      path: /group/{id}/rooms/add/{roomid}
      operations:
      - name: addroom
        method: POST
        description: Apache OpenMeetings AddRoom
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: id
          in: path
          type: integer
          description: Id of group that the room is being paired with
          required: true
        - name: roomid
          in: path
          type: integer
          description: Id of room to be added
          required: true
    - name: group-id-users-userid
      path: /group/{id}/users/{userid}
      operations:
      - name: adduser
        method: POST
        description: Apache OpenMeetings AddUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: id
          in: path
          type: integer
          description: the USER id
          required: true
        - name: userid
          in: path
          type: integer
          description: the group id
          required: true
      - name: removeuser
        method: DELETE
        description: Apache OpenMeetings RemoveUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sid
          in: query
          type: string
          description: The SID of the User. This SID must be marked as Loggedin
          required: true
        - name: id
          in: path
          type: integer
          description: the USER id
          required: true
        - name: userid
          in: path
          type: integer
          description: the group id
          required: true
  exposes:
  - type: rest
    namespace: rest-groupservice-rest
    port: 8080
    description: REST adapter for Apache OpenMeetings REST API — GroupService. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/group
      name: group
      description: REST surface for group.
      operations:
      - method: GET
        name: get1
        description: Apache OpenMeetings Get_1
        call: rest-groupservice.get1
        with:
          sid: rest.sid
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: add1
        description: Apache OpenMeetings Add_1
        call: rest-groupservice.add1
        with:
          sid: rest.sid
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/group/users/{id}
      name: group-users-id
      description: REST surface for group-users-id.
      operations:
      - method: GET
        name: getusers
        description: Apache OpenMeetings GetUsers
        call: rest-groupservice.getusers
        with:
          sid: rest.sid
          id: rest.id
          start: rest.start
          max: rest.max
          orderby: rest.orderby
          asc: rest.asc
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/group/{id}
      name: group-id
      description: REST surface for group-id.
      operations:
      - method: DELETE
        name: delete2
        description: Apache OpenMeetings Delete_2
        call: rest-groupservice.delete2
        with:
          sid: rest.sid
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/group/{id}/rooms/add/{roomid}
      name: group-id-rooms-add-roomid
      description: REST surface for group-id-rooms-add-roomid.
      operations:
      - method: POST
        name: addroom
        description: Apache OpenMeetings AddRoom
        call: rest-groupservice.addroom
        with:
          sid: rest.sid
          id: rest.id
          roomid: rest.roomid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/group/{id}/users/{userid}
      name: group-id-users-userid
      description: REST surface for group-id-users-userid.
      operations:
      - method: POST
        name: adduser
        description: Apache OpenMeetings AddUser
        call: rest-groupservice.adduser
        with:
          sid: rest.sid
          id: rest.id
          userid: rest.userid
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removeuser
        description: Apache OpenMeetings RemoveUser
        call: rest-groupservice.removeuser
        with:
          sid: rest.sid
          id: rest.id
          userid: rest.userid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-groupservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache OpenMeetings REST API — GroupService. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: apache-openmeetings-get-1
      description: Apache OpenMeetings Get_1
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-groupservice.get1
      with:
        sid: tools.sid
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-add-1
      description: Apache OpenMeetings Add_1
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-groupservice.add1
      with:
        sid: tools.sid
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-getusers
      description: Apache OpenMeetings GetUsers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-groupservice.getusers
      with:
        sid: tools.sid
        id: tools.id
        start: tools.start
        max: tools.max
        orderby: tools.orderby
        asc: tools.asc
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-delete-2
      description: Apache OpenMeetings Delete_2
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-groupservice.delete2
      with:
        sid: tools.sid
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-addroom
      description: Apache OpenMeetings AddRoom
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-groupservice.addroom
      with:
        sid: tools.sid
        id: tools.id
        roomid: tools.roomid
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-adduser
      description: Apache OpenMeetings AddUser
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-groupservice.adduser
      with:
        sid: tools.sid
        id: tools.id
        userid: tools.userid
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-openmeetings-removeuser
      description: Apache OpenMeetings RemoveUser
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-groupservice.removeuser
      with:
        sid: tools.sid
        id: tools.id
        userid: tools.userid
      outputParameters:
      - type: object
        mapping: $.