@api-now/cli 1.11.0 → 1.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +71 -6
  2. package/dist/index.js +36 -36
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -10,7 +10,8 @@ The **API NOW! CLI** is a robust, cross-platform command-line tool designed to m
10
10
  - **Interactive Onboarding**: Guided setup prompts for first-time users to configure organization names and slugs (validated against reserved keywords/taken values).
11
11
  - **Default Organization Management**: List organizations and pin a default workspace ID.
12
12
  - **Metadata and Media Uploads**: Create, list, and read blueprints, domains, and multimedia assets.
13
- - **Data Domain Management & Publishing**: Mutate data domains via declarative JSON patch diffing, transition data domain lifecycles (`draft`, `committed`, `published`), bump versions, run pre-publish validation, and publish domains directly to the Data Catalog.
13
+ - **Data Domain Management & Publishing**: Search, list, create, mutate via declarative JSON patch diffing, transition lifecycles (`draft`, `committed`, `published`), bump versions, run pre-publish validation, and publish domains directly to the Data Catalog.
14
+ - **API Model Management**: Search, list, create, and read API Model files and schemas with immediate parent folder resolution.
14
15
  - **Local & Remote Schema Validation**: Validate Data Domain and API Model schemas from local files, STDIN, or directly from remote organization files.
15
16
  - **Data Catalog Publishing**: Publish schemas and datasets to the global/private catalog with automatic semantic versioning support, deprecation, and unpublishing.
16
17
  - **Developer Formatting Options**: Toggle outputs between human-friendly ASCII tables and machine-readable JSON.
@@ -153,20 +154,32 @@ Manage Data Domain files, lifecycles, and catalog publications.
153
154
 
154
155
  #### List Data Domains (`domain list`)
155
156
 
156
- List all Data Domain files in an organization.
157
+ List all Data Domain files in an organization (flat listing across all folders with immediate parent folder resolution).
157
158
 
158
159
  ```bash
159
160
  # List all domain files in an organization
160
161
  apinow domain list [--org <org_id>] [--parent <parent_id>]
161
162
  ```
162
163
 
164
+ #### Search Data Domains (`domain search`)
165
+
166
+ Search for Data Domain files by name or keyword across the organization.
167
+
168
+ ```bash
169
+ # Search for domain files matching a query keyword
170
+ apinow domain search "Billing" [--org <org_id>]
171
+
172
+ # Search with explicit query keywords and folder/result limits
173
+ apinow domain search --query Billing Payments --parent <parent_id> --limit 10
174
+ ```
175
+
163
176
  #### Create Data Domain (`domain create`)
164
177
 
165
178
  Create a new Data Domain file record in your organization, with optional local schema or STDIN upload.
166
179
 
167
180
  ```bash
168
181
  # Create a data domain metadata record
169
- apinow domain create --name "Billing Domain" [--org <org_id>]
182
+ apinow domain create --name "Billing Domain" [--org <org_id>] [--parent <parent_id>]
170
183
 
171
184
  # Create a data domain and upload local schema media
172
185
  apinow domain create --name "Billing Domain" --media ./domain.json [--org <org_id>]
@@ -248,7 +261,59 @@ apinow domain publish --file <file_id> --ver 1.0.0 --scope public --name "Billin
248
261
  # --changelog <changelog> Changelog description for this version
249
262
  ```
250
263
 
251
- ### 6. Schema Validation (`validate`)
264
+ ### 6. API Models (`api`)
265
+
266
+ Manage API model files and schema definitions.
267
+
268
+ #### List API Models (`api list`)
269
+
270
+ List all API model files in an organization (flat listing across all folders with immediate parent folder resolution).
271
+
272
+ ```bash
273
+ # List all API model files in an organization
274
+ apinow api list [--org <org_id>] [--parent <parent_id>]
275
+ ```
276
+
277
+ #### Search API Models (`api search`)
278
+
279
+ Search for API model files by name or keyword across the organization.
280
+
281
+ ```bash
282
+ # Search for API model files matching a query keyword
283
+ apinow api search "Payments" [--org <org_id>]
284
+
285
+ # Search with explicit query keywords and folder/result limits
286
+ apinow api search --query Payments Billing --parent <parent_id> --limit 10
287
+ ```
288
+
289
+ #### Create API Model (`api create`)
290
+
291
+ Create a new API model file record in your organization, with optional local schema or STDIN upload.
292
+
293
+ ```bash
294
+ # Create an API model metadata record
295
+ apinow api create --name "Payments API" [--org <org_id>] [--parent <parent_id>]
296
+
297
+ # Create an API model and upload local schema media (validates Core#ApiModel schema)
298
+ apinow api create --name "Payments API" --media ./api.json [--org <org_id>]
299
+
300
+ # Create an API model with schema piped from STDIN
301
+ cat ./api.json | apinow api create --name "Piped API" --stdin [--org <org_id>]
302
+ ```
303
+
304
+ #### Read API Model (`api read`)
305
+
306
+ Read API model file metadata or schema media content.
307
+
308
+ ```bash
309
+ # Read API model file metadata
310
+ apinow api read --file <file_id> [--org <org_id>]
311
+
312
+ # Read API model schema media content (JSON)
313
+ apinow api read --file <file_id> --media [--org <org_id>]
314
+ ```
315
+
316
+ ### 7. Schema Validation (`validate`)
252
317
 
253
318
  Validate local or remote Data Domain and API Model schemas against syntax, modeling rules, and naming conventions.
254
319
 
@@ -266,7 +331,7 @@ cat domain.json | apinow validate --stdin
266
331
  apinow validate --org <org_id> --fid <file_id>
267
332
  ```
268
333
 
269
- ### 7. Data Catalog (`catalog`)
334
+ ### 8. Data Catalog (`catalog`)
270
335
 
271
336
  Publish, inspect, and manage published catalog items.
272
337
 
@@ -290,7 +355,7 @@ apinow catalog deprecate <catalog_key> --reason "Superseded by v2" [--ver <versi
290
355
  apinow catalog unpublish <catalog_key> [--ver <version>]
291
356
  ```
292
357
 
293
- ### 8. Runtime (`runtime`)
358
+ ### 9. Runtime (`runtime`)
294
359
 
295
360
  Administrative operations for the API runtime. This command allows API Now! platform managers and administrators to modify runtime users directly.
296
361