publicapi: include user and device invites, and point existing docs to the new format. #12168
Conversation
This change includes the device and user invites API docs in the new publicapi documentation structure. Updates tailscale/corp#19526 Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>
catzkorn
requested review from
willnorris,
samlinville,
mpminardi and
soniaappasamy
|
I should have caught this on the previous PR, but consider renaming I worry a little bit that if a user lands on https://github.com/tailscale/tailscale/blob/catzkorn/updateapi/publicapi/device.md, it's not obvious in this structure how to find the rest of the documentation. One way would be to go back to the |
api.md
Outdated
| - Get a device: [`GET /api/v2/device/{deviceid}`](#get-device) | ||
| - Delete a device: [`DELETE /api/v2/device/{deviceID}`](#delete-device) | ||
| - Expire device key: [`POST /api/v2/device/{deviceID}/expire`](#expire-device-key) | ||
| - Get a device: [`GET /api/v2/device/{deviceid}`](./publicapi/device.md#get-device) |
There was a problem hiding this comment.
Thoughts on adding links to each of these rows that match the previous headers down below?
E.g.
<a name="device-get"></a>
That way if anyone had a link to a previous header, it would at least take them to the item in the table of contents where they should click through to the docs.
catzkorn
force-pushed
the
catzkorn/updateapi
branch
from
bacaac2
to
4c7d74e
Compare
…le#12168) This change includes the device and user invites API docs in the new publicapi documentation structure. Updates tailscale/corp#19526 Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>
This PR does two things: