Azure / Azure/azure-rest-api-specs

[BUG] swagger is using field name dataflow in an inconsistent case with azure portal

Open
#33,947 1 comment 1 reaction 0 assignees View on GitHub
bug customer-reported Data Factory Mgmt Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 37m
Merged PRs (30d)
446

Description

### API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json#L8484

### API Spec version

2018-06-01

### Describe the bug

Swagger defined the field name as `dataFlow` while azure portal is using `dataflow`, which would cause incompatibility among different platforms.
![Image](https://github.com/user-attachments/assets/f4a386e6-a990-4fef-9a54-972004927cf2)

![Image](https://github.com/user-attachments/assets/55f28bc0-18e4-43c0-a410-f1af3974de87)

### Expected behavior

Service should unify the field name instead of using multiple parallel field names for one property.

### Actual behavior

Because of this inconsistency, SDK generated by swagger can only read dataflow by field name `dataFlow`, not `dataflow` from pipeline created by rest api or azure portal.

### Reproduction Steps

1. create a pipeline with dataflow activity with field name `dataflow` by [rest api](https://learn.microsoft.com/en-us/rest/api/datafactory/pipelines/create-or-update?view=rest-datafactory-2018-06-01&tabs=HTTP#code-try-0) or create it by azure portal.

2. get the pipeline by rest api, and it's able to read `dataflow` property with field name `dataflow`.
![Image](https://github.com/user-attachments/assets/bf097c68-0a3a-4237-bc72-f09ab6a115c8)

3. yet if get it though SDK, it failed to read dataflow since sdk can only read the field name `dataFlow`.
![Image](https://github.com/user-attachments/assets/4c8d1bcf-7bf3-4150-81dc-a4f0e0e3f212)

### Environment

_No response_

Contributor guide

Open the contributing guide

Research direction

Open specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json at the linked line and compare the declared field name with the REST API and Azure portal behavior described in the issue. Update the API specification so the property uses one consistent casing, then verify that the generated SDK can read pipelines returned with the service's field name.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.