Organizations API — Organizations

naftiko: 1.0.0-alpha2
info:
  label: Organizations API — Organizations
  description: 'Organizations API — Organizations. 6 operations. Lead operation: Retrieves Organizations. Self-contained Naftiko
    capability covering one Organizations Api business surface.'
  tags:
  - Organizations Api
  - Organizations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORGANIZATIONS_API_API_KEY: ORGANIZATIONS_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: organizations-organizations
    baseUri: https://api.example.com
    description: Organizations API — Organizations business capability. Self-contained, no shared references.
    resources:
    - name: organizations
      path: /organizations
      operations:
      - name: getorganizations
        method: GET
        description: Retrieves Organizations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorganization
        method: POST
        description: Organizations Create Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId
      path: /organizations/{organizationId}
      operations:
      - name: getorganization
        method: GET
        description: Organizations Retrieve Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateorganization
        method: PUT
        description: Organizations Update Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteorganization
        method: DELETE
        description: Organizations Delete Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organizationId-cancle
      path: /organizations/{organizationId}/cancle
      operations:
      - name: sendorganization
        method: PUT
        description: Organizations Cancel Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: api-key
      value: '{{env.ORGANIZATIONS_API_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: organizations-organizations-rest
    port: 8080
    description: REST adapter for Organizations API — Organizations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations
      name: organizations
      description: REST surface for organizations.
      operations:
      - method: GET
        name: getorganizations
        description: Retrieves Organizations
        call: organizations-organizations.getorganizations
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorganization
        description: Organizations Create Organization
        call: organizations-organizations.createorganization
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}
      name: organizations-organizationid
      description: REST surface for organizations-organizationId.
      operations:
      - method: GET
        name: getorganization
        description: Organizations Retrieve Organization
        call: organizations-organizations.getorganization
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorganization
        description: Organizations Update Organization
        call: organizations-organizations.updateorganization
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteorganization
        description: Organizations Delete Organization
        call: organizations-organizations.deleteorganization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/cancle
      name: organizations-organizationid-cancle
      description: REST surface for organizations-organizationId-cancle.
      operations:
      - method: PUT
        name: sendorganization
        description: Organizations Cancel Organization
        call: organizations-organizations.sendorganization
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: organizations-organizations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Organizations API — Organizations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: retrieves-organizations
      description: Retrieves Organizations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organizations-organizations.getorganizations
      outputParameters:
      - type: object
        mapping: $.
    - name: organizations-create-organization
      description: Organizations Create Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: organizations-organizations.createorganization
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: organizations-retrieve-organization
      description: Organizations Retrieve Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organizations-organizations.getorganization
      outputParameters:
      - type: object
        mapping: $.
    - name: organizations-update-organization
      description: Organizations Update Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: organizations-organizations.updateorganization
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: organizations-delete-organization
      description: Organizations Delete Organization
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: organizations-organizations.deleteorganization
      outputParameters:
      - type: object
        mapping: $.
    - name: organizations-cancel-organization
      description: Organizations Cancel Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: organizations-organizations.sendorganization
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.