Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please document the different syntaxes for line ranges #13

Open
sschuberth opened this issue Aug 20, 2024 · 2 comments
Open

Please document the different syntaxes for line ranges #13

sschuberth opened this issue Aug 20, 2024 · 2 comments
Assignees

Comments

@sschuberth
Copy link

The properties at

private final String lines;
@SerializedName("oss_lines")
private final String ossLines;

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
Copy link
Author

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 eeisegn self-assigned this Aug 20, 2024
@eeisegn
Copy link
Contributor

eeisegn commented Sep 6, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants