Tools · Web testing tools · 27 / 27
A Burp comment is not a response header
The comment column is your note. A response header came from the lab. Do not quote the comment as a header.
The comment is text you typed
HTTP history has a comment column. Whatever you type there is stored with the row in the project. Harbor Ledger did not send it. A teammate who reads only the comment can mistake your words for a header unless you label them.
Type a short marker such as checked owner on the invoice API row so you can find it. That marker is the example for this lesson. It is not a field in the JSON.
Headers are in the response pane
Select the row and read the response headers. Those names are what the lab sent. Content-Type and any cache header live there. Your comment does not. If you need the invoice owner, it is in the response body for GET /api/invoices/1042, which is also not the comment.
A word that appears only in the comment is not a header. Write “not in the response headers” rather than promoting the comment.
Label the annotation
The note has a line for the comment and a line for the headers you are citing. Mixing them makes the lab look as if it emitted your reminder. The status and the length stay in their own columns, from the earlier reading, and they are not comments either.
Worked case: a comment filed as a header
On the captured GET /api/invoices/1042, set the history comment to checked owner. A draft says the response included a header named checked owner. The response pane does not list that name.
The note says the comment is yours and lists only the header names that are in the pane. The owner, if you mention it, is quoted from the JSON body. The invented header is removed. The request is not edited.
row: GET /api/invoices/1042 comment: checked owner response headers: only the names in the pane body field: quote from the JSON if you need it write: comment and headers apart not: a header named checked owner
Diagram
Your annotation and the lab’s headers
- Comment
Text you typed on the history row. It is yours.
- Headers
What Harbor Ledger sent, in the response pane.
- Body
The JSON, if that is where the field actually is.
- Note
Do not move the comment into either of those.
A note you typed is not a header the app sent
Who wrote it. You, in the proxy
Example. checked owner
Is not. A response header
Who wrote it. Harbor Ledger, on that response
Headers. Only the names in the header pane
Owner. A JSON field, if the body has it, not the comment
Check yourself
1. You typed “checked owner” in the comment column. What is that text?
2. Where do you read the owner the lab returned for invoice 1042?
3. The comment says verified, and no response header says that. What do you quote as a header?