28d004ff61
Go CLI commands moved to core/go-php. This repo now contains the Laravel modular monolith framework (previously php-framework). - Remove all Go files (now in core/go-php) - Add PHP framework: event-driven module loading, lifecycle events - Composer package: core/php - core/php-framework remains as-is for backward compat Co-Authored-By: Virgil <virgil@lethean.io>
1.9 KiB
1.9 KiB
core sdk
SDK validation and API compatibility tools.
To generate SDKs, use: core build sdk
Usage
core sdk <command> [flags]
Commands
| Command | Description |
|---|---|
diff |
Check for breaking API changes |
validate |
Validate OpenAPI spec |
sdk validate
Validate an OpenAPI specification file.
core sdk validate [flags]
Flags
| Flag | Description |
|---|---|
--spec |
Path to OpenAPI spec file (auto-detected) |
Examples
# Validate detected spec
core sdk validate
# Validate specific file
core sdk validate --spec api/openapi.yaml
sdk diff
Check for breaking changes between API versions.
core sdk diff [flags]
Flags
| Flag | Description |
|---|---|
--base |
Base spec version (git tag or file path) |
--spec |
Current spec file (auto-detected) |
Examples
# Compare against previous release
core sdk diff --base v1.0.0
# Compare two files
core sdk diff --base old-api.yaml --spec new-api.yaml
Breaking Changes Detected
- Removed endpoints
- Changed parameter types
- Removed required fields
- Changed response types
SDK Generation
SDK generation is handled by core build sdk, not this command.
# Generate SDKs
core build sdk
# Generate specific language
core build sdk --lang typescript
# Preview without writing
core build sdk --dry-run
See build sdk for generation details.
Spec Auto-Detection
Core looks for OpenAPI specs in this order:
- Path specified in config (
sdk.spec) openapi.yaml/openapi.jsonapi/openapi.yaml/api/openapi.jsondocs/openapi.yaml/docs/openapi.json- Laravel Scramble endpoint (
/docs/api.json)
See Also
- build sdk - Generate SDKs from OpenAPI
- ci command - Release workflow