From 3a25155fb1fa2068a6e00ce18e8450676078ee30 Mon Sep 17 00:00:00 2001 From: Georgii Zhulikov Date: Thu, 29 May 2025 16:35:25 +0300 Subject: [PATCH] Fix app name in api doc --- pages/api-module.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/pages/api-module.md b/pages/api-module.md index e7579ea..8b13551 100644 --- a/pages/api-module.md +++ b/pages/api-module.md @@ -7,16 +7,16 @@ - [Общая работа с пайплайнами](#общая-работа-с-пайплайнами) - [Отдельный пайплайн](#отдельный-пайплайн) -Все API запросы работают по ссылкам вида `https://platform.stratpro.hse.ru/app-name/`. +Все API запросы работают по ссылкам вида `https://platform.stratpro.hse.ru/pu-username-pa-appname/`. -Здесь `app-name` - название приложения, оно же указано в пункте `namespace` во всех компонентах приложения. +Здесь `pu-username-pa-appname` - название приложения, оно же указано в пункте `namespace` во всех компонентах приложения. ## Файловый API ### Работа с файловым API -URL запросов к файловому API имеют вид `https://platform.stratpro.hse.ru/app-name/files/box-name/`. +URL запросов к файловому API имеют вид `https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/`. Здесь `box-name` - это имя компонента DataBox, к которому обращается запрос. @@ -37,12 +37,12 @@ URL запросов к файловому API имеют вид `https://platfo Для загрузки файла можно использовать следующий запрос `PUT`: ```sh -curl -X PUT https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:" +curl -X PUT https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:" ``` Это запрос: -1. К приложению `app-name`. +1. К приложению `pu-username-pa-appname`. 2. К файловому API (у которого endpoint всегда `files`). 3. К ящику `box-name`. 4. К пути `my_dir/my_file.txt` внутри ящика. @@ -52,7 +52,7 @@ curl -X PUT https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_f ```json { - "name": "app-name/files/box-name/my_dir/my_file.txt", + "name": "pu-username-pa-appname/files/box-name/my_dir/my_file.txt", "presigned_put_url": "<Длинная pre-signed ссылка загрузки>" } ``` @@ -71,14 +71,14 @@ curl -X PUT -T local/path/to/my_file.txt "<Длинная pre-signed ссылк Для скачивания нужно сделать запрос такого же формата, как для загрузки файла, но запрос GET. ```sh -curl -X GET https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:" +curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:" ``` Ответ такой же, как при загрузке - pre-signed ссылка в формате json, но теперь на скачивание. ```json { - "name": "app-name/files/box-name/my_dir/my_file.txt", + "name": "pu-username-pa-appname/files/box-name/my_dir/my_file.txt", "presigned_get_url": "<Длинная pre-signed ссылка скачивания>" } ``` @@ -87,14 +87,14 @@ GET-запрос к файловой группе возвращает спис ```json { - "name": "app-name/files/box-name/my_dir/", + "name": "pu-username-pa-appname/files/box-name/my_dir/", "files": [ { - "name": "app-name/files/box-name/my_dir/file1.png", + "name": "pu-username-pa-appname/files/box-name/my_dir/file1.png", "presigned_get_url": "<Длинная pre-signed ссылка скачивания>" }, { - "name": "app-name/files/box-name/my_dir/file2.txt", + "name": "pu-username-pa-appname/files/box-name/my_dir/file2.txt", "presigned_get_url": "<Длинная pre-signed ссылка скачивания>" } ] @@ -108,7 +108,7 @@ ML-компоненты проводят расчёты при получени Каждый развёрнутый ML-компонент содержит OpenAPI спецификацию с информацией о себе. Её можно получить следующим запросом: ``` -curl -X GET https://platform.stratpro.hse.ru/app-name/API_NAME/modelversion -H "Content-Type: application/json" -u ":" +curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/API_NAME/modelversion -H "Content-Type: application/json" -u ":" ``` Тело запроса на выполнения расчёта - это объект с полями, которые в точности копируют поля из функции inference в [MLComponent](mlcmp.md#функция-inference). @@ -153,7 +153,7 @@ curl -X GET https://platform.stratpro.hse.ru/app-name/API_NAME/modelversion -H " Запрос, с файлом `data.json` в его теле и базовой аутентификацией. ``` -curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/API_NAME/predict -H "Content-Type: application/json" -u ":" +curl -X POST -d @data.json https://platform.stratpro.hse.ru/pu-username-pa-appname/API_NAME/predict -H "Content-Type: application/json" -u ":" ``` @@ -162,19 +162,19 @@ curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/API_NAME/pr Каждый развёрнутый пайплайн содержит OpenAPI спецификацию запросов к себе. Её можно получить следующим запросом: ``` -curl -X GET https://platform.stratpro.hse.ru/app-name/pipelines/PIPELINE_NAME/version -H "Content-Type: application/json" -u ":" +curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines/PIPELINE_NAME/version -H "Content-Type: application/json" -u ":" ``` Основная работа происходит с конкретными пайплайнами. Из общих команд полезны: ``` # Получить список пайплайнов -curl -X GET https://platform.stratpro.hse.ru/app-name/pipelines -H "Content-Type: application/json" -u ":" +curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines -H "Content-Type: application/json" -u ":" ``` ``` # Получить список запусков пайплайнов -curl -X GET https://platform.stratpro.hse.ru/app-name/trials -H "Content-Type: application/json" -u ":" +curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/trials -H "Content-Type: application/json" -u ":" ``` ## Отдельный пайплайн @@ -186,7 +186,7 @@ curl -X GET https://platform.stratpro.hse.ru/app-name/trials -H "Content-Type: a ``` -curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/pipelines/PIPELINE_NAME/trials -H "Content-Type: application/json" -u ":" +curl -X POST -d @data.json https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines/PIPELINE_NAME/trials -H "Content-Type: application/json" -u ":" ``` Тело запроса на выполнения расчёта - это объект с полями, похожими на поля запроса к MLComponent.