Skip to content

Commit

Permalink
Add enum values of SW360 data model correctly
Browse files Browse the repository at this point in the history
Issue: eclipse-archived#581

In the sw360 data model the documentation of the clearing states
are now added and the enum values are case corrected to be
upper case in the change status key.

Signed-off-by: Stephanie Neubauer <[email protected]>
  • Loading branch information
neubs-bsi committed Sep 2, 2020
1 parent 9ba9d03 commit cb0290d
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,10 @@ In the following section there is an outline what data of SW360 ${docNameCap} ma
| Release Tag Url | This is a link to the OSS repos tag of the release used stored as external id with key `orig_repo`. |
| Software Heritage ID | A release ID in software heritage in the format "swh:1:rel:*", stored as external id with key `swh`. |
| Copyrights | Copyrights of the release, given in a String. Individual copyrights are separated by line. Stored in the additional data section with key `copyrights` |
| Change Status | An enumeration with values `changed` or `as-is` stored as additional data with key `change_status`. A changed component release should be stored as own release with an appendix to the original version, e.g. `1.2.3_modified_xyz`. Currently the implementation can only handle `as-is` components. |
| Change Status | An enumeration with values `CHANGED` or `AS_IS` stored as additional data with key `change_status`. A changed component release should be stored as own release with an appendix to the original version, e.g. `1.2.3_modified_xyz`. Currently the implementation can only handle `AS_IS` components. |
| Homeapge Url | Homepage of the release that is also one of the component, given in a String. Stored in the additional data section with key `homepage` |
| Clearing State | State reflecting the clearing state within the ${docNameCap} curation processes with the values: `INITIAL`, `EXTERNAL_SOURCE`, `AUTO_EXTRACT`, `PROJECT_APPROVED`, `OSM_APPROVED`. This is stored in the additional data field with the key `clearingState`. |
| SW360 Clearing State | Can not be set with any analyzer, but is a reflection of the clearing state from the SW360 instance data model itself. The SW360 instance clearing state values are `NEW_CLEARING`, `SENT_TO_CLEARING_TOOL`, `REPORT_AVAILABLE`, `APPROVED`. This state is reflected in the SW360 instances UI in the `Clearing State`. |

#[[###]]## Used Attachments
Attachments are used to store additional elements in files, like sources and known binaries.
Expand Down

0 comments on commit cb0290d

Please sign in to comment.