Repository navigation
Commit cf10552
committed
docs(ingest): finish the file, and hedge where the code hedges
Review found a fourth spot in the same file, and it was the one that matters
most for someone writing against the response: the `initial_run_id` FIELD doc
still said "Only on the POST /ingests response for a one_time ingest". That is
the line a reader hits while handling the value, and it contradicted the
corrected comment 370 lines above it. It now says where a run id would appear,
that the service does not populate it, and where to actually find the run.
The struct doc no longer advertises `initial_run_id` as part of what create
returns.
Also softened the create comment from a permanent guarantee to current
behaviour. The render in commands::ingest deliberately keeps a branch for a run
id "in case the service ever starts reporting one", and the client tests cover
a populated value; docs asserting it can never be populated would put the file
at odds with the hedge the code chose on purpose. The field stays Option for
the same reason -- a service that starts reporting one needs no client change.
464 tests pass.1 parent e0b3a55 commit cf10552
1 file changed
Lines changed: 15 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
463 | 463 | | |
464 | 464 | | |
465 | 465 | | |
466 | | - | |
467 | | - | |
468 | | - | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
469 | 473 | | |
470 | 474 | | |
471 | 475 | | |
| |||
800 | 804 | | |
801 | 805 | | |
802 | 806 | | |
803 | | - | |
804 | | - | |
805 | | - | |
| 807 | + | |
| 808 | + | |
| 809 | + | |
806 | 810 | | |
807 | 811 | | |
808 | 812 | | |
| |||
833 | 837 | | |
834 | 838 | | |
835 | 839 | | |
836 | | - | |
| 840 | + | |
| 841 | + | |
| 842 | + | |
| 843 | + | |
| 844 | + | |
837 | 845 | | |
838 | 846 | | |
839 | 847 | | |
| |||
0 commit comments