Skip to content

Commit

Permalink
Merge branch 'main' into DOCS-2421-autogen-enc-gant-grip
Browse files Browse the repository at this point in the history
  • Loading branch information
andf-viam authored Jun 17, 2024
2 parents 04f42a6 + a327d41 commit 90d5e0d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
11 changes: 6 additions & 5 deletions .github/workflows/update_sdk_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,12 @@
exit(1)
else:
sdks.append(sdk_lang)
print("\nIMPORTANT: You have indicated that you want to run against specific SDKs, instead of all.")
print(" This will ERASE any existing content for any SDKs which you have not specified.")
print(" This is suitable for the initial conversion to autogenerated content, but likely")
print(" not desireable once automation is in full swing. If you do not want this, you should")
print(" CANCEL this run, and re-run without specifying any SDKs, which will run against all.")
if not args.overrides:
print("\nIMPORTANT: You have indicated that you want to run against specific SDKs, instead of all.")
print(" This will ERASE any existing content for any SDKs which you have not specified.")
print(" This is suitable for the initial conversion to autogenerated content, but likely")
print(" not desireable once automation is in full swing. If you do not want this, you should")
print(" CANCEL this run, and re-run without specifying any SDKs, which will run against all.")
else:
sdks = sdks_supported

Expand Down
22 changes: 11 additions & 11 deletions static/include/app/apis/generated/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ Get a list of all the {{< glossary_tooltip term_id="part" text="parts" >}} under

**Returns:**

- ([List[RobotPart]](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The list of robot parts.
- ([List[RobotPart]](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The list of robot parts.

**Example:**

Expand Down Expand Up @@ -527,7 +527,7 @@ Get a specific machine {{< glossary_tooltip term_id="part" text="part" >}}.

**Returns:**

- ([RobotPart](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The robot part.
- ([RobotPart](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The robot part.

**Example:**

Expand Down Expand Up @@ -558,7 +558,7 @@ Get the logs associated with a specific machine {{< glossary_tooltip term_id="pa

**Returns:**

- ([List[LogEntry]](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): The list of log entries.
- ([List[LogEntry]](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): The list of log entries.

**Example:**

Expand Down Expand Up @@ -587,7 +587,7 @@ Get an asynchronous iterator that receives live machine part logs.

**Returns:**

- ([viam.app._logs._LogsStream[List[LogEntry]]](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): The asynchronous iterator receiving live robot part logs.
- ([viam.app._logs._LogsStream[List[LogEntry]]](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): The asynchronous iterator receiving live robot part logs.

**Example:**

Expand All @@ -614,7 +614,7 @@ Get a list containing the history of a machine {{< glossary_tooltip term_id="par

**Returns:**

- ([List[RobotPartHistoryEntry]](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPartHistoryEntry)): The list of the robot part’s history.
- ([List[RobotPartHistoryEntry]](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPartHistoryEntry)): The list of the robot part’s history.

**Example:**

Expand Down Expand Up @@ -643,7 +643,7 @@ Change the name of and assign an optional new configuration to a machine {{< glo

**Returns:**

- ([RobotPart](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The newly updated robot part.
- ([RobotPart](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The newly updated robot part.

**Example:**

Expand Down Expand Up @@ -779,7 +779,7 @@ Create a machine {{< glossary_tooltip term_id="part" text="part" >}} secret.

**Returns:**

- ([RobotPart](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The robot part the new secret was generated for.
- ([RobotPart](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): The robot part the new secret was generated for.

**Example:**

Expand Down Expand Up @@ -945,7 +945,7 @@ Get a list of {{< glossary_tooltip term_id="fragment" text="fragments" >}} in th

**Returns:**

- ([List[Fragment]](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The list of fragments.
- ([List[Fragment]](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The list of fragments.

**Example:**

Expand All @@ -971,7 +971,7 @@ Get a {{< glossary_tooltip term_id="fragment" text="fragment" >}} by ID.

**Returns:**

- ([Fragment](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The fragment.
- ([Fragment](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The fragment.

**Example:**

Expand Down Expand Up @@ -1002,7 +1002,7 @@ Create a new private {{< glossary_tooltip term_id="fragment" text="fragment" >}}

**Returns:**

- ([Fragment](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The newly created fragment.
- ([Fragment](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The newly created fragment.

**Example:**

Expand Down Expand Up @@ -1031,7 +1031,7 @@ Update a {{< glossary_tooltip term_id="fragment" text="fragment" >}} name and it

**Returns:**

- ([Fragment](http://localhost:9001/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The newly updated fragment.
- ([Fragment](http://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): The newly updated fragment.

**Example:**

Expand Down

0 comments on commit 90d5e0d

Please sign in to comment.