api.md: direct TOC links to new publicapi docs location

This change updates the existing api.md TOC links to point at the new
publicapi folder/files. It also removes the body of the docs from the
file, to avoid the docs becoming out of sync.

This change also renames overview.md to readme.md.

Updates tailscale/corp#19526

Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>
This commit is contained in:
Charlotte Brandhorst-Satzkorn
2024-05-17 16:47:47 -07:00
committed by Sonia Appasamy
parent 964282d34f
commit 4f4f317174
4 changed files with 67 additions and 2730 deletions

View File

@@ -236,8 +236,6 @@ The API exposes two methods for dealing with subnet routes:
- Get routes: [`GET /api/v2/device/{deviceID}/routes`](#get-device-routes) to fetch lists of advertised and enabled routes for a device
- Set routes: [`POST /api/v2/device/{deviceID}/routes`](#set-device-routes) to set enabled routes for a device
<a name="device-get"></a>
## Get device
```http
@@ -295,8 +293,6 @@ curl "https://api.tailscale.com/api/v2/device/12345?fields=all" \
}
```
<a href="device-delete"></a>
## Delete device
```http
@@ -336,8 +332,6 @@ HTTP/1.1 501 Not Implemented
{"message":"cannot delete devices outside of your tailnet"}
```
<a href="expire-device-key"></a>
## Expire a device's key
```http
@@ -372,8 +366,6 @@ HTTP/1.1 200 OK
## Routes
<a href="device-routes-get">
## Get device routes
```http
@@ -409,8 +401,6 @@ Returns the enabled and advertised subnet routes for a device.
}
```
<a href="device-routes-post"></a>
## Set device routes
```http
@@ -458,8 +448,6 @@ Returns the enabled and advertised subnet routes for a device.
## Authorize
<a href="#device-authorized-post"></a>
## Authorize device
```http
@@ -502,8 +490,6 @@ The response is 2xx on success. The response body is currently an empty JSON obj
## Tags
<a href="device-tags-post"></a>
## Update device tags
```http
@@ -562,8 +548,6 @@ If the tags supplied in the `POST` call do not exist in the tailnet policy file,
## Keys
<a href="device-key-post"></a>
## Update device key
```http