Update api docs to add option for deleting a single IP #508
Conversation
|
Awesome, thanks! 👍 |
_data/api.yml
Outdated
| @@ -1758,6 +1758,9 @@ sections: | |||
| pool: | |||
| type: Option[String] | |||
| description: If specified, only addresses associated with the given pool are deleted. Otherwise, all addresses are deleted. | |||
| address: | |||
| type: Option[String] | |||
| description: If specified, delete only the given address. | |||
There was a problem hiding this comment.
perhaps something like:
If specified, delete only the given address, else all of them.
and modify:
description: Delete all addresses associated with a given tag, optionally associated with a pool
to be something like:
description: Delete addresses associated with a given tag, optionally associated with a pool, or optional single address
ssgelm
force-pushed
the
docs-update-delete-single-ip
branch
from
9b577b5
to
8a7fbe4
Compare
|
@roymarantz I updated the docs as requested. Does this look better? |
| @@ -1748,7 +1748,7 @@ sections: | |||
| } | |||
| } | |||
| "delete an address": | |||
| description: Delete all addresses associated with a given tag, optionally associated with a pool | |||
| description: Delete addresses associated with a given tag: either all addresses, those associated with a specified pool, or a single address. | |||
There was a problem hiding this comment.
the code seem to support specifying a pool and address. is it wrong or is this line?
There was a problem hiding this comment.
The code should support it but I'm not sure what the value would be.
There was a problem hiding this comment.
I think I was just misreading this, so don't worry about it.
|
👍 |
As added in #505. This updates the docs to go along with that PR.