Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API-Wrapper] Missing mandatory field validation similar to edc-ui ("EDC API validation issue - Asset is creating without mandatory fields") #1019

Closed
tmberthold opened this issue Aug 7, 2024 · 1 comment
Labels
bug/compatibility Bug occurs when the software doesn't work as expected in some environments, such as specific config. bug/usability Bug makes the software difficult to use. Likely related to UI, documentation. kind/bug Something isn't working. The software does not behave as expected or specified. scope/mds related to MDS
Milestone

Comments

@tmberthold
Copy link
Contributor

tmberthold commented Aug 7, 2024

Description - What happened? *

Mandatory fields are checked via the UI but not when using the API-Wrapper directly. This means that in the MDS context e.g. assets can be created without the MDS-specific mandatory fields by directly using the API-Wrapper.

Create asset without mandatory fields (dataCategory field) using this API endpoint :

{{PROVIDER_EDC_MANAGEMENT_URL}}/wrapper/ui/pages/asset-page/assets - User able to create asset

Form EDC UI: Validation provided for mandatory fields while creating Asset.
API validation required for below sections :
- Create asset without mandatory field is allowing
- Create contract definition without mandatory field is allowing
- Create policy without mandatory field is allowing

Expected Behavior *

From API asset should not be created without mandatory fields.

Observed Behavior *

From API asset is getting created without mandatory fields

Steps to Reproduce

Steps to reproduce the behavior:

Create asset with postman API :{{PROVIDER_EDC_MANAGEMENT_URL}}/wrapper/ui/pages/asset-page/assets
Validate mandatory fields shows an error message

Context Information

EDC CE 10.0.0 and its UI

Relevant log output

No response

Screenshots

No response

@tmberthold tmberthold added kind/bug Something isn't working. The software does not behave as expected or specified. scope/mds related to MDS bug/compatibility Bug occurs when the software doesn't work as expected in some environments, such as specific config. bug/usability Bug makes the software difficult to use. Likely related to UI, documentation. labels Aug 7, 2024
@tmberthold tmberthold changed the title API-Wrapper doesn't do same validation as UI ("EDC API validation issue - Asset is creating without mandatory fields") API-Wrapper missing same input validation as UI ("EDC API validation issue - Asset is creating without mandatory fields") Aug 7, 2024
@tmberthold tmberthold added this to the MDS 2.2 milestone Aug 7, 2024
@AbdullahMuk AbdullahMuk changed the title API-Wrapper missing same input validation as UI ("EDC API validation issue - Asset is creating without mandatory fields") [API-Wrapper] Missing mandatory field validation similar to edc-ui ("EDC API validation issue - Asset is creating without mandatory fields") Aug 7, 2024
@AbdullahMuk AbdullahMuk assigned ununhexium and unassigned ununhexium Aug 7, 2024
@AbdullahMuk
Copy link
Collaborator

Bug not considered as bug because:

  • sovity API Wrapper is built in platform-agnostic manner as per general SaaS practices that allow for maximum flexibility. App developers bear the responsibility of adapt the relevant API elements according to their needs; which is what sovity does when it offers the CaaS with a UI.

Also given the below factors, adapting the gap raised will require unnecessary effort for almost no added value over the current situation because:

  • (1) MDS predominantly offers a UI-centric product to its users
  • (2) with no further evidence, sovity assumes that MDS only grants backend integration capability with MDS customers' systems in limited case at the condition that customers have advanced technical knowledge of API integrations.
    • Assuming this scenario, sovity advises MDS to adapt its technical documentation to clearly hint to software architects what fields in the API should be filled.

To conclude, there is no bug that requires fixing based on the description provided.

/cc @tmberthold for you to communicate back to MDS.
/cc @jkbquabeck

@AbdullahMuk AbdullahMuk closed this as not planned Won't fix, can't repro, duplicate, stale Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug/compatibility Bug occurs when the software doesn't work as expected in some environments, such as specific config. bug/usability Bug makes the software difficult to use. Likely related to UI, documentation. kind/bug Something isn't working. The software does not behave as expected or specified. scope/mds related to MDS
Projects
None yet
Development

No branches or pull requests

3 participants