unip-controller/tests/data/resources/pu-user1/apps/app2/api-cmp10.yaml

55 lines
2.5 KiB
YAML
Raw Normal View History

2025-01-29 13:13:51 +00:00
# ============================================================
# Система: Единая библиотека, Центр ИИ НИУ ВШЭ
# Модуль: Тесты
# Авторы: Полежаев В.А., Хританков А.С.
# Дата создания: 2024 г.
# ============================================================
apiVersion: "unified-platform.cs.hse.ru/v1"
kind: APIComponent
metadata:
name: test-api10
namespace: pu-user1-pa-app2
spec:
published: true
experimentPipeline:
name: test-ep10
restfulApi:
auth:
basic:
credentials: app2-apis-ba-cred
identityPassThrough: true
apiSpec:
inputs:
- name: input1
description: "Входная переменная 1"
type:
datatypes: ["FP32", "FILE", "WEBSITE"]
# * если будет передан datatype == 'FILE', content-type должен быть передан обязательно
# * если будет передан datatype != 'FILE', то content-type игнорируется,
# для каждого datatype есть предопределенный content_type;
contentTypes: [ "text/csv", "application/json", "image/png" ]
required: true
- name: input2
type:
# если в списке datatypes нет 'FILE', то он все равно будет разрешен (добавлен в спецификацию API)
datatypes: ["FP32"]
contentTypes: ["BED"]
# По умолчанию все входные переменные обязательные,
# но входную переменную можно сделать опциональной
required: false
- name: input3
# Если type не указан, то это эквивалентно:
# type:
# Полному переченю поддерживаемых типов
# datatypes: ["FP32", "FP64", "INT32", "dict", 'str', "FILE", "WEBSITE"]
# Пустому contentTypes, что означает допустимость любого content_type
# contentTypes: []
outputs:
- name: output1
description: "Выходная переменная 1"
type:
# Для выходных переменных атрибутов datatypes и required нет,
# поскольку выходные переменные всегда имеют неявный datatype == 'FILE'
# contentTypes может быть указан
contentTypes: [ "PDB" ]