Skip to content

Record a build's size by asset and dependency

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/builds/size
curl --request POST \  --url https://api.xovris.ai/v1/builds/size \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "app": null, "branch": null, "format": null, "report": null, "commit": null, "threshold": null, "idempotencyKey": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
app
branch
format
report
commit
threshold
idempotencyKey

Example

{  "app": null,  "branch": null,  "format": null,  "report": null,  "commit": null,  "threshold": null,  "idempotencyKey": null}

Done.

Media typeapplication/json
object
id
required
string
again
required
boolean
note
required
string
regression
required
One of:
object
sentence
required
string

Example

{  "id": "string",  "again": true,  "note": "string",  "regression": {    "sentence": "string"  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
id
required
string
again
required
boolean
total
required
number
diff
required
One of:
object
before
required
number
after
required
number
delta
required
number
assets
required
Array<object>
object
name
required
string
before
required
number
after
required
number
delta
required
number
dependencies
required
Array<object>
object
name
required
string
before
required
number
after
required
number
delta
required
number
regression
required
One of:
object
delta
required
number
share
required
number
commit
required
One of:
string
culprit
required
One of:
object
name
required
string
before
required
number
after
required
number
delta
required
number
fix
required
One of:
object
dependency
required
string
expectedBytes
required
number
change
required
string
sentence
required
string
preparedFix
required
One of:
object
dependency
string
expectedBytes
number
change
string
id
required
string
verified
required
Array<object>
object
dependency
required
string
sentence
required
string
alert
required
string
first
required
One of:
string

Example

{  "id": "string",  "again": true,  "total": 1,  "diff": {    "before": 1,    "after": 1,    "delta": 1,    "assets": [      {        "name": "string",        "before": 1,        "after": 1,        "delta": 1      }    ],    "dependencies": [      {        "name": "string",        "before": 1,        "after": 1,        "delta": 1      }    ]  },  "regression": {    "delta": 1,    "share": 1,    "commit": "string",    "culprit": {      "name": "string",      "before": 1,      "after": 1,      "delta": 1    },    "fix": {      "dependency": "string",      "expectedBytes": 1,      "change": "string"    },    "sentence": "string"  },  "preparedFix": {    "dependency": "string",    "expectedBytes": 1,    "change": "string",    "id": "string"  },  "verified": [    {      "dependency": "string",      "sentence": "string"    }  ],  "alert": "string",  "first": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.