Skip to content

Commit e5178dd

Browse files
fern-api[bot]fern-api[bot]
committed
SDK regeneration
1 parent 643f836 commit e5178dd

File tree

4 files changed

+682
-4
lines changed

4 files changed

+682
-4
lines changed

‎.mock/definition/comments.yml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,93 @@ service:
7777
resolved_at: '2024-01-15T09:30:00Z'
7878
audiences:
7979
- public
80+
get:
81+
path: /api/comments/{id}
82+
method: GET
83+
auth: true
84+
docs: |
85+
86+
Get a specific comment.
87+
path-parameters:
88+
id:
89+
type: integer
90+
docs: Comment ID
91+
display-name: Get comment
92+
response:
93+
docs: ''
94+
type: root.Comment
95+
examples:
96+
- path-parameters:
97+
id: 1
98+
response:
99+
body:
100+
id: 1
101+
text: text
102+
project: 1
103+
task: 1
104+
annotation: 1
105+
created_by: 1
106+
created_at: '2024-01-15T09:30:00Z'
107+
updated_at: '2024-01-15T09:30:00Z'
108+
is_resolved: true
109+
resolved_at: '2024-01-15T09:30:00Z'
110+
audiences:
111+
- public
112+
delete:
113+
path: /api/comments/{id}
114+
method: DELETE
115+
auth: true
116+
docs: |
117+
118+
Delete a specific comment.
119+
path-parameters:
120+
id:
121+
type: integer
122+
docs: Comment ID
123+
display-name: Delete comment
124+
examples:
125+
- path-parameters:
126+
id: 1
127+
audiences:
128+
- public
129+
update:
130+
path: /api/comments/{id}
131+
method: PATCH
132+
auth: true
133+
docs: |
134+
135+
Update a specific comment.
136+
path-parameters:
137+
id:
138+
type: integer
139+
docs: Comment ID
140+
display-name: Update comment
141+
request:
142+
name: CommentsUpdateRequest
143+
body:
144+
properties:
145+
annotation: optional<integer>
146+
project: optional<integer>
147+
text: optional<string>
148+
is_resolved: optional<boolean>
149+
response:
150+
docs: ''
151+
type: root.Comment
152+
examples:
153+
- path-parameters:
154+
id: 1
155+
request: {}
156+
response:
157+
body:
158+
id: 1
159+
text: text
160+
project: 1
161+
task: 1
162+
annotation: 1
163+
created_by: 1
164+
created_at: '2024-01-15T09:30:00Z'
165+
updated_at: '2024-01-15T09:30:00Z'
166+
is_resolved: true
167+
resolved_at: '2024-01-15T09:30:00Z'
168+
audiences:
169+
- public

‎reference.md

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13800,6 +13800,248 @@ client.comments.create()
1380013800
</dl>
1380113801

1380213802

13803+
</dd>
13804+
</dl>
13805+
</details>
13806+
13807+
<details><summary><code>client.comments.<a href="src/label_studio_sdk/comments/client.py">get</a>(...)</code></summary>
13808+
<dl>
13809+
<dd>
13810+
13811+
#### 📝 Description
13812+
13813+
<dl>
13814+
<dd>
13815+
13816+
<dl>
13817+
<dd>
13818+
13819+
Get a specific comment.
13820+
</dd>
13821+
</dl>
13822+
</dd>
13823+
</dl>
13824+
13825+
#### 🔌 Usage
13826+
13827+
<dl>
13828+
<dd>
13829+
13830+
<dl>
13831+
<dd>
13832+
13833+
```python
13834+
from label_studio_sdk.client import LabelStudio
13835+
13836+
client = LabelStudio(
13837+
api_key="YOUR_API_KEY",
13838+
)
13839+
client.comments.get(
13840+
id=1,
13841+
)
13842+
13843+
```
13844+
</dd>
13845+
</dl>
13846+
</dd>
13847+
</dl>
13848+
13849+
#### ⚙️ Parameters
13850+
13851+
<dl>
13852+
<dd>
13853+
13854+
<dl>
13855+
<dd>
13856+
13857+
**id:** `int` — Comment ID
13858+
13859+
</dd>
13860+
</dl>
13861+
13862+
<dl>
13863+
<dd>
13864+
13865+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
13866+
13867+
</dd>
13868+
</dl>
13869+
</dd>
13870+
</dl>
13871+
13872+
13873+
</dd>
13874+
</dl>
13875+
</details>
13876+
13877+
<details><summary><code>client.comments.<a href="src/label_studio_sdk/comments/client.py">delete</a>(...)</code></summary>
13878+
<dl>
13879+
<dd>
13880+
13881+
#### 📝 Description
13882+
13883+
<dl>
13884+
<dd>
13885+
13886+
<dl>
13887+
<dd>
13888+
13889+
Delete a specific comment.
13890+
</dd>
13891+
</dl>
13892+
</dd>
13893+
</dl>
13894+
13895+
#### 🔌 Usage
13896+
13897+
<dl>
13898+
<dd>
13899+
13900+
<dl>
13901+
<dd>
13902+
13903+
```python
13904+
from label_studio_sdk.client import LabelStudio
13905+
13906+
client = LabelStudio(
13907+
api_key="YOUR_API_KEY",
13908+
)
13909+
client.comments.delete(
13910+
id=1,
13911+
)
13912+
13913+
```
13914+
</dd>
13915+
</dl>
13916+
</dd>
13917+
</dl>
13918+
13919+
#### ⚙️ Parameters
13920+
13921+
<dl>
13922+
<dd>
13923+
13924+
<dl>
13925+
<dd>
13926+
13927+
**id:** `int` — Comment ID
13928+
13929+
</dd>
13930+
</dl>
13931+
13932+
<dl>
13933+
<dd>
13934+
13935+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
13936+
13937+
</dd>
13938+
</dl>
13939+
</dd>
13940+
</dl>
13941+
13942+
13943+
</dd>
13944+
</dl>
13945+
</details>
13946+
13947+
<details><summary><code>client.comments.<a href="src/label_studio_sdk/comments/client.py">update</a>(...)</code></summary>
13948+
<dl>
13949+
<dd>
13950+
13951+
#### 📝 Description
13952+
13953+
<dl>
13954+
<dd>
13955+
13956+
<dl>
13957+
<dd>
13958+
13959+
Update a specific comment.
13960+
</dd>
13961+
</dl>
13962+
</dd>
13963+
</dl>
13964+
13965+
#### 🔌 Usage
13966+
13967+
<dl>
13968+
<dd>
13969+
13970+
<dl>
13971+
<dd>
13972+
13973+
```python
13974+
from label_studio_sdk.client import LabelStudio
13975+
13976+
client = LabelStudio(
13977+
api_key="YOUR_API_KEY",
13978+
)
13979+
client.comments.update(
13980+
id=1,
13981+
)
13982+
13983+
```
13984+
</dd>
13985+
</dl>
13986+
</dd>
13987+
</dl>
13988+
13989+
#### ⚙️ Parameters
13990+
13991+
<dl>
13992+
<dd>
13993+
13994+
<dl>
13995+
<dd>
13996+
13997+
**id:** `int` — Comment ID
13998+
13999+
</dd>
14000+
</dl>
14001+
14002+
<dl>
14003+
<dd>
14004+
14005+
**annotation:** `typing.Optional[int]`
14006+
14007+
</dd>
14008+
</dl>
14009+
14010+
<dl>
14011+
<dd>
14012+
14013+
**project:** `typing.Optional[int]`
14014+
14015+
</dd>
14016+
</dl>
14017+
14018+
<dl>
14019+
<dd>
14020+
14021+
**text:** `typing.Optional[str]`
14022+
14023+
</dd>
14024+
</dl>
14025+
14026+
<dl>
14027+
<dd>
14028+
14029+
**is_resolved:** `typing.Optional[bool]`
14030+
14031+
</dd>
14032+
</dl>
14033+
14034+
<dl>
14035+
<dd>
14036+
14037+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
14038+
14039+
</dd>
14040+
</dl>
14041+
</dd>
14042+
</dl>
14043+
14044+
1380314045
</dd>
1380414046
</dl>
1380514047
</details>

0 commit comments

Comments
 (0)