Skip to content

[P1][SDK] Align PHP package metadata and quickstarts with canonical product facts #7

Description

@karlwaldman

Outcome

Remove discoverable contradictions from the PHP SDK and publish one tested installation/auth/first-request path aligned with the reviewed public product-facts contract.

Scope

Audit the GitHub description, README, Composer metadata, Packagist text, examples, release notes, docs links, badges, and code comments that make product-level claims.

Acceptance Criteria

  • Package/install name, minimum supported PHP version, API base URL, auth behavior, environment convention, and first request are verified from executable code.
  • Examples use versioned routes and current commodity codes and cover 401/403/429 recovery.
  • No unsupported fixed refresh cadence, universal catalog count/access, WebSocket, SLA, price, history, redistribution, or plan claim remains.
  • Mutable facts link to the reviewed product contract rather than being duplicated where possible.
  • CI installs the built package in a clean environment and runs the exact documented example against fixtures plus a guarded smoke.
  • Packagist/GitHub metadata is republished or updated and the public URLs are attached to the issue.
  • A drift check flags future high-risk product literals.

Dependencies

  • OilpriceAPI/oilpriceapi-api#4799.
  • OilpriceAPI/oilpriceapi-docs#104.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1Priority 1 - complete in the active sprintsprint:llm-source-accuracyP1 sprint to correct and propagate canonical product facts to LLM retrieval surfaces

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions