Skip to content

Commit 81bc364

Browse files
committed
skill nits
1 parent 59f6748 commit 81bc364

4 files changed

Lines changed: 84 additions & 6 deletions

File tree

plugins/b2c-cli/skills/b2c-code/SKILL.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ b2c code activate <version-name>
7373
b2c code activate --reload
7474
```
7575

76+
**Note:** Activating a code version triggers Custom API endpoint registration. If you've added or modified Custom APIs, use `--reload` with deploy or activate to register them. Check registration status with the `b2c-cli:b2c-scapi-custom` skill.
77+
7678
### Delete Code Version
7779

7880
```bash
@@ -83,3 +85,9 @@ b2c code delete <version-name>
8385
### More Commands
8486

8587
See `b2c code --help` for a full list of available commands and options in the `code` topic.
88+
89+
## Related Skills
90+
91+
- `b2c-cli:b2c-scapi-custom` - Check Custom API registration status after deployment
92+
- `b2c-cli:b2c-webdav` - Low-level file operations (delete cartridges, list files)
93+
- `b2c:b2c-custom-api-development` - Creating Custom API endpoints

plugins/b2c-cli/skills/b2c-scapi-custom/SKILL.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,8 @@ The tenant ID and short code can be set via environment variables:
8787
### More Commands
8888

8989
See `b2c scapi custom --help` for a full list of available commands and options.
90+
91+
## Related Skills
92+
93+
- `b2c:b2c-custom-api-development` - Creating Custom API endpoints (schema, script, mapping)
94+
- `b2c-cli:b2c-code` - Deploying and activating code versions (triggers registration)

plugins/b2c-cli/skills/b2c-webdav/SKILL.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,24 @@ b2c webdav rm src/instance/old-export.zip
239239
b2c webdav rm old-file.txt --root=temp
240240
```
241241

242+
### Delete Cartridges
243+
244+
To delete cartridges from a code version, use the `cartridges` root with the path format `{code-version}/{cartridge-name}`:
245+
246+
```bash
247+
# delete a cartridge from a code version
248+
b2c webdav rm v25_1_0/app_mysite --root=cartridges
249+
250+
# delete multiple cartridges
251+
b2c webdav rm v25_1_0/app_mysite --root=cartridges
252+
b2c webdav rm v25_1_0/int_myintegration --root=cartridges
253+
254+
# list cartridges in a code version first
255+
b2c webdav ls v25_1_0 --root=cartridges
256+
```
257+
258+
**Important:** The path is `{code-version}/{cartridge-name}`, not `/cartridges/{code-version}/...`. The `--root=cartridges` (or `-r cartridges`) flag sets the WebDAV root.
259+
242260
### Zip/Unzip Remote Files
243261

244262
```bash
@@ -252,3 +270,8 @@ b2c webdav unzip src/instance/archive.zip
252270
### More Commands
253271

254272
See `b2c webdav --help` for a full list of available commands and options in the `webdav` topic.
273+
274+
## Related Skills
275+
276+
- `b2c-cli:b2c-code` - Higher-level code deployment (preferred for cartridge upload)
277+
- `b2c-cli:b2c-job` - Import/export site archives

plugins/b2c/skills/b2c-custom-api-development/SKILL.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -291,12 +291,52 @@ To query the Custom API status report, use an Account Manager token with scope:
291291
2. **Define contract** (schema.yaml) with endpoints and security
292292
3. **Implement logic** (script.js) with exported functions
293293
4. **Create mapping** (api.json) binding endpoints to implementation
294-
5. **Upload cartridge** to your B2C instance
295-
6. **Activate code version** to register endpoints
296-
7. **Check status** to verify registration
297-
8. **Test endpoints** with appropriate authentication
298-
9. **Monitor logs** for errors during development
299-
10. **Iterate** on implementation as needed
294+
5. **Deploy and activate** to register endpoints
295+
6. **Check registration status** to verify endpoints are active
296+
7. **Test endpoints** with appropriate authentication
297+
8. **Monitor logs** for errors during development
298+
9. **Iterate** on implementation as needed
299+
300+
### Deployment Commands
301+
302+
Deploy your cartridge and activate to trigger Custom API registration:
303+
304+
```bash
305+
# Deploy cartridge and reload (re-activate) to register endpoints
306+
b2c code deploy ./my-cartridge --reload
307+
308+
# Or deploy then activate separately
309+
b2c code deploy ./my-cartridge
310+
b2c code activate my-code-version
311+
```
312+
313+
See the `b2c-cli:b2c-code` skill for more deployment options.
314+
315+
### Check Registration Status
316+
317+
After deployment, verify your endpoints are registered:
318+
319+
```bash
320+
# Check Custom API registration status
321+
# Tenant ID: derive from hostname (e.g., zzpq-013 → zzpq_013)
322+
b2c scapi custom status --tenant-id zzpq_013
323+
324+
# Filter to see only failed registrations
325+
b2c scapi custom status --tenant-id zzpq_013 --status not_registered
326+
327+
# Show error reasons for failed registrations
328+
b2c scapi custom status --tenant-id zzpq_013 --status not_registered --columns apiName,endpointPath,errorReason
329+
```
330+
331+
See the `b2c-cli:b2c-scapi-custom` skill for more status options.
332+
333+
### Common Registration Issues
334+
335+
| Issue | Solution |
336+
|-------|----------|
337+
| Endpoint shows `not_registered` | Check errorReason column, verify schema.yaml syntax |
338+
| Endpoint not appearing | Verify cartridge is in site's cartridge path, re-activate code version |
339+
| 404 on requests | Endpoint not registered or wrong URL path |
300340

301341
## HTTP Methods Supported
302342

@@ -344,6 +384,8 @@ To import a service configuration:
344384

345385
## Related Skills
346386

387+
- `b2c-cli:b2c-code` - Deploying cartridges and activating code versions
388+
- `b2c-cli:b2c-scapi-custom` - Checking Custom API registration status
347389
- `b2c:b2c-webservices` - Service configuration, HTTP/FTP/SOAP clients, services.xml format
348390
- `b2c-cli:b2c-job` - Running jobs and importing site archives
349391

0 commit comments

Comments
 (0)