search

datalust / seq-api

HTTP API client for Seq
https://datalust.co/seq
Apache License 2.0
77 stars 21 forks source link

Clean-up and documentation #71

Closed nblumhardt closed 4 years ago

nblumhardt commented 4 years ago

This began with an effort to document more of the API of this library, but in doing so I found a few places (mostly historical warts) where the API could be improved.

There are some more changes here, particularly around Link, which has been simplified quite a bit - it's now always a URI template (and a "literal" URI is represented as a template with no parameters). Some unused constructors were removed - we do use these elsewhere in the Seq codebase, but updating usages and moving the object -> Dictionary parameter handling to Seq itself if necessary should be straightforward.

SeqApiClient.HttpClient now always includes the API key and (version-identifying) Accept header; we always added these for requests made through the library, but requests made directly against the client would not include them (diminishing the value of exposing HttpClient in the first place).

Needs some bake-time on dev :-)

nblumhardt commented 4 years ago

Needs some bake-time on dev :-)

Actually, since 5.1.1 already includes quite a bit of churn, might be better to push it through with that. I'll do more testing via the integration harness before #70 goes out the door.