spryker-sdk/Generate and Publish Spryker API Specs
Starts a Spryker Docker environment, generates API schemas, and uploads them to S3 if changed.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| app-type | The application type, used for naming the output file (e.g., "b2b", "b2b_marketplace", "b2c", "b2c_marketplace"). | yes | — |
| deploy-file | Path to the docker-sdk deploy file in the calling repository. | yes | deploy.ci.api.mariadb.yml |
| spryker-platform-image | The Spryker platform Docker image tag to use. | no | spryker/php:8.3 |
| spryker-region | The Spryker region (e.g., EU, US). | no | EU |
| s3-bucket | The AWS S3 bucket to upload the schemas to. | no | spryker |
| s3-prefix | The path prefix within the S3 bucket. | no | docs/api-specs |
| aws-region | The AWS region for the S3 bucket and credentials. | no | eu-central-1 |
| aws-role-to-assume | The ARN of the IAM role to assume for OIDC authentication. Recommended. | no | — |
| aws-access-key-id | The AWS access key ID. Use only if OIDC is not possible. | no | — |
| aws-secret-access-key | The AWS secret access key. Use only if OIDC is not possible. | no | — |
| storefront-server-url | A custom server URL for the Storefront API to override the one from the generated spec. Defaults to the `API_UPLOAD_GLUE_STOREFRONT_SERVER_URL` repository variable. | no | — |
| backend-server-url | A custom server URL for the Backend API to override the one from the generated spec. Defaults to the `API_UPLOAD_GLUE_BACKEND_SERVER_URL` repository variable. | no | — |
Outputs
no outputs