Skip to content

Commit 2c10bc2

Browse files
committed
Regenerate SDK reference docs after docstring URL fix
1 parent e6ca9f4 commit 2c10bc2

8 files changed

Lines changed: 208 additions & 208 deletions

File tree

docs/docs/python-sdk/sdk_ref/infrahub_sdk/client.mdx

Lines changed: 110 additions & 110 deletions
Large diffs are not rendered by default.

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/attribute.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ sidebarTitle: attribute
77

88
## Classes
99

10-
### `Attribute`
10+
### `Attribute` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/attribute.py#L43" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
Represents an attribute of a Node, including its schema, value, and properties.
1313

1414
**Methods:**
1515

16-
#### `value`
16+
#### `value` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/attribute.py#L102" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1717

1818
```python
1919
value(self) -> Any
2020
```
2121

22-
#### `value`
22+
#### `value` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/attribute.py#L106" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2323

2424
```python
2525
value(self, value: Any) -> None
2626
```
2727

28-
#### `is_from_pool_attribute`
28+
#### `is_from_pool_attribute` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/attribute.py#L184" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2929

3030
```python
3131
is_from_pool_attribute(self) -> bool

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/metadata.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ sidebarTitle: metadata
77

88
## Classes
99

10-
### `NodeMetadata`
10+
### `NodeMetadata` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/metadata.py#L6" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
Represents metadata about a node (created_at, created_by, updated_at, updated_by).
1313

14-
### `RelationshipMetadata`
14+
### `RelationshipMetadata` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/metadata.py#L44" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1515

1616
Represents metadata about a relationship edge (updated_at, updated_by).

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/node.mdx

Lines changed: 55 additions & 55 deletions
Large diffs are not rendered by default.

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/parsers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebarTitle: parsers
77

88
## Functions
99

10-
### `parse_human_friendly_id`
10+
### `parse_human_friendly_id` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/parsers.py#L6" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
```python
1313
parse_human_friendly_id(hfid: str | list[str]) -> tuple[str | None, list[str]]

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/property.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ sidebarTitle: property
77

88
## Classes
99

10-
### `NodeProperty`
10+
### `NodeProperty` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/property.py#L4" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
Represents a property of a node, typically used for metadata like display labels.

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/related_node.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,119 +7,119 @@ sidebarTitle: related_node
77

88
## Classes
99

10-
### `RelatedNodeBase`
10+
### `RelatedNodeBase` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L17" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
Base class for representing a related node in a relationship.
1313

1414
**Methods:**
1515

16-
#### `id`
16+
#### `id` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L92" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1717

1818
```python
1919
id(self) -> str | None
2020
```
2121

22-
#### `hfid`
22+
#### `hfid` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L98" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2323

2424
```python
2525
hfid(self) -> list[Any] | None
2626
```
2727

28-
#### `hfid_str`
28+
#### `hfid_str` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L104" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2929

3030
```python
3131
hfid_str(self) -> str | None
3232
```
3333

34-
#### `is_resource_pool`
34+
#### `is_resource_pool` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3535

3636
```python
3737
is_resource_pool(self) -> bool
3838
```
3939

40-
#### `initialized`
40+
#### `initialized` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L116" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4141

4242
```python
4343
initialized(self) -> bool
4444
```
4545

46-
#### `display_label`
46+
#### `display_label` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L120" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4747

4848
```python
4949
display_label(self) -> str | None
5050
```
5151

52-
#### `typename`
52+
#### `typename` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5353

5454
```python
5555
typename(self) -> str | None
5656
```
5757

58-
#### `kind`
58+
#### `kind` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L132" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5959

6060
```python
6161
kind(self) -> str | None
6262
```
6363

64-
#### `is_from_profile`
64+
#### `is_from_profile` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L138" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6565

6666
```python
6767
is_from_profile(self) -> bool
6868
```
6969

7070
Return whether this relationship was set from a profile. Done by checking if the source is of a profile kind.
7171

72-
#### `get_relationship_metadata`
72+
#### `get_relationship_metadata` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L144" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7373

7474
```python
7575
get_relationship_metadata(self) -> RelationshipMetadata | None
7676
```
7777

7878
Returns the relationship metadata (updated_at, updated_by) if fetched.
7979

80-
### `RelatedNode`
80+
### `RelatedNode` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L213" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8181

8282
Represents a RelatedNodeBase in an asynchronous context.
8383

8484
**Methods:**
8585

86-
#### `fetch`
86+
#### `fetch` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L235" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8787

8888
```python
8989
fetch(self, timeout: int | None = None) -> None
9090
```
9191

92-
#### `peer`
92+
#### `peer` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L244" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9393

9494
```python
9595
peer(self) -> InfrahubNode
9696
```
9797

98-
#### `get`
98+
#### `get` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L247" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9999

100100
```python
101101
get(self) -> InfrahubNode
102102
```
103103

104-
### `RelatedNodeSync`
104+
### `RelatedNodeSync` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L260" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
105105

106106
Represents a related node in a synchronous context.
107107

108108
**Methods:**
109109

110-
#### `fetch`
110+
#### `fetch` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L282" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
111111

112112
```python
113113
fetch(self, timeout: int | None = None) -> None
114114
```
115115

116-
#### `peer`
116+
#### `peer` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L291" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
117117

118118
```python
119119
peer(self) -> InfrahubNodeSync
120120
```
121121

122-
#### `get`
122+
#### `get` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/related_node.py#L294" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
123123

124124
```python
125125
get(self) -> InfrahubNodeSync

docs/docs/python-sdk/sdk_ref/infrahub_sdk/node/relationship.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,107 +7,107 @@ sidebarTitle: relationship
77

88
## Classes
99

10-
### `RelationshipManagerBase`
10+
### `RelationshipManagerBase` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
Base class for RelationshipManager and RelationshipManagerSync
1313

1414
**Methods:**
1515

16-
#### `peer_ids`
16+
#### `peer_ids` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L45" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1717

1818
```python
1919
peer_ids(self) -> list[str]
2020
```
2121

22-
#### `peer_hfids`
22+
#### `peer_hfids` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L49" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2323

2424
```python
2525
peer_hfids(self) -> list[list[Any]]
2626
```
2727

28-
#### `peer_hfids_str`
28+
#### `peer_hfids_str` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L53" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2929

3030
```python
3131
peer_hfids_str(self) -> list[str]
3232
```
3333

34-
#### `has_update`
34+
#### `has_update` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L57" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3535

3636
```python
3737
has_update(self) -> bool
3838
```
3939

40-
#### `is_from_profile`
40+
#### `is_from_profile` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L61" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4141

4242
```python
4343
is_from_profile(self) -> bool
4444
```
4545

4646
Return whether this relationship was set from a profile. All its peers must be from a profile.
4747

48-
### `RelationshipManager`
48+
### `RelationshipManager` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L115" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4949

5050
Manages relationships of a node in an asynchronous context.
5151

5252
**Methods:**
5353

54-
#### `fetch`
54+
#### `fetch` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L163" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5555

5656
```python
5757
fetch(self) -> None
5858
```
5959

60-
#### `add`
60+
#### `add` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L199" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6161

6262
```python
6363
add(self, data: str | RelatedNode | dict) -> None
6464
```
6565

6666
Add a new peer to this relationship.
6767

68-
#### `extend`
68+
#### `extend` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L211" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6969

7070
```python
7171
extend(self, data: Iterable[str | RelatedNode | dict]) -> None
7272
```
7373

7474
Add new peers to this relationship.
7575

76-
#### `remove`
76+
#### `remove` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L216" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7777

7878
```python
7979
remove(self, data: str | RelatedNode | dict) -> None
8080
```
8181

82-
### `RelationshipManagerSync`
82+
### `RelationshipManagerSync` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L238" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8383

8484
Manages relationships of a node in a synchronous context.
8585

8686
**Methods:**
8787

88-
#### `fetch`
88+
#### `fetch` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L286" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8989

9090
```python
9191
fetch(self) -> None
9292
```
9393

94-
#### `add`
94+
#### `add` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L322" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9595

9696
```python
9797
add(self, data: str | RelatedNodeSync | dict) -> None
9898
```
9999

100100
Add a new peer to this relationship.
101101

102-
#### `extend`
102+
#### `extend` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L334" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
103103

104104
```python
105105
extend(self, data: Iterable[str | RelatedNodeSync | dict]) -> None
106106
```
107107

108108
Add new peers to this relationship.
109109

110-
#### `remove`
110+
#### `remove` <sup><a href="https://github.com/opsmill/infrahub-sdk-python/blob/main/src/infrahub-sdk-python/infrahub_sdk/node/relationship.py#L339" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
111111

112112
```python
113113
remove(self, data: str | RelatedNodeSync | dict) -> None

0 commit comments

Comments
 (0)