Conversation
And apply the documentation changes.
matsduf
left a comment
There was a problem hiding this comment.
What is a "job" and what is a "test"? I think it is unclear in the API document. It starts by saying "Health checks are called tests in Zonemaster lingo" so what we store in the database are those "test results" or "job results"? The job is there to run a test and that would result in a "test result". If so, "test-id" is more reasonable than "job-id". The test remains when the job has completed.
I think this should be clarified in the API document.
The way I see it, a job runs some tests. The tests are the one from the specification. |
At the top of the API document it says "Health checks are called tests in Zonemaster lingo." The user "runs a domain test" and gets the "test result"? First we had too much "test", now it seems like we are loosing the connecting to tests. |
|
I looked through the API document, and I do not think that "job result" is a good term. A job is run and a test result comes out. If we communicate that it is a Job Result, then it is less understandable than Test Result. But it is fine to say that a job has been created. If you look for a test result, what should the identifier be? "Test ID" or "Job ID"? Here I think Test ID is probably easier to understand, but Job ID will work. If the outcome of a Job is a Test Result, then the method should rather be When the user runs (orders) a domain test, a Job is created and then there will be Test Result to present to the user. |
|
Closing this PR. The renaming might happen once the new RPCAPI is stabilized. |
Purpose
The API has been updated with new methods
job_*(#1054, #1083) . A test can now be referred as a job. It would then make sense to renametest_idtojob_id. This PR does that for the new API methods.Context
#1084
Changes
test_idAPI documentationHow to test this PR
Unit tests should pass.