Skip to content

Commit 4bef007

Browse files
Merge pull request #12 from godaddy/codex/api-skill-command-guidance
docs(skill): route address discovery to api commands
2 parents f29fc89 + feeae2a commit 4bef007

1 file changed

Lines changed: 37 additions & 22 deletions

File tree

.agents/skills/godaddy-cli/SKILL.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -255,45 +255,60 @@ godaddy application deploy <name> --follow
255255

256256
Release and deploy accept `--config <path>` and `--environment <env>`.
257257

258-
### Raw API Requests
258+
### API Discovery and Requests
259259

260-
Make authenticated requests to any GoDaddy API endpoint:
260+
Use `godaddy api` for endpoint discovery and authenticated API calls:
261261

262262
```bash
263-
# GET request
264-
godaddy api /v1/commerce/catalog/products
265-
266-
# POST with inline fields
267-
godaddy api /v1/some/endpoint -X POST -f "name=value" -f "count=5"
268-
269-
# POST with body from file
270-
godaddy api /v1/some/endpoint -X POST -F body.json
271-
272-
# Custom headers
273-
godaddy api /v1/some/endpoint -H "X-Custom: value"
263+
# List domains and endpoints
264+
godaddy api list
265+
godaddy api list --domain commerce
266+
267+
# Describe one endpoint (operation ID or path)
268+
godaddy api describe commerce.location.verify-address
269+
godaddy api describe /location/addresses
270+
271+
# Search endpoints by keyword
272+
godaddy api search address
273+
godaddy api search catalog
274+
275+
# Call endpoint (explicit form)
276+
godaddy api call /v1/commerce/catalog/products
277+
godaddy api call /v1/some/endpoint -X POST -f "name=value" -f "count=5"
278+
godaddy api call /v1/some/endpoint -X POST -F body.json
279+
godaddy api call /v1/some/endpoint -H "X-Custom: value"
280+
godaddy api call /v1/some/endpoint -q ".data[0].id"
281+
godaddy api call /v1/some/endpoint -i
282+
godaddy api call /v1/commerce/orders -s commerce.orders:read
283+
```
274284

275-
# Extract a field from the response
276-
godaddy api /v1/some/endpoint -q ".data[0].id"
285+
Compatibility behavior:
286+
- `godaddy api <endpoint>` still works. If the token after `api` is not one of `list`, `describe`, `search`, or `call`, the CLI treats it as an endpoint and executes `api call`.
287+
- This means legacy usage like `godaddy api /v1/commerce/location/addresses` remains supported.
277288

278-
# Include response headers in output
279-
godaddy api /v1/some/endpoint -i
289+
As with other large result sets, `api list` may be truncated in the inline JSON response. When `truncated: true`, read the `full_output` file path for complete results.
280290

281-
# Auto re-auth on 403 with specific scope
282-
godaddy api /v1/commerce/orders -s commerce.orders:read
283-
```
291+
Address task rule:
292+
- For requests like "find/search/verify an address", start with:
293+
`godaddy api search address`
294+
`godaddy api list --domain location`
295+
`godaddy api describe /location/addresses`
296+
- Do not use `godaddy actions describe` for generic API endpoint discovery.
284297

285298
### Actions
286299

300+
`godaddy actions` is only for developers discovering action hook contracts they can integrate with as providers (or consume as a contract in app configuration). It is not for API endpoint discovery or API calls.
301+
287302
```bash
288303
# List all available actions
289304
godaddy actions list
290305

291306
# Describe an action's request/response contract
292-
godaddy actions describe location.address.verify
293307
godaddy actions describe commerce.taxes.calculate
308+
godaddy actions describe commerce.payment.process
294309
```
295310

296-
Available actions: `location.address.verify`, `commerce.taxes.calculate`, `commerce.shipping-rates.calculate`, `commerce.price-adjustment.apply`, `commerce.price-adjustment.list`, `notifications.email.send`, `commerce.payment.get`, `commerce.payment.cancel`, `commerce.payment.refund`, `commerce.payment.process`, `commerce.payment.auth`.
311+
Use `godaddy actions list` to discover current action names and then `godaddy actions describe <action>` to inspect request/response schemas for that hook contract.
297312

298313
### Webhooks
299314

0 commit comments

Comments
 (0)