Azure / Azure/azure-rest-api-specs

[IotHub] The actual return value of the delete operation is not consistent with Swagger

Open
#19,824 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

IoTHub Mgmt Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
6k
Avg merge
2d 21h
Merged PRs (30d)
432

Description

Delete a privateEndpointConnections

In the definition of swagger, it should return "#/definitions/PrivateEndpointConnection" when the status code is 200 or 202, but it actually returns

{"status":"Running"}
{"status":"Succeeded"}
Delete an IotHub

In the definition of swagger, it should return "#/definitions/IotHubDescription" when the status code is 200 or 202, but it actually returns

{"status":"Running"}
{"status":"Succeeded"}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked iothub.json definitions around lines 274 and 2007, then compare their documented responses with the Running and Succeeded payloads in the issue. Determine whether the specification or service behavior is intended, and confirm that both delete operations consistently document or return the same response shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, 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.