Jupyter Notebook REST API — Config

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Notebook REST API — Config
  description: 'Jupyter Notebook REST API — Config. 3 operations. Lead operation: Jupyter Notebook Get configuration section.
    Self-contained Naftiko capability covering one Jupyter Notebook business surface.'
  tags:
  - Jupyter Notebook
  - Config
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTER_NOTEBOOK_API_KEY: JUPYTER_NOTEBOOK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-config
    baseUri: http://localhost:8888/api
    description: Jupyter Notebook REST API — Config business capability. Self-contained, no shared references.
    resources:
    - name: api-config-section_name
      path: /api/config/{section_name}
      operations:
      - name: getconfig
        method: GET
        description: Jupyter Notebook Get configuration section
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: section_name
          in: path
          type: string
          description: Name of the configuration section.
          required: true
      - name: updateconfig
        method: PUT
        description: Jupyter Notebook Update configuration section
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: section_name
          in: path
          type: string
          description: Name of the configuration section.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchconfig
        method: PATCH
        description: Jupyter Notebook Patch configuration section
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: section_name
          in: path
          type: string
          description: Name of the configuration section.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: token
      value: '{{env.JUPYTER_NOTEBOOK_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: rest-config-rest
    port: 8080
    description: REST adapter for Jupyter Notebook REST API — Config. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/config/{section-name}
      name: api-config-section-name
      description: REST surface for api-config-section_name.
      operations:
      - method: GET
        name: getconfig
        description: Jupyter Notebook Get configuration section
        call: rest-config.getconfig
        with:
          section_name: rest.section_name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconfig
        description: Jupyter Notebook Update configuration section
        call: rest-config.updateconfig
        with:
          section_name: rest.section_name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchconfig
        description: Jupyter Notebook Patch configuration section
        call: rest-config.patchconfig
        with:
          section_name: rest.section_name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-config-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Notebook REST API — Config. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-notebook-get-configuration-section
      description: Jupyter Notebook Get configuration section
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-config.getconfig
      with:
        section_name: tools.section_name
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-update-configuration-section
      description: Jupyter Notebook Update configuration section
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-config.updateconfig
      with:
        section_name: tools.section_name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-patch-configuration-section
      description: Jupyter Notebook Patch configuration section
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-config.patchconfig
      with:
        section_name: tools.section_name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.