@@ -27,10 +27,8 @@ handle_relogin_sync(func: Callable[..., httpx.Response])
2727
2828### ` BaseClient ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L108" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
2929
30-
3130Base class for InfrahubClient and InfrahubClientSync
3231
33-
3432** Methods:**
3533
3634#### ` request_context ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L162" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
@@ -59,10 +57,8 @@ set_context_properties(self, identifier: str, params: dict[str, str] | None = No
5957
6058### ` InfrahubClient ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L290" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
6159
62-
6360GraphQL Client to interact with Infrahub.
6461
65-
6662** Methods:**
6763
6864#### ` get_version ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L305" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
@@ -73,7 +69,6 @@ get_version(self) -> str
7369
7470Return the Infrahub version.
7571
76-
7772#### ` get_user ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L311" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
7873
7974``` python
@@ -82,7 +77,6 @@ get_user(self) -> dict
8277
8378Return user information
8479
85-
8680#### ` get_user_permissions ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L316" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
8781
8882``` python
@@ -91,7 +85,6 @@ get_user_permissions(self) -> dict
9185
9286Return user permissions
9387
94-
9588#### ` create ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L322" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
9689
9790``` python
@@ -166,7 +159,6 @@ count(self, kind: str | type[SchemaType], at: Timestamp | None = None, branch: s
166159
167160Return the number of nodes of a given kind.
168161
169-
170162#### ` all ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L608" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
171163
172164``` python
@@ -188,6 +180,7 @@ all(self, kind: str | type[SchemaType], at: Timestamp | None = None, branch: str
188180Retrieve all nodes of a given kind
189181
190182** Args:**
183+
191184- ` kind ` : kind of the nodes to query
192185- ` at ` : Time of the query. Defaults to Now.
193186- ` branch ` : Name of the branch to query from. Defaults to default_branch.
@@ -203,8 +196,8 @@ Retrieve all nodes of a given kind
203196- ` order ` : Ordering related options. Setting ` disable=True ` enhances performances.
204197
205198** Returns:**
206- - list\[ InfrahubNode] : List of Nodes
207199
200+ - list\[ InfrahubNode] : List of Nodes
208201
209202#### ` filters ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L700" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
210203
@@ -227,6 +220,7 @@ filters(self, kind: str | type[SchemaType], at: Timestamp | None = None, branch:
227220Retrieve nodes of a given kind based on provided filters.
228221
229222** Args:**
223+
230224- ` kind ` : kind of the nodes to query
231225- ` at ` : Time of the query. Defaults to Now.
232226- ` branch ` : Name of the branch to query from. Defaults to default_branch.
@@ -244,8 +238,8 @@ Retrieve nodes of a given kind based on provided filters.
244238- ` **kwargs ` : Additional filter criteria for the query.
245239
246240** Returns:**
247- - list\[ InfrahubNodeSync] : List of Nodes that match the given filters.
248241
242+ - list\[ InfrahubNodeSync] : List of Nodes that match the given filters.
249243
250244#### ` clone ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L873" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
251245
@@ -255,7 +249,6 @@ clone(self, branch: str | None = None) -> InfrahubClient
255249
256250Return a cloned version of the client using the same configuration
257251
258-
259252#### ` execute_graphql ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L877" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
260253
261254``` python
@@ -266,6 +259,7 @@ Execute a GraphQL query (or mutation).
266259If retry_on_failure is True, the query will retry until the server becomes reacheable.
267260
268261** Args:**
262+
269263- ` query ` : GraphQL Query to execute, can be a query or a mutation
270264- ` variables ` : Variables to pass along with the GraphQL query. Defaults to None.
271265- ` branch_name ` : Name of the branch on which the query will be executed. Defaults to None.
@@ -277,8 +271,8 @@ Raises:
277271 GraphQLError: _ description_
278272
279273** Returns:**
280- - _ description_
281274
275+ - _ description_
282276
283277#### ` refresh_login ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1039" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
284278
@@ -349,6 +343,7 @@ allocate_next_ip_address(self, resource_pool: CoreNode, kind: type[SchemaType] |
349343Allocate a new IP address by using the provided resource pool.
350344
351345** Args:**
346+
352347- ` resource_pool ` : Node corresponding to the pool to allocate resources from.
353348- ` identifier ` : Value to perform idempotent allocation, the same resource will be returned for a given identifier.
354349- ` prefix_length ` : Length of the prefix to set on the address to allocate.
@@ -362,7 +357,6 @@ Allocate a new IP address by using the provided resource pool.
362357Returns:
363358 InfrahubNode: Node corresponding to the allocated resource.
364359
365-
366360#### ` allocate_next_ip_prefix ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1326" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
367361
368362``` python
@@ -408,6 +402,7 @@ allocate_next_ip_prefix(self, resource_pool: CoreNode, kind: type[SchemaType] |
408402Allocate a new IP prefix by using the provided resource pool.
409403
410404** Args:**
405+
411406- ` resource_pool ` : Node corresponding to the pool to allocate resources from.
412407- ` identifier ` : Value to perform idempotent allocation, the same resource will be returned for a given identifier.
413408- ` prefix_length ` : Length of the prefix to allocate.
@@ -422,7 +417,6 @@ Allocate a new IP prefix by using the provided resource pool.
422417Returns:
423418 InfrahubNode: Node corresponding to the allocated resource.
424419
425-
426420#### ` create_batch ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1474" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
427421
428422``` python
@@ -453,7 +447,6 @@ get_version(self) -> str
453447
454448Return the Infrahub version.
455449
456-
457450#### ` get_user ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1566" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
458451
459452``` python
@@ -462,7 +455,6 @@ get_user(self) -> dict
462455
463456Return user information
464457
465-
466458#### ` get_user_permissions ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1571" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
467459
468460``` python
@@ -471,7 +463,6 @@ get_user_permissions(self) -> dict
471463
472464Return user permissions
473465
474-
475466#### ` create ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1577" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
476467
477468``` python
@@ -504,7 +495,6 @@ clone(self, branch: str | None = None) -> InfrahubClientSync
504495
505496Return a cloned version of the client using the same configuration
506497
507-
508498#### ` execute_graphql ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1621" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
509499
510500``` python
@@ -515,6 +505,7 @@ Execute a GraphQL query (or mutation).
515505If retry_on_failure is True, the query will retry until the server becomes reacheable.
516506
517507** Args:**
508+
518509- ` query ` : GraphQL Query to execute, can be a query or a mutation
519510- ` variables ` : Variables to pass along with the GraphQL query. Defaults to None.
520511- ` branch_name ` : Name of the branch on which the query will be executed. Defaults to None.
@@ -526,8 +517,8 @@ Raises:
526517 GraphQLError: When an error occurs during the execution of the GraphQL query or mutation.
527518
528519** Returns:**
529- - The result of the GraphQL query or mutation.
530520
521+ - The result of the GraphQL query or mutation.
531522
532523#### ` count ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1703" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
533524
@@ -537,7 +528,6 @@ count(self, kind: str | type[SchemaType], at: Timestamp | None = None, branch: s
537528
538529Return the number of nodes of a given kind.
539530
540-
541531#### ` all ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1737" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
542532
543533``` python
@@ -559,6 +549,7 @@ all(self, kind: str | type[SchemaTypeSync], at: Timestamp | None = None, branch:
559549Retrieve all nodes of a given kind
560550
561551** Args:**
552+
562553- ` kind ` : kind of the nodes to query
563554- ` at ` : Time of the query. Defaults to Now.
564555- ` branch ` : Name of the branch to query from. Defaults to default_branch.
@@ -574,8 +565,8 @@ Retrieve all nodes of a given kind
574565- ` order ` : Ordering related options. Setting ` disable=True ` enhances performances.
575566
576567** Returns:**
577- - list\[ InfrahubNodeSync] : List of Nodes
578568
569+ - list\[ InfrahubNodeSync] : List of Nodes
579570
580571#### ` filters ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L1864" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
581572
@@ -598,6 +589,7 @@ filters(self, kind: str | type[SchemaTypeSync], at: Timestamp | None = None, bra
598589Retrieve nodes of a given kind based on provided filters.
599590
600591** Args:**
592+
601593- ` kind ` : kind of the nodes to query
602594- ` at ` : Time of the query. Defaults to Now.
603595- ` branch ` : Name of the branch to query from. Defaults to default_branch.
@@ -615,8 +607,8 @@ Retrieve nodes of a given kind based on provided filters.
615607- ` **kwargs ` : Additional filter criteria for the query.
616608
617609** Returns:**
618- - list\[ InfrahubNodeSync] : List of Nodes that match the given filters.
619610
611+ - list\[ InfrahubNodeSync] : List of Nodes that match the given filters.
620612
621613#### ` get ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L2040" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
622614
@@ -671,7 +663,6 @@ Create a batch to execute multiple queries concurrently.
671663Executing the batch will be performed using a thread pool, meaning it cannot guarantee the execution order. It is not recommended to use such
672664batch to manipulate objects that depend on each others.
673665
674-
675666#### ` get_list_repositories ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L2223" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
676667
677668``` python
@@ -735,6 +726,7 @@ allocate_next_ip_address(self, resource_pool: CoreNodeSync, kind: type[SchemaTyp
735726Allocate a new IP address by using the provided resource pool.
736727
737728** Args:**
729+
738730- ` resource_pool ` : Node corresponding to the pool to allocate resources from.
739731- ` identifier ` : Value to perform idempotent allocation, the same resource will be returned for a given identifier.
740732- ` prefix_length ` : Length of the prefix to set on the address to allocate.
@@ -748,7 +740,6 @@ Allocate a new IP address by using the provided resource pool.
748740Returns:
749741 InfrahubNodeSync: Node corresponding to the allocated resource.
750742
751-
752743#### ` allocate_next_ip_prefix ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L2460" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
753744
754745``` python
@@ -794,6 +785,7 @@ allocate_next_ip_prefix(self, resource_pool: CoreNodeSync, kind: type[SchemaType
794785Allocate a new IP prefix by using the provided resource pool.
795786
796787** Args:**
788+
797789- ` resource_pool ` : Node corresponding to the pool to allocate resources from.
798790- ` identifier ` : Value to perform idempotent allocation, the same resource will be returned for a given identifier.
799791- ` size ` : Length of the prefix to allocate.
@@ -808,7 +800,6 @@ Allocate a new IP prefix by using the provided resource pool.
808800Returns:
809801 InfrahubNodeSync: Node corresponding to the allocated resource.
810802
811-
812803#### ` repository_update_commit ` <sup ><a href = " https://github.com/opsmill/infrahub-sdk-python/blob/main/infrahub_sdk/client.py#L2608" target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
813804
814805``` python
0 commit comments