Azure / Azure/azure-rest-api-specs

Swagger and wire values don't match leading to failed deserialization

Open
#7,003 6 comments 0 reactions 0 assignees View on GitHub
Data Lake Store Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

Ported from https://github.com/Azure/azure-sdk-for-go/issues/5549

See reference [Path](https://github.com/Azure/azure-rest-api-specs/blob/master/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json#L88).

The swagger defines `isDirectory` as `boolean` however the value sent over-the-wire is the string "true".
The swagger defines `contentLength` as `integer` however the value sent over-the-wire is the string "123".

Contributor guide

Open the contributing guide

Research direction

Start with the referenced DataLakeStorage.json path at line 88 and inspect the declarations for isDirectory and contentLength alongside the reported wire values. Trace the related schema or deserialization behavior, then verify that the specification and wire representation agree and that the reported deserialization failure is covered by validation or an existing test.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.