API Reference — subpackage_importStorage.subpackage_importStorage/local

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_importStorage.subpackage_importStorage/local
  description: 'API Reference — subpackage_importStorage.subpackage_importStorage/local. 7 operations. Lead operation: Get
    all import storage. Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_importStorage.subpackage_importStorage/local
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-importstorage-subpackage-importstorage-local
    baseUri: http://localhost:8000
    description: API Reference — subpackage_importStorage.subpackage_importStorage/local business capability. Self-contained,
      no shared references.
    resources:
    - name: api-storages-localfiles
      path: /api/storages/localfiles/
      operations:
      - name: list
        method: GET
        description: Get all import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: project
          in: query
          type: integer
          description: Project ID
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: create
        method: POST
        description: Create import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-storages-localfiles-validate
      path: /api/storages/localfiles/validate
      operations:
      - name: validate
        method: POST
        description: Validate import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-storages-localfiles-id
      path: /api/storages/localfiles/{id}
      operations:
      - name: get
        method: GET
        description: Get import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: delete
        method: DELETE
        description: Delete import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: PATCH
        description: Update import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-storages-localfiles-id-sync
      path: /api/storages/localfiles/{id}/sync
      operations:
      - name: sync
        method: POST
        description: Sync import storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Storage ID
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-importstorage-subpackage-importstorage-local-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_importStorage.subpackage_importStorage/local. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/storages/localfiles
      name: api-storages-localfiles
      description: REST surface for api-storages-localfiles.
      operations:
      - method: GET
        name: list
        description: Get all import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.list
        with:
          ordering: rest.ordering
          project: rest.project
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/storages/localfiles/validate
      name: api-storages-localfiles-validate
      description: REST surface for api-storages-localfiles-validate.
      operations:
      - method: POST
        name: validate
        description: Validate import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.validate
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/storages/localfiles/{id}
      name: api-storages-localfiles-id
      description: REST surface for api-storages-localfiles-id.
      operations:
      - method: GET
        name: get
        description: Get import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.get
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/storages/localfiles/{id}/sync
      name: api-storages-localfiles-id-sync
      description: REST surface for api-storages-localfiles-id-sync.
      operations:
      - method: POST
        name: sync
        description: Sync import storage
        call: label-studio-subpackage-importstorage-subpackage-importstorage-local.sync
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-importstorage-subpackage-importstorage-local-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_importStorage.subpackage_importStorage/local. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: get-all-import-storage
      description: Get all import storage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.list
      with:
        ordering: tools.ordering
        project: tools.project
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-import-storage
      description: Create import storage
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-import-storage
      description: Validate import storage
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.validate
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-import-storage
      description: Get import storage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.get
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-import-storage
      description: Delete import storage
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-import-storage
      description: Update import storage
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sync-import-storage
      description: Sync import storage
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-importstorage-subpackage-importstorage-local.sync
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.