OptScale REST API — Organizations

naftiko: 1.0.0-alpha2
info:
  label: OptScale REST API — Organizations
  description: 'OptScale REST API — Organizations. 4 operations. Lead operation: List organizations. Self-contained Naftiko
    capability covering one Optscale business surface.'
  tags:
  - Optscale
  - Organizations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPTSCALE_API_KEY: OPTSCALE_API_KEY
capability:
  consumes:
  - type: http
    namespace: optscale-organizations
    baseUri: https://{host}/restapi/v2
    description: OptScale REST API — Organizations business capability. Self-contained, no shared references.
    resources:
    - name: organizations
      path: /organizations
      operations:
      - name: listorganizations
        method: GET
        description: List organizations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorganization
        method: POST
        description: Create an organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organization_id
      path: /organizations/{organization_id}
      operations:
      - name: getorganization
        method: GET
        description: Get an organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteorganization
        method: DELETE
        description: Delete an organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.OPTSCALE_API_KEY}}'
  exposes:
  - type: rest
    namespace: optscale-organizations-rest
    port: 8080
    description: REST adapter for OptScale REST 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: listorganizations
        description: List organizations
        call: optscale-organizations.listorganizations
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorganization
        description: Create an organization
        call: optscale-organizations.createorganization
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization-id}
      name: organizations-organization-id
      description: REST surface for organizations-organization_id.
      operations:
      - method: GET
        name: getorganization
        description: Get an organization
        call: optscale-organizations.getorganization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteorganization
        description: Delete an organization
        call: optscale-organizations.deleteorganization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: optscale-organizations-mcp
    port: 9090
    transport: http
    description: MCP adapter for OptScale REST API — Organizations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-organizations
      description: List organizations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: optscale-organizations.listorganizations
      outputParameters:
      - type: object
        mapping: $.
    - name: create-organization
      description: Create an organization
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: optscale-organizations.createorganization
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-organization
      description: Get an organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: optscale-organizations.getorganization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-organization
      description: Delete an organization
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: optscale-organizations.deleteorganization
      outputParameters:
      - type: object
        mapping: $.