Akeda Settings fields API

openapi: 3.2.0
info:
  title: Akeda ERP Client Settings fields API
  version: 0.21.0-core-public
  summary: Проверяемый публичный контракт Go API Akeda ERP
  license:
    name: Proprietary
    identifier: LicenseRef-Akeda-Proprietary
  description: 'Этот контракт описывает API Akeda ERP. Полный исходный файл используют

    проверки живых Go-маршрутов, внутренние клиенты и реестр MCP. Скачиваемый

    клиентский контракт в `/docs` содержит только отобранные внешние методы;

    административные методы кабинета показаны отдельно после входа, а

    платформенные операторские методы остаются во внутреннем источнике.

    Стадия `public` означает обещание совместимости; `preview` допускает

    изменение формы. Аудитория, стадия и `security` — разные признаки:

    наличие метода в полном файле само по себе не выдаёт вызывающему право.

    Сервер отдельно проверяет тип токена, кабинет, scope и права на запись.

    Актуальные числа покрытия берите из генерируемой карты маршрутов и

    каталога покрытия, а не из описательного текста.'
servers:
- url: https://erp.akeda.ru
  description: PROD
security:
- erpUserToken: []
- tenantApiKey: []
- mcpOAuth:
  - akeda:delegate
tags:
- name: Settings fields
  description: Модуль settings (участники, роли, юрлица) — дополнительные поля карточек
paths:
  /api/v1/settings/field-schema:
    get:
      tags:
      - Settings fields
      operationId: settingsGetFieldSchema
      summary: Получить действующую схему дополнительных полей
      description: Только действующие определения полей вида сущности. От схемы реквизитов номенклатуры (/api/v1/core/products/custom-fields/schema) отличается тремя вещами — строка несёт ещё is_active, created_at и updated_at; вид сущности принимается любой, а пустой параметр означает все виды сразу; выборка обрезана 200 строками.
      x-akeda-module: settings
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: settings:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: entity_type
        in: query
        schema:
          type: string
        description: Вид сущности; пустое значение означает все виды
      responses:
        '200':
          description: Действующие определения полей
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsFieldSchema'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/settings/field-definitions:
    get:
      tags:
      - Settings fields
      operationId: settingsListFieldDefinitions
      summary: Получить определения дополнительных полей
      description: Все определения вида сущности, включая выключенные; порядок задают вид сущности, сортировка и подпись.
      x-akeda-module: settings
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: settings:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: entity_type
        in: query
        schema:
          type: string
        description: Вид сущности; пустое значение означает все виды
      responses:
        '200':
          description: Определения полей
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsFieldDefinitionPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Settings fields
      operationId: settingsCreateFieldDefinition
      summary: Завести определение дополнительного поля
      description: Обязательны вид сущности, ключ и подпись. Пустой type подставляется как text. Новое определение всегда заводится действующим, поэтому is_active из тела на заведении не читается.
      x-akeda-module: settings
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: settings.config:write
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsFieldDefinitionInput'
      responses:
        '201':
          description: Заведённое определение поля
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsFieldDefinition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/settings/field-definitions/{id}:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - name: id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/UUID'
    patch:
      tags:
      - Settings fields
      operationId: settingsUpdateFieldDefinition
      summary: Изменить определение дополнительного поля
      description: Тело заменяет определение целиком, а не частично — отсутствующее поле затирается пустым значением, поэтому присылать нужно всю строку. Выключают поле тем же запросом, через is_active.
      x-akeda-module: settings
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: settings.config:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsFieldDefinitionInput'
      responses:
        '200':
          description: Изменённое определение поля
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsFieldDefinition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Settings fields
      operationId: settingsDeleteFieldDefinition
      summary: Удалить определение дополнительного поля
      description: Строка удаляется насовсем, а не гасится; чтобы поле только перестало показываться, его выключают через is_active.
      x-akeda-module: settings
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: settings.config:write
      responses:
        '204':
          description: Определение поля удалено
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Некорректный запрос или нарушение бизнес-правила
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Сессия, ключ или кабинет не подтверждены
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Текущая роль не имеет требуемого права
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Запись не найдена или не видима текущему пользователю
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SettingsFieldDefinitionInput:
      type: object
      additionalProperties: false
      required:
      - entity_type
      - key
      - label
      properties:
        entity_type:
          type: string
          minLength: 1
        key:
          type: string
          minLength: 1
        label:
          type: string
          minLength: 1
        type:
          type: string
          enum:
          - text
          - number
          - date
          - bool
          - select
          - money
          default: text
          description: Пустое значение подставляется как text
        required:
          type: boolean
        dictionary:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Справочник значений для типа select
        order:
          type: integer
        is_active:
          type: boolean
          description: Читается только при изменении; на заведении определение всегда действующее
        help:
          type: string
        group:
          type: string
          maxLength: 60
          description: Панель карточки; пусто — общая панель дополнительных реквизитов
        pinned:
          type: boolean
          description: 'Закрепить как характеристику: под названием в шапке карточки и столбцом каталога'
        filterable:
          type: boolean
          description: Показывать в отборе каталога
        category_ids:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/UUID'
          description: Категории, у товаров которых и их потомков поле показывается; пусто — у всех
        unit_suffix:
          type: string
          maxLength: 16
          description: 'Суффикс единицы после значения: кг, мм, мл'
    SettingsFieldDefinition:
      type: object
      additionalProperties: false
      required:
      - id
      - entity_type
      - key
      - label
      - type
      - required
      - dictionary
      - order
      - is_active
      - help
      - group
      - pinned
      - filterable
      - category_ids
      - unit_suffix
      - created_at
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        entity_type:
          type: string
        key:
          type: string
        label:
          type: string
        type:
          type: string
        required:
          type: boolean
        dictionary:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
        order:
          type: integer
        is_active:
          type: boolean
        help:
          type: string
        group:
          type: string
          description: Панель карточки, в которой показывается поле; пусто — общая панель дополнительных реквизитов
        pinned:
          type: boolean
          description: 'Закреплённая характеристика: под названием в шапке карточки и столбцом каталога'
        filterable:
          type: boolean
          description: Поле участвует в отборе каталога
        category_ids:
          type: array
          items:
            $ref: '#/components/schemas/UUID'
          description: Категории (элементы справочника product_categories), у товаров которых и их потомков поле показывается; пусто — у всех
        unit_suffix:
          type: string
          description: 'Суффикс единицы после значения: кг, мм, мл'
        created_at:
          type: string
          description: Отметка времени как её печатает Postgres, а не RFC 3339
        updated_at:
          type: string
          description: Отметка времени как её печатает Postgres, а не RFC 3339
    SettingsFieldSchema:
      type: object
      additionalProperties: false
      required:
      - fields
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/SettingsFieldDefinition'
    Error:
      type: object
      additionalProperties: false
      required:
      - detail
      properties:
        detail:
          type: string
          description: One human sentence in the request language (Accept-Language, echoed as Content-Language)
        code:
          type: string
          description: Stable module error code when the endpoint defines one
        field:
          type: string
          description: Request body path of the field the refusal is about, e.g. content.commercial.amount or due_date; present when the endpoint names the field
        reason:
          type: string
          description: Machine code of the field refusal reason, e.g. required, format, total_mismatch; present together with field when the endpoint defines reasons
        request_id:
          type: string
          format: uuid
          description: Case id. Always present on 5xx and on any error produced by the server itself; the same value is returned in the X-Request-ID header and recorded in the access log and the incident. Quote it to support instead of the cause, which the response never carries.
    SettingsFieldDefinitionPage:
      type: object
      additionalProperties: false
      required:
      - count
      - results
      properties:
        count:
          type: integer
          minimum: 0
          description: Число отданных строк, а не всего в базе; выборка обрезана 200 строками
        results:
          type: array
          items:
            $ref: '#/components/schemas/SettingsFieldDefinition'
    UUID:
      type: string
      format: uuid
  parameters:
    TenantHeader:
      name: X-Tenant
      in: header
      required: true
      description: Slug выбранного кабинета; кабинет не является юрлицом
      schema:
        type: string
        minLength: 1
  securitySchemes:
    erpUserToken:
      type: http
      scheme: bearer
      bearerFormat: go_session
      description: Пользовательский ERP token, полученный через ORY Kratos session bridge
    tenantApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Tenant-scoped сервисный API-ключ Akeda
    installationToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_installation_token
      description: 'Краткосрочный токен установки приложения (`ai_…`). Выдаёт его человек: публичной двери обмена учётных данных на токен нет и не будет, пока нет брокера долгой половины секрета, асимметричного подтверждения и ограничителя с аудитом неудачных попыток. Токен принимается и в заголовке X-Api-Key, и живёт минуты — вместо показа его ротируют'
    developerSessionToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_session
      description: 'Сессия аккаунта разработчика (`ad_…`). Своя схема, а не пользовательский токен ERP: у разработчика нет кабинета, роли и прав, а хеш этого токена лежит в отдельном хранилище — на кабинетных маршрутах он не находится ничем. Выдаёт его обмен одноразовой ссылки из письма; пароля в этом контуре нет вовсе'
    developerAppKey:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_app_key
      description: 'Учётные данные приложения (`adk_…`) — это машина конвейера издателя, а не человек. Ключ привязан к ОДНОМУ приложению внешним ключом, и достижимая им поверхность — маршруты `/api/v1/developer` этого приложения. Обменять его на токен установки нельзя: такой двери нет, и ни одного маршрута к данным кабинета за ним не существует. Выпуск, ротацию и отзыв учётных данных этот ключ не выполняет: ключ, умеющий выпустить следующий ключ, не отзывается никогда. Значение показывается один раз, при выдаче; в хранилище лежит хеш'
    mcpOAuth:
      type: oauth2
      description: OAuth 2.1 delegation для MCP; кабинетные права проверяются на каждом вызове
      flows:
        authorizationCode:
          authorizationUrl: https://erp.akeda.ru/oauth2/authorize
          tokenUrl: https://erp.akeda.ru/oauth2/token
          scopes:
            akeda:delegate: Делегировать текущие пользовательские права MCP-подключению
x-akeda-contract-coverage:
- dashboard-metrics
- tasks-lifecycle
- tasks-collaboration
- tasks-workflow
- tasks-organization
- tasks-automation
- tasks-planning
- tasks-project-hub
- tasks-files
- calendar-events
- calendar-availability
- calendar-booking
- calendar-notifications
- calendar-connectors
- chat-conversations
- chat-messages
- chat-receipts
- chat-mentions
- chat-realtime
- core-directories
- core-folders
- core-contacts
- core-products
- core-documents
- core-orders
- core-registers
- core-accounting
- core-ledger
- core-items
- core-employees
- core-employee-operations
- core-currency-rates
- core-preferences
- core-ui-state
- core-external-refs
- core-product-imports
- core-product-exports
- core-gl-opening-imports
- core-reference
- core-change-feed
- finance-accounts
- finance-statements
- finance-transactions
- finance-connectors
- finance-connector-sync
- finance-requisites
- finance-counterparty-terms
- finance-operations
- finance-settlements
- finance-trade
- finance-exchange
- finance-imports
- finance-payment-calendar
- finance-pnl-layouts
- finance-registers
- finance-reports
- crm-pipelines
- crm-deals
- crm-leads
- crm-customers
- crm-links
- crm-inbox
- crm-automation
- crm-analytics
- knowledge-spaces
- knowledge-pages
- knowledge-access
- knowledge-files
- knowledge-search
- files-drives
- files-content
- files-access
- files-uploads
- files-shares
- stock-documents
- stock-inventory
- stock-warehouses
- stock-handling-units
- stock-batches
- stock-product-units
- stock-references
- stock-imports
- stock-exports
- stock-reports
- stock-valuation
- stock-reorder-rules
- stock-settings
- stock-purchasing
- marking-settings
- marking-connections
- marking-products
- marking-codes
- marking-labels
- marking-stock-codes
- marking-orders
- marking-gismt-documents
- marking-boxes
- marketplace-stores
- marketplace-ozon
- marketplace-wildberries
- marketplace-yandex
- marketplace-product-groups
- marketplace-accounting
- marketplace-catalog
- settings-companies
- settings-roles
- settings-members
- settings-fields
- settings-api-keys
- finance-payroll
- finance-report-details
- knowledge-tags
- knowledge-revisions
- knowledge-approval
- chat-attachments
- chat-reactions
- chat-folders
- platform-apps
- platform-app-installations
- platform-app-tokens
- platform-app-deliveries
- platform-app-publishers
- platform-app-publication
- platform-app-rollouts
- platform-app-runtime
- platform-app-access
- platform-app-blocks
- platform-demo-data
- billing-usage
- platform-analytics
- finance-staffing
- platform-tenants
- platform-users
- platform-access
- platform-mcp-publication
- platform-incidents
- platform-health
- settings-apps
- docflow-connections
- docflow-mirror
- docflow-signing
- docflow-actions
- docflow-outgoing
- docflow-intake
- docflow-flow
- docflow-approvals
- docflow-flow-accounting
- mail-accounts
- mail-folders
- mail-messages
- mail-rules
- mail-outbound
- mail-attachments
- billing-plans
- billing-subscriptions
- billing-invoices
- billing-analytics
- settings-subscription
- billing-payments
- billing-public
x-akeda-docs-path: /docs
x-akeda-default-release-stage: internal
x-akeda-default-audience: operator