Skip to content

Commit 27abfff

Browse files
committed
fix getting_started
1 parent e147881 commit 27abfff

File tree

1 file changed

+75
-1
lines changed

1 file changed

+75
-1
lines changed

docs/getting_started.rst

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ Create, query, update, and delete some products
106106

107107
DataFrame API
108108
-------
109-
110109
Overview
111110
~~~~~~~~
112111

@@ -213,6 +212,81 @@ Get the metadata of a File using its Id and download it.
213212
:language: python
214213
:linenos:
215214

215+
Upload a File from disk or memory to SystemLink
216+
217+
.. literalinclude:: ../examples/file/upload_file.py
218+
219+
Feeds API
220+
-------
221+
222+
Overview
223+
~~~~~~~~
224+
225+
The :class:`.FeedsClient` class is the primary entry point of the Feeds API.
226+
227+
When constructing a :class:`.FeedsClient`, you can pass an
228+
:class:`.HttpConfiguration` (like one retrieved from the
229+
:class:`.HttpConfigurationManager`), or let :class:`.FeedsClient` use the
230+
default connection. The default connection depends on your environment.
231+
232+
With a :class:`.FeedsClient` object, you can:
233+
234+
* Get the list of feeds, create feed, upload package to feed and delete feed.
235+
236+
Examples
237+
~~~~~~~~
238+
239+
Create a new feed.
240+
241+
.. literalinclude:: ../examples/feeds/create_feed.py
242+
:language: python
243+
:linenos:
244+
245+
Query feeds and upload a package to feed.
246+
247+
.. literalinclude:: ../examples/feeds/query_and_upload_feeds.py
248+
:language: python
249+
:linenos:
250+
251+
Delete a feed.
252+
253+
.. literalinclude:: ../examples/feeds/delete_feed.py
254+
:language: python
255+
:linenos:
256+
257+
TestMonitor API (Results)
258+
-------
259+
260+
Overview
261+
~~~~~~~~
262+
263+
The :class:`.TestMonitorClient` class is the primary entry point of the Test Monitor API
264+
used to interact with test results (Results) and test steps (Steps).
265+
266+
When constructing a :class:`.TestMonitorClient`, you can pass an
267+
:class:`.HttpConfiguration` (like one retrieved from the
268+
:class:`.HttpConfigurationManager`), or let :class:`.TestMonitorClient` use the
269+
default connection. The default connection depends on your environment.
270+
271+
With a :class:`.TestMonitorClient` object, you can:
272+
273+
* Create, update, query, and delete results
274+
* Create, update, query, and delete steps
275+
276+
Examples
277+
~~~~~~~~
278+
279+
Create, query, update, and delete some results
280+
281+
.. literalinclude:: ../examples/testmonitor/results.py
282+
:language: python
283+
:linenos:
284+
285+
Create, update, query, and delete steps
286+
287+
.. literalinclude:: ../examples/testmonitor/steps.py
288+
:language: python
289+
:linenos
216290

217291
Notebook API
218292
-------

0 commit comments

Comments
 (0)