Project

General

Profile

Actions
Copy link

Bug #20229

closed

Document /_inspect/requests management endpoint

Added by Tom Clegg 9 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Tom Clegg
Category:
Documentation
Target version:
Development 2023-06-07
Start date:
05/16/2023
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
0.5
Release:
Arvados 2.6.3
Release relationship:
Auto

Description

All of our Go services (controller, keep-web, keepstore, ...) offer this management API, but API/admin docs currently don't mention it.

Subtasks 1 (0 open — 1 closed)

Task #20438: Review 20229-doc-inspect-requestsResolvedTom Clegg05/16/2023

Actions
Actions
Copy link
 #1

Updated by Peter Amstutz 9 months ago

  • Story points set to 0.5
Actions
Copy link
 #2

Updated by Peter Amstutz 9 months ago

  • Target version changed from To be groomed to To be scheduled
Actions
Copy link
 #3

Updated by Peter Amstutz 8 months ago

  • Target version changed from To be scheduled to Development 2023-05-10 sprint
Actions
Copy link
 #4

Updated by Tom Clegg 8 months ago

  • Assigned To set to Tom Clegg
Actions
Copy link
 #5

Updated by Tom Clegg 7 months ago

  • Target version changed from Development 2023-05-10 sprint to Development 2023-05-24 sprint
Actions
Copy link
 #6

Updated by Peter Amstutz 7 months ago

  • Target version changed from Development 2023-05-24 sprint to Development 2023-06-07
Actions
Copy link
 #7

Updated by Tom Clegg 7 months ago

20229-doc-inspect-requests @ a09cc1eec4f13db73269b2c282e8157a02a50682

Actions
Copy link
 #8

Updated by Tom Clegg 7 months ago

  • Status changed from New to In Progress
Actions
Copy link
 #9

Updated by Tom Clegg 7 months ago

  • Target version changed from Development 2023-06-07 to Development 2023-05-24 sprint
Actions
Copy link
 #10

Updated by Tom Clegg 7 months ago

  • Target version changed from Development 2023-05-24 sprint to Development 2023-06-07
Actions
Copy link
 #11

Updated by Peter Amstutz 7 months ago

  • Target version changed from Development 2023-06-07 to Development 2023-05-24 sprint
Actions
Copy link
 #12

Updated by Tom Clegg 7 months ago

  • Target version changed from Development 2023-05-24 sprint to Development 2023-06-07
Actions
Copy link
 #13

Updated by Brett Smith 7 months ago

Tom Clegg wrote in #note-7:

20229-doc-inspect-requests @ a09cc1eec4f13db73269b2c282e8157a02a50682

This is great, I just have minor copyediting/clarification suggestions. Please take the suggestions that make sense, leave the ones that don't, and merge.

  • Can the curl command be colored/highlighted to indicate user input? Would be nice to highlight the token and port number need changing. Maybe 0.0.0.0 too? Honestly not sure about that part.
  • "/_inspect/requests endpoint" table header → "Provides /_inspect/requests endpoint" or similar, a verb to add context to the checkmark
  • If there's a reasonable way to limit the table width to what's necessary that would be a nice affordance. Right now on a 16:9 browser window the checkmarks get pretty far from the service names.
  • "Example" header → "Example response" or "Example report", something like that.

Thanks.

Actions
Copy link
 #14

Updated by Tom Clegg 6 months ago

  • Status changed from In Progress to Resolved
Actions
Copy link
 #15

Updated by Peter Amstutz 6 months ago

  • Release set to 64
Actions
Copy link

Also available in: Atom PDF