Skip to content

Commit c39e9fd

Browse files
committed
improve description of endpoint
1 parent 8e0f908 commit c39e9fd

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

hypernode_api_python/client.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,8 +633,30 @@ def order_hypernode(self, data):
633633
def get_active_branchers(self, app_name):
634634
"""
635635
List all active brancher nodes of your Hypernode.
636+
Example:
637+
> client.get_active_branchers('yourhypernodeappname').json()
638+
> {
639+
> "totalTime": 9417.327453,
640+
> "totalAmountSpent": 9417.327453,
641+
> "branchers": [
642+
> {
643+
> "id": 21,
644+
> "name": "yourhypernodeappname-eph123456",
645+
> "ip": "127.0.0.1",
646+
> "elapsed_time": "5008.662653",
647+
> "description": "PHP version 7.1"
648+
> },
649+
> {
650+
> "id": 22,
651+
> "name": "yourhypernodeappname-eph654321",
652+
> "ip": "52.68.96.58",
653+
> "elapsed_time": "4408.6648",
654+
> "description": null
655+
> }
656+
> ]
657+
> }
636658
637-
:param str app_name: The name of the Hypernode to create the branch from
659+
:param str app_name: The name of the Hypernode to get your active branchers for
638660
:return obj response: The request response object
639661
"""
640662
HYPERNODE_API_APP_BRANCHER_ENDPOINT = "/v2/app/{}/brancher/"

0 commit comments

Comments
 (0)