question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

API QA: `/status` endpoint returns a response body that's not consistent with the docs

See original GitHub issue

Description of the problem: Sending a GET request to /status endpoint results in this response body that doesn’t match the docs:

{
    "model_file": "models",
    "fingerprint": "5e0a7a1433b84d53843518203cef922c",
    "num_active_training_jobs": 0
}
  • Used a rasa init project for this test case.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
ancalitacommented, Nov 12, 2021

@carlad I think the only thing required is to mark it as fixed in the QA plan for architecture revamp, and then we’ll see if this shows up when the 2nd QA pass is carried by the rest of the team.

1reaction
joejuzlcommented, Nov 11, 2021

Which is the source of truth? Should the docs be updated, or the endpoint response payload?

Good question - both need to be updated somewhat.

  • “fingerprint” should now be called “model_id”. The value is correct but the key needs to change, and the docs.
  • “model_file” should return the model file name, not the directory name.
Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Validate Response Status using Rest Assured?
The status code that the server returns tells us whether the request was successful or not. If the request was successful, the server...
Read more >
REST API Testing Strategy: What Exactly Should You Test?
Our first concern is functional testing — ensuring that the API functions correctly. The main objectives in functional testing of the API are:...
Read more >
FastAPI always returns content, even if 204 no content status ...
I would expect FastAPI to not return null when response is None. ... Exception with endpoints returning HTTP status code 204 (no content) ......
Read more >
Rest API Response Codes And Types Of Rest Requests
In this tutorial, we will learn about different REST response codes, types of REST Requests, and some best practices to be followed.
Read more >
Testing and validating API responses with JSON Schema
Using JSON Schema to construct a model of your API response makes it easier to validate your API is returning the data is...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found