Bug #23023
closedUpdate API docs to mention published_ports[external_port], [base_url], and [initial_path]
Description
In #22859 we started adding these to each container's published_ports map.
In the meantime you can see #22859#note-3 or source:services/api/app/models/container.rb for the exact fields.- initial_url
- base_url
- external_port
Updated by Tom Clegg 9 months ago
- Related to Idea #22859: Support service containers on a single host added
Updated by Tom Clegg 9 months ago
- Related to Idea #17207: services running in containers added
Updated by Brett Smith 8 months ago
Note this doesn't make sense to do for as long as we do #23062.
Updated by Brett Smith 8 months ago
- Target version set to Development 2025-08-06
- Assigned To set to Tom Clegg
Updated by Tom Clegg 8 months ago
- Status changed from New to In Progress
23023-published-ports-docs @ d0e6de9e2040d6c603a16fe33c0b01cc4a2bbdda -- developer-run-tests: #4840
- update docs
Updated by Brett Smith 8 months ago
Tom Clegg wrote in #note-8:
23023-published-ports-docs @ d0e6de9e2040d6c603a16fe33c0b01cc4a2bbdda -- developer-run-tests: #4840
One readability nit: for the container example, I think it would be helpful to underline again that these fields only appear on running containers. I know it's mentioned above the table, but since this is reference documentation readers will probably skim for the thing that looks most helpful to them and may not read it all the way through. And while we're at it, this is even less pressing but I don't think we should relegate "(container request)" and "(container)" to parentheticals since they're pretty critical information. Suggest: "Example published_ports attribute for a container request" and "Example published_ports attribute for a running container," but I'm open to further wordsmithing.
This is not critical. Please merge whether you take this verbatim, with tweaks, or would rather not. Thanks.
Updated by Tom Clegg 8 months ago
- Status changed from In Progress to Resolved
Applied in changeset arvados|6fae4708f47defa530c7c3fe29122b42ba41bed7.