Terrain Discovery Environment API — Analyses

naftiko: 1.0.0-alpha2
info:
  label: Terrain Discovery Environment API — Analyses
  description: 'Terrain Discovery Environment API — Analyses. 5 operations. Lead operation: List Analyses. Self-contained
    Naftiko capability covering one Terrain Discovery Environment Api business surface.'
  tags:
  - Terrain Discovery Environment Api
  - Analyses
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TERRAIN_DISCOVERY_ENVIRONMENT_API_API_KEY: TERRAIN_DISCOVERY_ENVIRONMENT_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: terrain-analyses
    baseUri: https://de.cyverse.org/terrain
    description: Terrain Discovery Environment API — Analyses business capability. Self-contained, no shared references.
    resources:
    - name: secured-analyses
      path: /secured/analyses
      operations:
      - name: listanalyses
        method: GET
        description: List Analyses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of analyses to return
        - name: offset
          in: query
          type: integer
          description: Pagination offset
        - name: sort-field
          in: query
          type: string
          description: Field to sort by
        - name: filter
          in: query
          type: string
          description: JSON filter expression
      - name: submitanalysis
        method: POST
        description: Submit Analysis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: secured-analyses-analysis-id
      path: /secured/analyses/{analysis-id}
      operations:
      - name: getanalysis
        method: GET
        description: Get Analysis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: analysis-id
          in: path
          type: string
          description: The analysis UUID
          required: true
      - name: deleteanalysis
        method: DELETE
        description: Delete Analysis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: analysis-id
          in: path
          type: string
          required: true
    - name: secured-analyses-analysis-id-stop
      path: /secured/analyses/{analysis-id}/stop
      operations:
      - name: stopanalysis
        method: POST
        description: Stop Analysis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: analysis-id
          in: path
          type: string
          description: The analysis UUID
          required: true
    authentication:
      type: bearer
      token: '{{env.TERRAIN_DISCOVERY_ENVIRONMENT_API_API_KEY}}'
  exposes:
  - type: rest
    namespace: terrain-analyses-rest
    port: 8080
    description: REST adapter for Terrain Discovery Environment API — Analyses. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/secured/analyses
      name: secured-analyses
      description: REST surface for secured-analyses.
      operations:
      - method: GET
        name: listanalyses
        description: List Analyses
        call: terrain-analyses.listanalyses
        with:
          limit: rest.limit
          offset: rest.offset
          sort-field: rest.sort-field
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: submitanalysis
        description: Submit Analysis
        call: terrain-analyses.submitanalysis
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/secured/analyses/{analysis-id}
      name: secured-analyses-analysis-id
      description: REST surface for secured-analyses-analysis-id.
      operations:
      - method: GET
        name: getanalysis
        description: Get Analysis
        call: terrain-analyses.getanalysis
        with:
          analysis-id: rest.analysis-id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteanalysis
        description: Delete Analysis
        call: terrain-analyses.deleteanalysis
        with:
          analysis-id: rest.analysis-id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/secured/analyses/{analysis-id}/stop
      name: secured-analyses-analysis-id-stop
      description: REST surface for secured-analyses-analysis-id-stop.
      operations:
      - method: POST
        name: stopanalysis
        description: Stop Analysis
        call: terrain-analyses.stopanalysis
        with:
          analysis-id: rest.analysis-id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: terrain-analyses-mcp
    port: 9090
    transport: http
    description: MCP adapter for Terrain Discovery Environment API — Analyses. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-analyses
      description: List Analyses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: terrain-analyses.listanalyses
      with:
        limit: tools.limit
        offset: tools.offset
        sort-field: tools.sort-field
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-analysis
      description: Submit Analysis
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: terrain-analyses.submitanalysis
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-analysis
      description: Get Analysis
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: terrain-analyses.getanalysis
      with:
        analysis-id: tools.analysis-id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-analysis
      description: Delete Analysis
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: terrain-analyses.deleteanalysis
      with:
        analysis-id: tools.analysis-id
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-analysis
      description: Stop Analysis
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: terrain-analyses.stopanalysis
      with:
        analysis-id: tools.analysis-id
      outputParameters:
      - type: object
        mapping: $.