Skip to content

[Ticket] Add /verify endpoint to Repository components #997

@aaronzi

Description

@aaronzi

User Story

As a BaSyx user,
I want to identify AAS constraint issues in my AAS data with a dedicated endpoint,
so that I don't have to POST the data blindly without knowing what could potentially go wrong down the line.


Rules

  • Create a new /verify endpoint that is available in all three repositories
  • The endpoint should be able to verify Shells/Submodels/ConceptDescriptions no matter what component it belongs to
  • The endpoint should accept application/json, application/xml, application/aasx+json, application/aasx+xml (application/json should be available as request body and also as form data; the rest is just form data)
  • The endpoint should accept individual Shells/Submodels/ConceptDescriptions as well as entire Environments containing all of them together
  • AAS Core Works verify()functionality should be used
  • All errors should be returned

Acceptance Criteria

List the measurable conditions under which this task is considered complete.

  • Dedicated unit and integration tests covering all described scenarios from the rules
  • Available endpoints in the three repos as well as in the AAS Environment component

Risks and Assumptions

  • Probably makes sense to have the /uploadendpoint in place first since logic from that one can potentially be reused

Metadata

Metadata

Assignees

Labels

backlogTasks for future Sprints

Type

No type

Projects

Status

BaSyx Go

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions