Commit ·
e5a98b5
1
Parent(s): ea74529
add i18n to call via API
Browse files
README.md
CHANGED
|
@@ -50,7 +50,7 @@ npm run download
|
|
| 50 |
Test locale
|
| 51 |
|
| 52 |
```bash
|
| 53 |
-
npm
|
| 54 |
```
|
| 55 |
|
| 56 |
Check more details here https://docusaurus.io/docs/3.4.0/i18n/crowdin
|
|
|
|
| 50 |
Test locale
|
| 51 |
|
| 52 |
```bash
|
| 53 |
+
npm start -- --locale ru
|
| 54 |
```
|
| 55 |
|
| 56 |
Check more details here https://docusaurus.io/docs/3.4.0/i18n/crowdin
|
i18n/en/docusaurus-plugin-content-docs/current.json
CHANGED
|
@@ -14,5 +14,25 @@
|
|
| 14 |
"sidebar.tutorialSidebar.category.Tutorial - Extras": {
|
| 15 |
"message": "Tutorial - Extras",
|
| 16 |
"description": "The label for category Tutorial - Extras in sidebar tutorialSidebar"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
}
|
| 18 |
}
|
|
|
|
| 14 |
"sidebar.tutorialSidebar.category.Tutorial - Extras": {
|
| 15 |
"message": "Tutorial - Extras",
|
| 16 |
"description": "The label for category Tutorial - Extras in sidebar tutorialSidebar"
|
| 17 |
+
},
|
| 18 |
+
"sidebar.tutorialSidebar.category.Pipeline Basics": {
|
| 19 |
+
"message": "Pipeline Basics",
|
| 20 |
+
"description": "The label for category Pipeline Basics in sidebar tutorialSidebar"
|
| 21 |
+
},
|
| 22 |
+
"sidebar.tutorialSidebar.category.Pipeline Basics.link.generated-index.description": {
|
| 23 |
+
"message": "5 minutes to learn the most important Docusaurus concepts.",
|
| 24 |
+
"description": "The generated-index page description for category Pipeline Basics in sidebar tutorialSidebar"
|
| 25 |
+
},
|
| 26 |
+
"sidebar.tutorialSidebar.category.Advanced development": {
|
| 27 |
+
"message": "Advanced development",
|
| 28 |
+
"description": "The label for category Advanced development in sidebar tutorialSidebar"
|
| 29 |
+
},
|
| 30 |
+
"sidebar.tutorialSidebar.category.Deploy pipelines & API": {
|
| 31 |
+
"message": "Deploy pipelines & API",
|
| 32 |
+
"description": "The label for category Deploy pipelines & API in sidebar tutorialSidebar"
|
| 33 |
+
},
|
| 34 |
+
"sidebar.tutorialSidebar.category.Deploy pipelines & API.link.generated-index.description": {
|
| 35 |
+
"message": "Simply deploy your pipelines & call via API.",
|
| 36 |
+
"description": "The generated-index page description for category Deploy pipelines & API in sidebar tutorialSidebar"
|
| 37 |
}
|
| 38 |
}
|
i18n/ru/docusaurus-plugin-content-docs/current/deploy-pipelines/_category_.json
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"label": "Публикация конвейеров и API",
|
| 3 |
+
"position": 4,
|
| 4 |
+
"link": {
|
| 5 |
+
"type": "generated-index",
|
| 6 |
+
"description": "Публикуйте свои конвейеры и вызывайте их через API за секунды."
|
| 7 |
+
}
|
| 8 |
+
}
|
i18n/ru/docusaurus-plugin-content-docs/current/deploy-pipelines/call-via-api.md
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sidebar_position: 1
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Запуск конвейеров и API
|
| 6 |
+
|
| 7 |
+
После публикации ваши конвейеры можно вызывать с помощью запросов POST/GET.
|
| 8 |
+
|
| 9 |
+
:::tip Подсказка
|
| 10 |
+
|
| 11 |
+
Если вы развернули Piper на своем собственном сервере, замените **piper.my** на свое доменное имя.
|
| 12 |
+
|
| 13 |
+
:::
|
| 14 |
+
|
| 15 |
+
## Запустить конвейер
|
| 16 |
+
|
| 17 |
+
```bash
|
| 18 |
+
curl --location --request POST 'https://piper.my/api/pipeline-slug/launch' \
|
| 19 |
+
--header 'content-type: application/json' \
|
| 20 |
+
--header 'api-token: [YOUR_API_KEY_HERE]' \
|
| 21 |
+
--data '{
|
| 22 |
+
"inputs": {
|
| 23 |
+
name: "Bob Marley",
|
| 24 |
+
age: 36,
|
| 25 |
+
died: true
|
| 26 |
+
}
|
| 27 |
+
}'
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
:::tip Важно
|
| 31 |
+
|
| 32 |
+
Тип входных данных может быть только: `boolean` | `number` | `string`
|
| 33 |
+
|
| 34 |
+
:::
|
| 35 |
+
|
| 36 |
+
Некоторые конвейеры принимают JSON в качестве входных данных.
|
| 37 |
+
|
| 38 |
+
В этом случае JSON все равно необходимо сериализовать в строку.
|
| 39 |
+
|
| 40 |
+
```json
|
| 41 |
+
{
|
| 42 |
+
"inputs": {
|
| 43 |
+
"props": "{ \"name\": \"Bob Marley\", \"age\": 36 }"
|
| 44 |
+
}
|
| 45 |
+
}
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
### Изображения и медиафайлы
|
| 49 |
+
|
| 50 |
+
Существует два способа отправки изображений и других медиафайлов, таких как видео или аудио:
|
| 51 |
+
1. JSON Base64: `data:image/jpeg;base64,...`
|
| 52 |
+
2. Загрузка как артефакта.
|
| 53 |
+
|
| 54 |
+
#### JSON Base64
|
| 55 |
+
|
| 56 |
+
```bash
|
| 57 |
+
curl --location --request POST 'https://piper.my/api/pipeline-slug/launch' \
|
| 58 |
+
--header 'content-type: application/json' \
|
| 59 |
+
--header 'api-token: [YOUR_API_KEY_HERE]' \
|
| 60 |
+
--data '{
|
| 61 |
+
"inputs": {
|
| 62 |
+
image: "data:image/jpeg;base64,..."
|
| 63 |
+
}
|
| 64 |
+
}'
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
:::danger Ограничения
|
| 68 |
+
|
| 69 |
+
Для обеспечения стабильности и производительности JSON ограничен 2048 КБ.
|
| 70 |
+
Большие медиафайлы загружайте как артефакты.
|
| 71 |
+
|
| 72 |
+
:::
|
| 73 |
+
|
| 74 |
+
#### Загрузка артефакта
|
| 75 |
+
|
| 76 |
+
Piper имеет собственное временное хранилище для обработки больших медиафайлов.
|
| 77 |
+
|
| 78 |
+
```bash
|
| 79 |
+
curl --location --request POST 'https://piper.my/api/artefacts' \
|
| 80 |
+
--header 'api-token: [YOUR_API_KEY_HERE]' \
|
| 81 |
+
-F "file=@/path/to/your/file.jpg"
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
После загрузки вы получите URL-адрес для доступа к файлу.
|
| 85 |
+
|
| 86 |
+
:::danger Ограничения
|
| 87 |
+
|
| 88 |
+
Ваш файл будет автоматически удален примерно через 48 часов.
|
| 89 |
+
|
| 90 |
+
:::
|
| 91 |
+
|
| 92 |
+
## Статус конвейера
|
| 93 |
+
|
| 94 |
+
```bash
|
| 95 |
+
curl --location --request GET 'https://piper.my/api/launches/[LAUNCH_ID]/state' \
|
| 96 |
+
--header 'api-token: [YOUR_API_KEY_HERE]'
|
| 97 |
+
```
|
| 98 |
+
|
| 99 |
+
В зависимости от типа конвейера мы рекомендуем проводить опрос каждые 2–5 секунд.
|
| 100 |
+
|
| 101 |
+
Поскольку выходные данные в конвейере устанавливаются асинхронно, вам необходимо дождаться всех ожидаемых выходных данных.
|
| 102 |
+
|
| 103 |
+
:::tip Вопрос
|
| 104 |
+
|
| 105 |
+
> Поддерживаете ли вы вебхуки или потоковые события?
|
| 106 |
+
|
| 107 |
+
**Это произойдет совсем скоро!**
|
| 108 |
+
|
| 109 |
+
Пожалуйста, [проголосуйте](https://github.com/my-piper/piper/issues/17), чтобы выразить свою поддержку.
|
| 110 |
+
|
| 111 |
+
:::
|
package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
| 4 |
"private": true,
|
| 5 |
"scripts": {
|
| 6 |
"docusaurus": "docusaurus",
|
| 7 |
-
"start": "docusaurus start",
|
| 8 |
"build": "docusaurus build",
|
| 9 |
"swizzle": "docusaurus swizzle",
|
| 10 |
"deploy": "docusaurus deploy",
|
|
|
|
| 4 |
"private": true,
|
| 5 |
"scripts": {
|
| 6 |
"docusaurus": "docusaurus",
|
| 7 |
+
"start": "docusaurus start --port 4000",
|
| 8 |
"build": "docusaurus build",
|
| 9 |
"swizzle": "docusaurus swizzle",
|
| 10 |
"deploy": "docusaurus deploy",
|