| name | contentstack-utils |
|---|---|
| description | PHP Delivery SDK API—Contentstack::Stack, queries, entries, assets, regions, sync; RTE via Composer package contentstack/utils. |
- Implementing or changing Delivery API behavior, query builders, entries, assets, or sync.
- Updating
README.md/CHANGELOG.mdfor user-visible behavior. - Assessing semver impact of public API changes or
contentstack/utilsusage.
- Consumers use
Contentstack\Contentstack::Stack(...)to obtain aContentstack\Stack\Stackinstance (API key, delivery token, environment, optional region / branch / live preview config). - Query and fetch patterns flow through content types, queries, entries, and assets under
src/Stack/. - RTE / JSON rendering:
Contentstack::renderContentand related helpers delegate to thecontentstack/utilsComposer package (Contentstack\Utils\*,Option). Do not reimplement utils behavior inside this SDK without strong reason.
- Stack config array supports region, branch, live preview host/enable flags—preserve backward compatibility when extending keys.
- ContentstackRegion (or string region values per existing API) must stay consistent with documented Contentstack regions.
- The SDK builds requests to Contentstack Delivery endpoints; keep URL construction, headers, and query parameters aligned with product documentation.
- Result parsing should match documented JSON shapes; guard against missing keys where the API allows omission.
- Use
Contentstack\Error\CSExceptionandErrorMessagespatterns for domain failures. - Avoid suppressing errors on public code paths without documentation.
contentstack/utilsis a required dependency for RTE features shipped through this repo’s public surface; version ranges incomposer.jsonshould stay coherent with utils releases.
- Follow semver for public API changes; update CHANGELOG and tag/release process per team norms.
- Contentstack
- PHP Delivery SDK docs
skills/php-style/SKILL.md,skills/framework/SKILL.md