8601e5b355
Each command directory now has both index.md (reference) and example.md (usage examples and configuration samples). Also adds exception for docs/cmd/build in .gitignore. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
35 lines
458 B
Markdown
35 lines
458 B
Markdown
# SDK Examples
|
|
|
|
## Validate
|
|
|
|
```bash
|
|
core sdk validate
|
|
core sdk validate --spec ./api.yaml
|
|
```
|
|
|
|
## Diff
|
|
|
|
```bash
|
|
# Compare with tag
|
|
core sdk diff --base v1.0.0
|
|
|
|
# Compare files
|
|
core sdk diff --base ./old-api.yaml --spec ./new-api.yaml
|
|
```
|
|
|
|
## Output
|
|
|
|
```
|
|
Breaking changes detected:
|
|
|
|
- DELETE /users/{id}/profile
|
|
Endpoint removed
|
|
|
|
- PATCH /users/{id}
|
|
Required field 'email' added
|
|
|
|
Non-breaking changes:
|
|
|
|
+ POST /users/{id}/avatar
|
|
New endpoint added
|
|
```
|