search

eclipse / kapua

Eclipse Public License 2.0
225 stars 160 forks source link

Add OpenAPI schema and description for `JobStep` object #3985

Closed MDeLuise closed 8 months ago

MDeLuise commented 8 months ago

This pull request introduces OpenAPI schema definitions and descriptions for theJobStep object, enhancing the clarity and completeness of the API documentation.

The JobStep object plays a critical role in defining step for various job-related activities within the system. By including detailed schema definitions and descriptions, developers and users will have better insight into the structure and purpose of theJobStep object, facilitating more effective utilization of the API.

After the PR:

Screenshot 2024-03-08 at 17 05 36

Before the PR:

Screenshot 2024-03-08 at 14 40 19
codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 21.22%. Comparing base (87947b0) to head (50527e9). Report is 5 commits behind head on develop.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/eclipse/kapua/pull/3985/graphs/tree.svg?width=650&height=150&src=pr&token=1P4N4CApH8&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse)](https://app.codecov.io/gh/eclipse/kapua/pull/3985?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse) ```diff @@ Coverage Diff @@ ## develop #3985 +/- ## ========================================== Coverage 21.21% 21.22% Complexity 10 10 ========================================== Files 1942 1942 Lines 41276 41276 Branches 3796 3796 ========================================== + Hits 8757 8759 +2 + Misses 32113 32112 -1 + Partials 406 405 -1 ``` [see 1 file with indirect coverage changes](https://app.codecov.io/gh/eclipse/kapua/pull/3985/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse)