[IRS]🌟🚀[SPIKE][IMPL] Remediation of technical Debts /irs/orders api

[mkanal]

Overview

Explain the topic in 2 sentences

Since this API has not yet been used by any operational system, it should be thoroughly analyzed for technical debts and brought up to date with the latest development practices. Additionally, I want to implement missing integration tests for this interface to ensure its reliability and functionality.

What's the benefit?

Robust and working API which could be used in prod environment.

What are the Risks/Dependencies ?

• Nothing to report

Detailed explanation

Identification of technical debts, and a comprehensive list of identified debts is documented

Current implementation

Proposed improvements

Feature Team

Contributor

• Cofinity-X @rogocof
• Cofinity-X @mkanal

Committer

• @ds-jhartmann
• @ds-mwesener
• @ds-lcapellino

---

User Story

As a developer,
I want to identify and remediate the technical debts in the /irs/orders API,
so that it is aligned with the current development standards and is ready for productive usage.

Background

Since this API has not yet been used by any operational system, it should be thoroughly analyzed for technical debts and brought up to date with the latest development practices. Additionally, I want to implement missing integration tests for this interface to ensure its reliability and functionality.

Acceptance Criteria

• The /irs/orders API is thoroughly analyzed for technical debts, and a comprehensive list of identified debts is documented.
• The /irs/orders API is reviewed and updated to reflect the latest development requirements and best practices.
• PBIs are created in BL for remediation of technical debts
• Integration tests for the /irs/orders API are created and successfully executed, covering all critical functionalities of the interface.
• The results of the integration tests are documented, demonstrating that the API functions correctly and reliably under expected operational conditions.
• /irs/orders api is covered with load and stability tests based on current quantity model (20k in 24h/ 200k initial load 5 days)

---

Test Cases

Test Case 1

Steps

1. Do something
2. Click something
3. Add something

Expected Result

1. Expectation
2. Expectation
3. Expectation

Architectural Relevance

The following items are ensured (answer: yes) after this issue is implemented:

• This feature aligns with our current architectural guidelines
  • Data Sovereignty: All data sharing activities across company boundaries follow the Catena-X Regulatory Framework, in particular the Data Exchange Governance, and the Dataspace Protocol via a compliant Connector (like the tractusx-edc or similar, see Connector KIT)
    • CX-0010 Business Partner Number
    • CX-0013 Identity of Member Companies
    • CX-0018 Data Space Connectivity (EDC)
    • CX-0049 DID Document Schema
    • CX-0050 Framework Agreement Credential
    • CX-0149 Verified Company Identity
  • Interoperability: Digital Twins are used (compliant to the Digital Twin KIT and the Industry Core KIT)
    • CX-0001 EDC Discovery API
    • CX-0002 Digital Twins in Catena-X
    • CX-0018 Data Space Connectivity (EDC)
  • Data Format:
    • The data model is based on a published Semantic Model
• The impact on the overall system architecture has been assessed. The Feature does not require changes to the architecture or any existing standard? Please have a look here on the overarching architecture
• Potential risks or conflicts with existing architecture has been assessed

Justification: (Fill this out, if at least one of the checkboxes above cannot be ticked. Contact the Architecture Management Committee to get an approval for the justification)

Additional information

• I am aware that my request may not be developed if no developer can be found for it. I'll try to contribute a developer (bring your own developer)