Skip to content

Commit 08c584c

Browse files
BastienGimbertBastien GIMBERT
andauthored
docs(hub-api): Add organization overview and followers endpoints to API documentation (#2016)
* Add organization overview and followers endpoints to API documentation * Add note about equivalent function for listing organization followers * Update Organization API description --------- Co-authored-by: Bastien GIMBERT <[email protected]>
1 parent 856562e commit 08c584c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/hub/api.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,20 @@ This is equivalent to `huggingface_hub.whoami()`.
273273

274274
## Organization API
275275

276-
The following endpoint gets a list of the Organization members.
276+
The following endpoints handle organization like getting overview of an organization, listing members and followers.
277+
278+
### GET /api/organizations/{organization_name}/overview
279+
280+
Get the organization overview.
281+
282+
Payload:
283+
284+
```js
285+
headers = { "authorization" : "Bearer $token" }
286+
```
287+
288+
This is equivalent to `huggingface_hub.get_organization_overview()`.
289+
277290

278291
### GET /api/organizations/{organization_name}/members
279292

@@ -287,6 +300,17 @@ headers = { "authorization" : "Bearer $token" }
287300

288301
This is equivalent to `huggingface_hub.list_organization_members()`.
289302

303+
### GET /api/organizations/{organization_name}/followers
304+
305+
Get the organization followers.
306+
307+
Payload:
308+
309+
```js
310+
headers = { "authorization" : "Bearer $token" }
311+
```
312+
313+
this is equivalent to `huggingface_hub.list_organization_followers()`.
290314

291315
## Resource Groups API
292316

0 commit comments

Comments
 (0)