womax/nova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api-ref: mention default project filtering when listing servers

Browse Source 
This removes the "all" wording from the List Servers API
reference docs since it could be confused with actually returning
all servers across all tenants (the all_tenants filters). It also
mentions that by default only servers associated with the project
making the request are returned, i.e. the project associated with
the auth token on the request. This is probably fairly obvious
and automatic to anyone that's worked with openstack for a long
time but might not be for a new user and is not really documented
anywhere in the API reference or API guide that I could find.

Change-Id: Ie28164e4813a7a48addcd80d81c72c978ac9f395
This commit is contained in:
Matt Riedemann
2019-05-17 15:30:13 -04:00
parent ed5b7c7fc3
commit c07746af90
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-ref/source/servers.inc
+3 -1
View File
@@ -99,8 +99,10 @@ List Servers
.. rest_method:: GET /servers
Lists IDs, names, and links for all servers.
Lists IDs, names, and links for servers.
By default the servers are filtered using the project ID associated
with the authenticated request.
Servers contain a status attribute that indicates the current server
state. You can filter on the server status when you complete a list