Skip to content

Docs are out of date #38

@sgammon

Description

@sgammon

What did you do?

I followed the documentation exactly, in multiple places it is mentioned to initialize the Stream Swift client like this:

Client.config = .init(apiKey: "<#ApiKey#>", appId: "<#AppId#>", token: "<#Token#>")

It mentions this:

  • Here, in this repository's own README
  • Here in the main Stream Swift docs

What did you expect to happen?

I expected the documentation to be useful and accurate

What happened instead?

It turns out the API interface has changed, as depicted here, so my application broke with a bunch of compile-time errors, despite using the latest version of the package and following the documentation exactly

GetStream Environment

GetStream version: Latest
Xcode version: Latest
Swift version: Latest
Platform(s) running GetStream: iOS / Web
macOS version running Xcode: Latest

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions