eclipse-edc / eclipse-edc/Connector

Dataplane Signaling Register endpoint is missing in V4 mgmt openapi schema

Open
#5,777 6 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
424
Forks
300
Avg merge
13h 11m
Merged PRs (30d)
35

Description

# Bug Report

## Describe the Bug

The `PUT /v4/dataplanes` endpoint is missing in the Management API openapi schema under `Dataplane Signaling Registration v4`. As seen here https://eclipse-edc.github.io/Connector/openapi/management-api/ , only the `DELETE` endpoint is visible.

### Expected Behavior

Both the `PUT` and `DELETE` endpoints to be visible as defined here https://github.com/eclipse-edc/Connector/blob/main/data-protocols/data-plane-signaling/data-plane-signaling-core/src/main/java/org/eclipse/edc/signaling/port/api/management/DataPlaneRegistrationApiV4.java#L35

### Observed Behavior

Only the `DELETE` endpoint is shown

## Steps to Reproduce

Steps to reproduce the behavior:

1. Go to https://eclipse-edc.github.io/Connector/openapi/management-api/#/Dataplane%20Signaling%20Registration%20v4
2. Click on `Dataplane Signaling Registration v4` group.
3. Observe that only `DELETE /v4/dataplanes/{dataplaneId}` entry is defined.

## Detailed Description

Might be some openapi spec merging issue as the `Dataplane Selector v4` also defines endpoints under the `/v4/dataplanes` url?

Contributor guide

Open the contributing guide

Research direction

Start with data-protocols/data-plane-signaling/data-plane-signaling-core/src/main/java/org/eclipse/edc/signaling/port/api/management/DataPlaneRegistrationApiV4.java and compare its PUT and DELETE definitions with the generated Management API schema. Then inspect how the Dataplane Signaling Registration v4 and Dataplane Selector v4 endpoints are merged under /v4/dataplanes. Done means the published schema shows both endpoints.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.