search

ngageoint / scale

Processing framework for containerized algorithms
http://ngageoint.github.io/scale/
Apache License 2.0
105 stars 45 forks source link

Improve DataSet API documentation #1921

Open Fizz11 opened 3 years ago

Fizz11 commented 3 years ago

Pain Point? Please describe. Users have complained that the dataset structure in our API is very confusing. We should Improve the documentation, possibly with a usage example, to help clarify its usage.

Desired Solution Better documentation with examples

TMWesley commented 3 years ago

Hello, is this a REST API? If so I'd be happy to document.

cshamis commented 3 years ago

Yes.

The system records all files processed. A dataset is a type of collection of those file records that need to be considered “togeather” as a single group (a list) or… as a long list of single files; or even (rarely) a list of lists.

At least we think.

On Jun 23, 2021, at 9:43 PM, Tiffany Wesley @.***> wrote:

 Hello, is this a REST API? If so I'd be happy to document.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

TMWesley commented 3 years ago

Wonderful! Happy to help. Can you point me in the direction of the existing documentation?