search

scanoss / scanoss.java

SCANOSS Java package providing a simple, easy to consume library for interacting with SCANOSS APIs.
https://scanoss.com
MIT License
2 stars 1 forks source link

Please document the different syntaxes for line ranges #13

Open sschuberth opened 1 month ago

sschuberth commented 1 month ago

The properties at

https://github.com/scanoss/scanoss.java/blob/8598c47987bb92490755972e845bd9fe2a6955d8/src/main/java/com/scanoss/dto/ScanFileDetails.java#L42-L44

seem to support different string-based syntaxes for line ranges, or even lists of line ranges. What I've seen so far is e.g. "42" and "66-99", but apparently also something like "32-105,117-199,210-266,278-488,500-781,793-937,951-1051,1062-1081" can be returned by the API. Please document all of the above, plus anything else that is to be expected.

sschuberth commented 1 month ago

As a side note, ideally the data model would be more typed here to begin with, and use an array of start and end lines which each are integers, instead of a string that the user of this library needs to parse on its own.

eeisegn commented 2 weeks ago

Hi @sschuberth ,

Thanks for the feedback! For the current version of this JSON schema we are keeping it as a string (comma separated). We are working on a new structure and when that is published it will be fully typed. We will share this info once it has been finalised.