microsoft / microsoft/azure-devops-rust-api
`release::releases::get_logs()` returns unprintable/garbled string
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 76
- Forks
- 27
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 3
Description
release::releases::get_logs() is currently defined to return Result<String>. However, it currently returns a lot of unprintable/garbled data...
Inspection of the response headers shows that the data is in compressed format:
content-type: application/zip; api-version=7.1-preview.2
Need to decide whether this API function should:
- Auto-decompress the data, by inspecting the
content-typeheader and doing unzip before returning the data asResult<String> - Document the fact that the returned data is zipped, and change the return type to be raw data:
Result<Vec<u8>>, leaving it up to the application to decompress (if required - app might just want to write the logs as a compressed file...)
I expect that this might apply to other API functions too.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with release::releases::get_logs() and inspect its response headers, especially content-type. Compare other API functions that may return compressed data, then decide whether to decompress or expose Result<Vec>; done when the return contract and documentation consistently reflect the chosen behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, rust
- Domain
- api
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100