Skip to content

Add list-forms command docs across all languages #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add list-forms command docs across all languages #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions ar/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,53 @@ openyida get-schema <appType> <formUuid> # إلزامي قبل أي عملية

# تحديث تكوين النموذج
openyida update-form-config <appType> <formUuid> <isRenderNav> <title>

# عرض قائمة صفحات النماذج في التطبيق
openyida list-forms <appType> [--keyword <text>]
```

### عرض قائمة صفحات النماذج

استعلام جميع إدخالات النماذج والصفحات داخل التطبيق. يتم إخراج النتائج بتنسيق JSON إلى المخرج القياسي.

```bash
openyida list-forms <appType> [--keyword <text>]
```

| المعامل | الوصف |
|---------|-------|
| `<appType>` | معرّف التطبيق (مثال: `APP_XXXXX`) |

| الخيار | الوصف |
|--------|-------|
| `--keyword <text>` | تصفية النتائج بكلمة مفتاحية (تطابق اسم النموذج أو UUID أو النوع أو المسار) |

**أمثلة:**

```bash
# عرض جميع النماذج في التطبيق
openyida list-forms APP_XXXXX

# التصفية بكلمة مفتاحية
openyida list-forms APP_XXXXX --keyword customer
```

يُخرج الأمر مصفوفة JSON من كائنات النماذج:

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "تسجيل العملاء",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
يجب تسجيل الدخول قبل تشغيل هذا الأمر. قم بتشغيل `openyida login` أولاً إذا لم تكن قد قمت بالمصادقة بعد.
</Info>

<Warning>
معرّفات الحقول في Yida يتم إنشاؤها عشوائيًا بواسطة المنصة (مثال: `textField_eftt1aa5m`، `selectField_fix024y92`) ولا يمكن استنتاجها من أسماء الحقول. قبل أي عملية تستخدم معرّفات الحقول (إنشاء/تحديث البيانات، تكوين شروط الاستعلام، كتابة صفحات مخصصة)، **يجب** تشغيل `openyida get-schema` للحصول على المعرّفات الحقيقية.
Expand Down
45 changes: 45 additions & 0 deletions de/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,53 @@ openyida get-schema <appType> <formUuid> # Pflicht vor jeder Operation mit Feld

# Formularkonfiguration aktualisieren
openyida update-form-config <appType> <formUuid> <isRenderNav> <title>

# Formularseiten einer Anwendung auflisten
openyida list-forms <appType> [--keyword <text>]
```

### Formularseiten auflisten

Alle Formular- und Seiteneinträge innerhalb einer Anwendung abfragen. Die Ergebnisse werden als JSON auf der Standardausgabe ausgegeben.

```bash
openyida list-forms <appType> [--keyword <text>]
```

| Argument | Beschreibung |
|----------|-------------|
| `<appType>` | Anwendungs-ID (z.B. `APP_XXXXX`) |

| Option | Beschreibung |
|--------|-------------|
| `--keyword <text>` | Ergebnisse nach Stichwort filtern (trifft auf Formularname, UUID, Typ oder Pfad zu) |

**Beispiele:**

```bash
# Alle Formulare einer Anwendung auflisten
openyida list-forms APP_XXXXX

# Nach Stichwort filtern
openyida list-forms APP_XXXXX --keyword customer
```

Der Befehl gibt ein JSON-Array von Formularobjekten aus:

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "Kundenregistrierung",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
Sie müssen angemeldet sein, bevor Sie diesen Befehl ausführen. Führen Sie zuerst `openyida login` aus, wenn Sie sich noch nicht authentifiziert haben.
</Info>

<Warning>
Yida-Feld-IDs werden zufällig von der Plattform generiert (z.B. `textField_eftt1aa5m`, `selectField_fix024y92`) und können nicht aus Feldnamen abgeleitet werden. Vor jeder Operation mit Feld-IDs (Daten erstellen/aktualisieren, Abfragebedingungen konfigurieren, benutzerdefinierte Seiten schreiben) **müssen** Sie `openyida get-schema` ausführen, um die echten Feld-IDs zu erhalten.
Expand Down
46 changes: 46 additions & 0 deletions en/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,54 @@ openyida get-schema <appType> <formUuid>

# Update form config
openyida update-form-config <appType> <formUuid> <isRenderNav> <title>

# List form pages in an application
openyida list-forms <appType> [--keyword <text>]
```

### List form pages

Query all form and page entries within an application. Results are output as JSON to stdout.

```bash
openyida list-forms <appType> [--keyword <text>]
```

| Argument | Description |
|----------|-------------|
| `<appType>` | Application ID (e.g. `APP_XXXXX`) |

| Option | Description |
|--------|-------------|
| `--keyword <text>` | Filter results by keyword (matches form name, UUID, type, or path) |

**Examples:**

```bash
# List all forms in an application
openyida list-forms APP_XXXXX

# Filter by keyword
openyida list-forms APP_XXXXX --keyword customer
```

The command outputs a JSON array of form objects:

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "Customer Registration",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
You must be logged in before running this command. Run `openyida login` first if you have not authenticated.
</Info>

<Warning>
Field IDs in Yida are randomly generated by the platform (e.g. `textField_eftt1aa5m`, `selectField_fix024y92`) and cannot be inferred from field names. You **must** run `openyida get-schema` to obtain the real field IDs before performing any operation that references them — including creating or updating form data, configuring query conditions, and writing custom pages.
</Warning>
Expand Down
45 changes: 45 additions & 0 deletions es/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,53 @@ openyida get-schema <appType> <formUuid> # Obligatorio antes de cualquier opera

# Actualizar configuración del formulario
openyida update-form-config <appType> <formUuid> <isRenderNav> <título>

# Listar páginas de formulario de una aplicación
openyida list-forms <appType> [--keyword <text>]
```

### Listar páginas de formulario

Consulta todas las entradas de formularios y páginas dentro de una aplicación. Los resultados se envían como JSON a la salida estándar.

```bash
openyida list-forms <appType> [--keyword <text>]
```

| Argumento | Descripción |
|-----------|-------------|
| `<appType>` | ID de la aplicación (ej. `APP_XXXXX`) |

| Opción | Descripción |
|--------|-------------|
| `--keyword <text>` | Filtrar resultados por palabra clave (coincide con nombre del formulario, UUID, tipo o ruta) |

**Ejemplos:**

```bash
# Listar todos los formularios de una aplicación
openyida list-forms APP_XXXXX

# Filtrar por palabra clave
openyida list-forms APP_XXXXX --keyword customer
```

El comando devuelve un array JSON de objetos de formulario:

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "Registro de clientes",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
Debe iniciar sesión antes de ejecutar este comando. Ejecute `openyida login` primero si aún no se ha autenticado.
</Info>

<Warning>
Los IDs de campo en Yida son generados aleatoriamente por la plataforma (ej: `textField_eftt1aa5m`, `selectField_fix024y92`) y no se pueden deducir de los nombres de campo. Antes de cualquier operación que use IDs de campo (crear/actualizar datos, configurar condiciones de consulta, escribir páginas personalizadas), **debe** ejecutar `openyida get-schema` para obtener los IDs reales.
Expand Down
46 changes: 46 additions & 0 deletions fr/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,54 @@ openyida get-schema <appType> <formUuid> # Obligatoire avant toute opération u

# Mettre à jour la configuration du formulaire
openyida update-form-config <appType> <formUuid> <isRenderNav> <title>

# Lister les pages de formulaire d'une application
openyida list-forms <appType> [--keyword <text>]
```

### Lister les pages de formulaire

Interroge toutes les entrées de formulaires et de pages au sein d'une application. Les résultats sont affichés en JSON sur la sortie standard.

```bash
openyida list-forms <appType> [--keyword <text>]
```

| Argument | Description |
|----------|-------------|
| `<appType>` | ID de l'application (ex. `APP_XXXXX`) |

| Option | Description |
|--------|-------------|
| `--keyword <text>` | Filtrer les résultats par mot-clé (correspond au nom du formulaire, UUID, type ou chemin) |

**Exemples :**

```bash
# Lister tous les formulaires d'une application
openyida list-forms APP_XXXXX

# Filtrer par mot-clé
openyida list-forms APP_XXXXX --keyword customer
```

La commande renvoie un tableau JSON d'objets formulaire :

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "Inscription client",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
Vous devez être connecté avant d'exécuter cette commande. Exécutez `openyida login` d'abord si vous n'êtes pas encore authentifié.
</Info>

<Warning>
Les ID de champs Yida sont générés aléatoirement par la plateforme (ex : `textField_eftt1aa5m`, `selectField_fix024y92`) et ne peuvent pas être déduits des noms de champs. Avant toute opération utilisant des ID de champs (création/mise à jour de données, configuration de conditions de requête, écriture de pages personnalisées), vous **devez** exécuter `openyida get-schema` pour obtenir les vrais ID de champs.
</Warning>
Expand Down
45 changes: 45 additions & 0 deletions hi/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,53 @@ openyida get-schema <appType> <formUuid> # फ़ील्ड ID का उप

# फॉर्म कॉन्फ़िगरेशन अपडेट करें
openyida update-form-config <appType> <formUuid> <isRenderNav> <शीर्षक>

# एप्लिकेशन में फॉर्म पेज सूचीबद्ध करें
openyida list-forms <appType> [--keyword <text>]
```

### फॉर्म पेज सूचीबद्ध करें

किसी एप्लिकेशन के भीतर सभी फॉर्म और पेज एंट्री की क्वेरी करें। परिणाम JSON प्रारूप में मानक आउटपुट पर दिखाए जाते हैं।

```bash
openyida list-forms <appType> [--keyword <text>]
```

| आर्गुमेंट | विवरण |
|-----------|-------|
| `<appType>` | एप्लिकेशन ID (उदा. `APP_XXXXX`) |

| विकल्प | विवरण |
|--------|-------|
| `--keyword <text>` | कीवर्ड द्वारा परिणाम फ़िल्टर करें (फॉर्म नाम, UUID, प्रकार या पथ से मिलान) |

**उदाहरण:**

```bash
# एप्लिकेशन में सभी फॉर्म सूचीबद्ध करें
openyida list-forms APP_XXXXX

# कीवर्ड से फ़िल्टर करें
openyida list-forms APP_XXXXX --keyword customer
```

कमांड फॉर्म ऑब्जेक्ट का एक JSON ऐरे आउटपुट करता है:

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "ग्राहक पंजीकरण",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
इस कमांड को चलाने से पहले आपको लॉग इन होना चाहिए। यदि आपने अभी तक प्रमाणीकरण नहीं किया है तो पहले `openyida login` चलाएं।
</Info>

<Warning>
Yida फ़ील्ड ID प्लेटफ़ॉर्म द्वारा यादृच्छिक रूप से जनरेट किए जाते हैं (उदा: `textField_eftt1aa5m`, `selectField_fix024y92`) और फ़ील्ड नामों से अनुमान नहीं लगाया जा सकता। फ़ील्ड ID का उपयोग करने वाले किसी भी ऑपरेशन (डेटा बनाना/अपडेट करना, क्वेरी शर्तें कॉन्फ़िगर करना, कस्टम पेज लिखना) से पहले आपको **अवश्य** `openyida get-schema` चलाकर वास्तविक फ़ील्ड ID प्राप्त करना होगा।
Expand Down
45 changes: 45 additions & 0 deletions ja/features/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,53 @@ openyida get-schema <appType> <formUuid> # フィールドIDを使用する操

# フォーム設定更新
openyida update-form-config <appType> <formUuid> <isRenderNav> <title>

# アプリケーション内のフォームページを一覧表示
openyida list-forms <appType> [--keyword <text>]
```

### フォームページの一覧表示

アプリケーション内のすべてのフォームおよびページエントリを照会します。結果はJSON形式で標準出力に出力されます。

```bash
openyida list-forms <appType> [--keyword <text>]
```

| 引数 | 説明 |
|------|------|
| `<appType>` | アプリケーションID（例: `APP_XXXXX`） |

| オプション | 説明 |
|-----------|------|
| `--keyword <text>` | キーワードで結果をフィルタリング（フォーム名、UUID、タイプ、パスに一致） |

**例：**

```bash
# アプリケーション内のすべてのフォームを一覧表示
openyida list-forms APP_XXXXX

# キーワードでフィルタリング
openyida list-forms APP_XXXXX --keyword customer
```

コマンドはフォームオブジェクトのJSON配列を出力します：

```json
[
{
"formUuid": "FORM-XXXXX",
"formName": "顧客登録",
"formType": "form",
"pathName": "customer-registration"
}
]
```

<Info>
このコマンドを実行する前にログインが必要です。認証がまだの場合は、先に `openyida login` を実行してください。
</Info>

<Warning>
YidaのフィールドIDはプラットフォームによりランダムに生成されます（例: `textField_eftt1aa5m`、`selectField_fix024y92`）。フィールド名からは推測できません。フィールドIDを使用する操作（データの作成・更新、クエリ条件の設定、カスタムページの作成など）の前に、**必ず** `openyida get-schema` を実行して実際のフィールドIDを取得してください。
Expand Down
Loading