Skip to content

Inconstancies with the REST API's JSON #13

Open
@jfischoff

Description

The wiki says for multi get https://github.com/imvu-open/istatd/wiki/Get-multiple-counters
says to use a JSON like

{
    "start": START,
    "end": END,
    "maxSamples": MAX,
    "keys": ["counter.name", "yet.another.counter.name"],
    "trailing": 0
}

But it should be stop instead of end

However, sometimes end is used instead of stop.

in the response documentation we have

{
    "start": int,
    "end":   int, 
    "counter.name": {
        "interval": int,
        "data": [
            {
                "time":  int,

what it really is:

{
    "start": int,
    "stop":   int, 
    "counter.name": {
        "interval": int,
        "data": [
            {
                "start": int,
                "end":   int, 
                "time":  int,

So we are not documenting that there is time interval in the bucket counter object and it uses end unlike the other intervals which use stop.

We should pick one convention and stick with it, and also update the documentation.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions