From e3555a2f8cdb2270724dd73f0155a9b2b77e9798 Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 13 Jul 2026 10:18:54 -0600 Subject: [PATCH 1/2] Document registry deprecation, machine summaries, and dataset image upload methods Documents seven released fleet/data methods flagged by the SDK method coverage job: - DeprecateRegistryItem / UndeprecateRegistryItem and their Version variants (Python + TypeScript), joining the already-documented registry item CRUD methods. - ListMachineSummaries (Go): fleet-wide machine summary listing. - GetRobotPartByNameAndLocation (Go): fills the missing Go method on the already-documented proto row. - UploadImageToDatasets (Go) on the data manager service, alongside the existing UploadBinaryDataToDatasets. Adds CSV rows/columns, proto description overrides (rewording the two pre-staged override files to imperative table style), and regenerates the fleet and data manager markdown. Refs #5142. --- .github/workflows/sdk_protos_map.csv | 8 +- .../include/app/apis/generated/app-table.md | 7 +- static/include/app/apis/generated/app.md | 718 +++++++++++------- .../protos/app.DeprecateRegistryItem.md | 1 + .../app.DeprecateRegistryItemVersion.md | 1 + .../protos/app.ListMachineSummaries.md | 2 +- .../protos/app.UndeprecateRegistryItem.md | 1 + .../app.UndeprecateRegistryItemVersion.md | 1 + .../apis/generated/data_manager-table.md | 1 + .../services/apis/generated/data_manager.md | 25 + .../data_manager.UploadImageToDatasets.md | 2 +- 11 files changed, 474 insertions(+), 293 deletions(-) create mode 100644 static/include/app/apis/overrides/protos/app.DeprecateRegistryItem.md create mode 100644 static/include/app/apis/overrides/protos/app.DeprecateRegistryItemVersion.md create mode 100644 static/include/app/apis/overrides/protos/app.UndeprecateRegistryItem.md create mode 100644 static/include/app/apis/overrides/protos/app.UndeprecateRegistryItemVersion.md diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index 1901f20597..77df7c4b17 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -276,6 +276,7 @@ base_remote_control,Close,,,Close,, ## Data Manager data_manager,Sync,No,,Sync,,sync data_manager,UploadBinaryDataToDatasets,No,,UploadBinaryDataToDatasets,,uploadBinaryDataToDatasets +data_manager,UploadImageToDatasets,No,,UploadImageToDatasets,, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: data_manager,Reconfigure,No,,Reconfigure,, data_manager,DoCommand,No,,DoCommand,,doCommand @@ -397,7 +398,7 @@ app,GetRoverRentalRobots,,,,, app,GetRobotParts,,get_robot_parts,GetRobotParts,,getRobotParts app,GetRobotPart,,get_robot_part,GetRobotPart,,getRobotPart app,GetRobotPartLogs,,get_robot_part_logs,GetRobotPartLogs,,getRobotPartLogs -app,GetRobotPartByNameAndLocation,,,,,getRobotPartByNameAndLocation +app,GetRobotPartByNameAndLocation,,,GetRobotPartByNameAndLocation,,getRobotPartByNameAndLocation app,TailRobotPartLogs,,tail_robot_part_logs,TailRobotPartLogs,,tailRobotPartLogs app,GetRobotPartHistory,,get_robot_part_history,GetRobotPartHistory,,getRobotPartHistory app,UpdateRobotPart,,update_robot_part,UpdateRobotPart,,updateRobotPart @@ -408,6 +409,7 @@ app,MarkPartForRestart,,mark_part_for_restart,MarkPartForRestart,,markPartForRes app,CreateRobotPartSecret,,create_robot_part_secret,CreateRobotPartSecret,,createRobotPartSecret app,DeleteRobotPartSecret,,delete_robot_part_secret,DeleteRobotPartSecret,,deleteRobotPartSecret app,ListRobots,,list_robots,ListRobots,,listRobots +app,ListMachineSummaries,,,ListMachineSummaries,, app,NewRobot,,new_robot,NewRobot,,newRobot app,UpdateRobot,,update_robot,UpdateRobot,,updateRobot app,DeleteRobot,,delete_robot,DeleteRobot,,deleteRobot @@ -433,6 +435,10 @@ app,CreateRegistryItem,,create_registry_item,CreateRegistryItem,,createRegistryI app,UpdateRegistryItem,,update_registry_item,UpdateRegistryItem,,updateRegistryItem app,ListRegistryItems,,list_registry_items,ListRegistryItems,,listRegistryItems app,DeleteRegistryItem,,delete_registry_item,DeleteRegistryItem,,deleteRegistryItem +app,DeprecateRegistryItem,,deprecate_registry_item,,,deprecateRegistryItem +app,UndeprecateRegistryItem,,undeprecate_registry_item,,,undeprecateRegistryItem +app,DeprecateRegistryItemVersion,,deprecate_registry_item_version,,,deprecateRegistryItemVersion +app,UndeprecateRegistryItemVersion,,undeprecate_registry_item_version,,,undeprecateRegistryItemVersion app,CreateModule,,create_module,CreateModule,,createModule app,UpdateModule,,update_module,UpdateModule,,updateModule app,UploadModuleFile,,upload_module_file,UploadModuleFile,, diff --git a/static/include/app/apis/generated/app-table.md b/static/include/app/apis/generated/app-table.md index cdae6cc721..1ee76ec822 100644 --- a/static/include/app/apis/generated/app-table.md +++ b/static/include/app/apis/generated/app-table.md @@ -46,6 +46,7 @@ | [`CreateRobotPartSecret`](/reference/apis/fleet/#createrobotpartsecret) | Create a machine {{< glossary_tooltip term_id="part" text="part" >}} secret. | | [`DeleteRobotPartSecret`](/reference/apis/fleet/#deleterobotpartsecret) | Delete a machine part secret. | | [`ListRobots`](/reference/apis/fleet/#listrobots) | Get a list of all machines in a specified location. | +| [`ListMachineSummaries`](/reference/apis/fleet/#listmachinesummaries) | List summary information for the machines in an organization, optionally filtered by fragment or location. | | [`NewRobot`](/reference/apis/fleet/#newrobot) | Create a new {{< glossary_tooltip term_id="machine" text="machine" >}}. | | [`UpdateRobot`](/reference/apis/fleet/#updaterobot) | Update an existing machine's name and/or location. | | [`DeleteRobot`](/reference/apis/fleet/#deleterobot) | Delete a specified machine. | @@ -55,7 +56,7 @@ | [`UpdateRobotPartMetadata`](/reference/apis/fleet/#updaterobotpartmetadata) | Updates the user-defined metadata for a machine part. | | [`ListFragments`](/reference/apis/fleet/#listfragments) | Get a list of {{< glossary_tooltip term_id="fragment" text="fragments" >}} in the organization you are currently authenticated to. | | [`ListMachineFragments`](/reference/apis/fleet/#listmachinefragments) | Get a list of top level and nested {{< glossary_tooltip term_id="fragment" text="fragments" >}} for a machine, as well as additionally specified fragment IDs. | -| [`ListMachineSummaries`](/reference/apis/fleet/#listmachinesummaries) | Lists machine summaries for an organization, optionally filtered by fragment IDs, location IDs, and limit. | +| [`ListMachineSummaries`](/reference/apis/fleet/#listmachinesummaries) | List summary information for the machines in an organization, optionally filtered by fragment or location. | | [`GetFragment`](/reference/apis/fleet/#getfragment) | Get a {{< glossary_tooltip term_id="fragment" text="fragment" >}} by ID. | | [`CreateFragment`](/reference/apis/fleet/#createfragment) | Create a new private {{< glossary_tooltip term_id="fragment" text="fragment" >}}. | | [`UpdateFragment`](/reference/apis/fleet/#updatefragment) | Update a {{< glossary_tooltip term_id="fragment" text="fragment" >}} name and its config and/or visibility. | @@ -71,6 +72,10 @@ | [`UpdateRegistryItem`](/reference/apis/fleet/#updateregistryitem) | Update a registry item. | | [`ListRegistryItems`](/reference/apis/fleet/#listregistryitems) | List the registry items in an organization. | | [`DeleteRegistryItem`](/reference/apis/fleet/#deleteregistryitem) | Delete a registry item. | +| [`DeprecateRegistryItem`](/reference/apis/fleet/#deprecateregistryitem) | Mark a registry item, such as a module or training script, as deprecated. | +| [`UndeprecateRegistryItem`](/reference/apis/fleet/#undeprecateregistryitem) | Remove the deprecated status from a registry item. | +| [`DeprecateRegistryItemVersion`](/reference/apis/fleet/#deprecateregistryitemversion) | Mark a specific version of a registry item as deprecated. | +| [`UndeprecateRegistryItemVersion`](/reference/apis/fleet/#undeprecateregistryitemversion) | Remove the deprecated status from a specific version of a registry item. | | [`CreateModule`](/reference/apis/fleet/#createmodule) | Create a {{< glossary_tooltip term_id="module" text="module" >}} under the organization you are currently authenticated to. | | [`UpdateModule`](/reference/apis/fleet/#updatemodule) | Update the documentation URL, description, models, entrypoint, and/or the visibility of a {{< glossary_tooltip term_id="module" text="module" >}}. | | [`UploadModuleFile`](/reference/apis/fleet/#uploadmodulefile) | Upload a {{< glossary_tooltip term_id="module" text="module" >}} file. | diff --git a/static/include/app/apis/generated/app.md b/static/include/app/apis/generated/app.md index 2b92998d03..26b23d3c9b 100644 --- a/static/include/app/apis/generated/app.md +++ b/static/include/app/apis/generated/app.md @@ -57,9 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a ```ts {class="line-numbers linkable-line-numbers"} // This method is used internally only. To obtain a user's ID, use the listOrganizationsByUser method. -const members = await appClient.listOrganizationMembers( - '' -); +const members = await appClient.listOrganizationMembers(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getuseridbyemail). @@ -120,7 +118,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The new organization. +- (Promise<[Organization](https://ts.viam.dev/classes/appApi.Organization.html) | undefined>): The new organization. For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createorganization). @@ -140,7 +138,7 @@ List the {{< glossary_tooltip term_id="organization" text="organizations" >}} th **Returns:** -- ([List[viam.proto.app.Organization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Organization)): : The list of organizations. +- ([list[viam.proto.app.Organization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Organization)): : The list of organizations. **Example:** @@ -205,7 +203,7 @@ Get all organizations that have access to a location. **Returns:** -- ([List[viam.proto.app.OrganizationIdentity]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationIdentity)): : The list of organizations. +- ([list[viam.proto.app.OrganizationIdentity]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationIdentity)): : The list of organizations. **Example:** @@ -230,9 +228,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ ```ts {class="line-numbers linkable-line-numbers"} const organizations = - await appClient.getOrganizationsWithAccessToLocation( - '' - ); + await appClient.getOrganizationsWithAccessToLocation(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getorganizationswithaccesstolocation). @@ -253,7 +249,7 @@ List the organizations a user belongs to. **Returns:** -- ([List[viam.proto.app.OrgDetails]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrgDetails)): : The list of organizations. +- ([list[viam.proto.app.OrgDetails]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrgDetails)): : The list of organizations. **Example:** @@ -357,14 +353,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): Details about the organization, if it exists. +- (Promise<[Organization](https://ts.viam.dev/classes/appApi.Organization.html) | undefined>): Details about the organization, if it exists. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const organization = await appClient.getOrganization( - '' -); +const organization = await appClient.getOrganization(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getorganization). @@ -435,8 +429,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const isAvailable = - await appClient.getOrganizationNamespaceAvailability('name'); +const isAvailable = await appClient.getOrganizationNamespaceAvailability('name'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getorganizationnamespaceavailability). @@ -458,7 +451,7 @@ Updates organization details. - `public_namespace` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): If provided, sets the org’s namespace if it hasn’t already been set. - `region` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): If provided, updates the org’s region. - `cid` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): If provided, update’s the org’s CRM ID. -- `default_fragments` ([List[viam.proto.app.FragmentImport]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.FragmentImport)) (optional) +- `default_fragments` ([list[viam.proto.app.FragmentImport]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.FragmentImport)) (optional) **Returns:** @@ -518,19 +511,18 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `publicNamespace` (string) (optional): Optional namespace to update the organization with. - `region` (string) (optional): Optional region to update the organization with. - `cid` (string) (optional): Optional CRM ID to update the organization with. -- `defaultFragments` ([FragmentImportList](https://ts.viam.dev/classes/appApi.FragmentImportList.html)) (optional): Optional default fragments to set for the - organization. +- `defaultFragments` ([FragmentImportList](https://ts.viam.dev/classes/appApi.FragmentImportList.html)) (optional): Optional default fragments to set for the organization. **Returns:** -- (Promise): The updated organization details. +- (Promise<[Organization](https://ts.viam.dev/classes/appApi.Organization.html) | undefined>): The updated organization details. **Example:** ```ts {class="line-numbers linkable-line-numbers"} const organization = await appClient.updateOrganization( '', - 'newName' + 'newName', ); ``` @@ -616,7 +608,7 @@ List the members and invites of the {{< glossary_tooltip term_id="organization" **Returns:** -- (Tuple[List[[app.OrganizationMember](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationMember)], List[[app.OrganizationInvite](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationInvite)]]): : A tuple containing two lists; the first +- (tuple[list[[app.OrganizationMember](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationMember)], list[[app.OrganizationInvite](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.OrganizationInvite)]]): : A tuple containing two lists; the first [0] of organization members, and the second [1] of organization invites. **Example:** @@ -658,15 +650,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise<[ListOrganizationMembersResponse](https://ts.viam.dev/classes/appApi.ListOrganizationMembersResponse.html)>): An object containing organization members, pending invites, and -org ID. +- (Promise<[ListOrganizationMembersResponse](https://ts.viam.dev/classes/appApi.ListOrganizationMembersResponse.html)>): An object containing organization members, pending invites, and org ID. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const members = await appClient.listOrganizationMembers( - '' -); +const members = await appClient.listOrganizationMembers(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#listorganizationmembers). @@ -685,7 +674,7 @@ Create an {{< glossary_tooltip term_id="organization" text="organization" >}} in - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to create an invite for. You can obtain your organization ID from the organization settings page. - `email` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The email address to send the invite to. -- `authorizations` ([List[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Specifications of the authorizations to include in the invite. If not provided, full owner permissions will be granted. +- `authorizations` ([list[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Specifications of the authorizations to include in the invite. If not provided, full owner permissions will be granted. - `send_email_invite` ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)) (required): Whether or not an email should be sent to the recipient of an invite. The user must accept the email to be added to the associated authorizations. When set to false, the user automatically receives the associated authorization on the next login of the user with the associated email address. **Returns:** @@ -747,12 +736,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `organizationId` (string) (required): The id of the organization to create the invite for. - `email` (string) (required): The email address of the user to generate an invite for. - `authorizations` ([Authorization](https://ts.viam.dev/classes/appApi.Authorization.html)) (required): The authorizations to associate with the new invite. -- `sendEmailInvite` (boolean) (optional): Bool of whether to send an email invite (true) or - automatically add a user. Defaults to true. +- `sendEmailInvite` (boolean) (optional): Bool of whether to send an email invite (true) or automatically add a + user. Defaults to true. **Returns:** -- (Promise): The organization invite. +- (Promise<[OrganizationInvite](https://ts.viam.dev/classes/appApi.OrganizationInvite.html) | undefined>): The organization invite. **Example:** @@ -771,7 +760,7 @@ const auth = new VIAM.appApi.Authorization({ const invite = await appClient.createOrganizationInvite( '', 'youremail@email.com', - [auth] + [auth], ); ``` @@ -792,8 +781,8 @@ If an invitation has only one authorization and you want to remove it, delete th - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization that the invite is for. You can obtain your organization ID from the organization settings page. - `email` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Email of the user the invite was sent to. -- `add_authorizations` ([List[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Optional list of authorizations to add to the invite. -- `remove_authorizations` ([List[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Optional list of authorizations to remove from the invite. +- `add_authorizations` ([list[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Optional list of authorizations to add to the invite. +- `remove_authorizations` ([list[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (optional): Optional list of authorizations to remove from the invite. **Returns:** @@ -875,7 +864,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The organization invite. +- (Promise<[OrganizationInvite](https://ts.viam.dev/classes/appApi.OrganizationInvite.html) | undefined>): The organization invite. **Example:** @@ -894,7 +883,7 @@ const invite = await appClient.updateOrganizationInviteAuthorizations( '', 'youremail@email.com', [auth], - [] + [], ); ``` @@ -969,10 +958,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.deleteOrganizationMember( - '', - '' -); +await appClient.deleteOrganizationMember('', ''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deleteorganizationmember). @@ -1047,10 +1033,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.deleteOrganizationInvite( - '', - 'youremail@email.com' -); +await appClient.deleteOrganizationInvite('', 'youremail@email.com'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deleteorganizationinvite). @@ -1118,14 +1101,14 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The invite. +- (Promise<[OrganizationInvite](https://ts.viam.dev/classes/appApi.OrganizationInvite.html) | undefined>): The invite. **Example:** ```ts {class="line-numbers linkable-line-numbers"} const invite = await appClient.resendOrganizationInvite( '', - 'youremail@email.com' + 'youremail@email.com', ); ``` @@ -1147,7 +1130,7 @@ Gets the user-defined metadata for an organization. **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. **Example:** @@ -1194,9 +1177,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const metadata = await appClient.getOrganizationMetadata( - '' -); +const metadata = await appClient.getOrganizationMetadata(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getorganizationmetadata). @@ -1215,7 +1196,7 @@ User-defined metadata is billed as data. **Parameters:** - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required) -- `metadata` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata to upload as a Python dictionary. +- `metadata` (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata to upload as a Python dictionary. **Returns:** @@ -1348,23 +1329,18 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** -- `organizationId` (string) (required): The ID of the organization to create the location - under. +- `organizationId` (string) (required): The ID of the organization to create the location under. - `name` (string) (required): The name of the location to create. -- `parentLocationId` (string) (optional): Optional name of a parent location to create the - new location under. +- `parentLocationId` (string) (optional): Optional name of a parent location to create the new location under. **Returns:** -- (Promise): The location object. +- (Promise<[Location](https://ts.viam.dev/classes/appApi.Location.html) | undefined>): The location object. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const location = await appClient.createLocation( - '', - 'name' -); +const location = await appClient.createLocation('', 'name'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createlocation). @@ -1429,7 +1405,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The location object. +- (Promise<[Location](https://ts.viam.dev/classes/appApi.Location.html) | undefined>): The location object. **Example:** @@ -1527,21 +1503,17 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `locId` (string) (required): The ID of the location to update. - `name` (string) (optional): Optional string to update the location's name to. -- `parentLocId` (string) (optional): Optional string to update the location's parent location - to. +- `parentLocId` (string) (optional): Optional string to update the location's parent location to. - `region` (string) (optional): Optional string to update the location's region to. **Returns:** -- (Promise): The location object. +- (Promise<[Location](https://ts.viam.dev/classes/appApi.Location.html) | undefined>): The location object. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const location = await appClient.updateLocation( - '', - 'newName' -); +const location = await appClient.updateLocation('', 'newName'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#updatelocation). @@ -1631,7 +1603,7 @@ Get a list of all {{< glossary_tooltip term_id="location" text="locations" >}} u **Returns:** -- ([List[viam.proto.app.Location]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Location)): : The list of locations. +- ([list[viam.proto.app.Location]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Location)): : The list of locations. **Example:** @@ -1676,9 +1648,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const locations = await appClient.listLocations( - '' -); +const locations = await appClient.listLocations(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#listlocations). @@ -1746,10 +1716,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.shareLocation( - '', - '' -); +await appClient.shareLocation('', ''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#sharelocation). @@ -1817,10 +1784,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.unshareLocation( - '', - '' -); +await appClient.unshareLocation('', ''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#unsharelocation). @@ -1885,14 +1849,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The `LocationAuth` for the requested location. +- (Promise<[LocationAuth](https://ts.viam.dev/classes/appApi.LocationAuth.html) | undefined>): The `LocationAuth` for the requested location. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const locationAuth = await appClient.locationAuth( - '' -); +const locationAuth = await appClient.locationAuth(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#locationauth). @@ -1957,14 +1919,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The newly created `LocationAuth`. +- (Promise<[LocationAuth](https://ts.viam.dev/classes/appApi.LocationAuth.html) | undefined>): The newly created `LocationAuth`. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const locationAuth = await appClient.createLocationSecret( - '' -); +const locationAuth = await appClient.createLocationSecret(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createlocationsecret). @@ -2043,10 +2003,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.deleteLocationSecret( - '', - '' -); +await appClient.deleteLocationSecret('', ''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deletelocationsecret). @@ -2067,7 +2024,7 @@ Get the user-defined metadata for a location. **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. **Example:** @@ -2112,9 +2069,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const metadata = await appClient.getLocationMetadata( - '' -); +const metadata = await appClient.getLocationMetadata(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getlocationmetadata). @@ -2132,7 +2087,7 @@ Update the user-defined metadata for a location. **Parameters:** - `location_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the location with which to associate the user-defined metadata. You can obtain your location ID from the location’s page. -- `metadata` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. +- `metadata` (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. **Returns:** @@ -2257,7 +2212,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The `Robot` object. +- (Promise<[appApi](https://ts.viam.dev/modules/appApi.html).[Robot](https://ts.viam.dev/classes/appApi.Robot.html) | undefined>): The `Robot` object. **Example:** @@ -2283,7 +2238,7 @@ Gets the [API keys](/organization/api-keys/) for the machine. **Returns:** -- ([List[viam.proto.app.APIKeyWithAuthorizations]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.APIKeyWithAuthorizations)): : The list of API keys. +- ([list[viam.proto.app.APIKeyWithAuthorizations]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.APIKeyWithAuthorizations)): : The list of API keys. **Example:** @@ -2328,8 +2283,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotAPIKeys = - await appClient.getRobotAPIKeys(''); +const robotAPIKeys = await appClient.getRobotAPIKeys(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getrobotapikeys). @@ -2350,7 +2304,7 @@ Get a list of all the {{< glossary_tooltip term_id="part" text="parts" >}} under **Returns:** -- ([List[RobotPart]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): : The list of machine parts. +- ([list[RobotPart]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPart)): : The list of machine parts. **Raises:** @@ -2490,10 +2444,7 @@ const robotPart = await appClient.getRobotPart(''); // Get the part's address const address = robotPart.part.fqdn; // Check if machine is live (last access time less than 10 sec ago) -if ( - Date.now() - Number(robotPart.part.lastAccess.seconds) * 1000 <= - 10000 -) { +if (Date.now() - Number(robotPart.part.lastAccess.seconds) * 1000 <= 10000) { console.log('Machine is live'); } ``` @@ -2515,14 +2466,14 @@ Get the logs associated with a specific machine {{< glossary_tooltip term_id="pa - `robot_part_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the machine part to get logs from. - `filter` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): Only include logs with messages that contain the string filter. Defaults to empty string “” (that is, no filter). - `dest` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): Optional filepath to write the log entries to. -- `log_levels` (List[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (required): List of log levels for which entries should be returned. Defaults to empty list, which returns all logs. +- `log_levels` (list[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (required): List of log levels for which entries should be returned. Defaults to empty list, which returns all logs. - `num_log_entries` ([int](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (required): Number of log entries to return. Passing 0 returns all logs. Defaults to 100. All logs or the first num_log_entries logs will be returned, whichever comes first. - `start` ([datetime.datetime](https://docs.python.org/3/library/datetime.html)) (optional): Optional start time for log retrieval. Only logs created after this time will be returned. - `end` ([datetime.datetime](https://docs.python.org/3/library/datetime.html)) (optional): Optional end time for log retrieval. Only logs created before this time will be returned. **Returns:** -- ([List[LogEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): : The list of log entries. +- ([list[LogEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): : The list of log entries. **Raises:** @@ -2587,26 +2538,22 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `id` (string) (required): The ID of the requested robot part. - `filter` (string) (optional): Optional string to filter logs on. -- `levels` (string) (optional): Optional array of log levels to return. Defaults to returning - all log levels. -- `start` (Date) (optional): Optional start time for log retrieval. Only logs created after - this time will be returned. -- `end` (Date) (optional): Optional end time for log retrieval. Only logs created before - this time will be returned. -- `pageToken` (string) (optional): Optional string indicating which page of logs to query. - Defaults to the most recent. +- `levels` (string) (optional): Optional array of log levels to return. Defaults to returning all log levels. +- `start` (Date) (optional): Optional start time for log retrieval. Only logs created after this time will be + returned. +- `end` (Date) (optional): Optional end time for log retrieval. Only logs created before this time will be + returned. +- `pageToken` (string) (optional): Optional string indicating which page of logs to query. Defaults to the most + recent. **Returns:** -- (Promise<[GetRobotPartLogsResponse](https://ts.viam.dev/classes/appApi.GetRobotPartLogsResponse.html)>): The robot requested logs and the page token for the next page of -logs. +- (Promise<[GetRobotPartLogsResponse](https://ts.viam.dev/classes/appApi.GetRobotPartLogsResponse.html)>): The robot requested logs and the page token for the next page of logs. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPartLogs = await appClient.getRobotPartLogs( - '' -); +const robotPartLogs = await appClient.getRobotPartLogs(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getrobotpartlogs). @@ -2619,6 +2566,28 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfac Query a specific robot part by name and location id. {{< tabs >}} +{{% tab name="Go" %}} + +**Parameters:** + +- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. +- `name` +- `locationID` [(string)](https://pkg.go.dev/builtin#string) + +**Returns:** + +- [(*RobotPart)](https://pkg.go.dev/go.viam.com/rdk/app#RobotPart) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +robotPart, err := cloud.GetRobotPartByNameAndLocation(context.Background(), "my-robot-main", "ab1c2d3e45") +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/app#AppClient.GetRobotPartByNameAndLocation). + +{{% /tab %}} {{% tab name="TypeScript" %}} **Parameters:** @@ -2635,7 +2604,7 @@ Query a specific robot part by name and location id. ```ts {class="line-numbers linkable-line-numbers"} const robotPart = await appClient.getRobotPartByNameAndLocation( '', - '' + '', ); ``` @@ -2659,7 +2628,7 @@ Get an asynchronous iterator that receives live machine part logs. **Returns:** -- ([viam.app._logs._LogsStream[List[LogEntry]]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): : The asynchronous iterator receiving live machine part logs. +- ([viam.app._logs._LogsStream[list[LogEntry]]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.LogEntry)): : The asynchronous iterator receiving live machine part logs. **Example:** @@ -2710,8 +2679,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `id` (string) (required): The ID of the requested robot part. - `queue` ([LogEntry](https://ts.viam.dev/classes/commonApi.LogEntry.html)) (required): A queue to put the log entries into. - `filter` (string) (optional): Optional string to filter logs on. -- `errorsOnly` (boolean) (optional): Optional bool to indicate whether or not only error-level - logs should be returned. Defaults to true. +- `errorsOnly` (boolean) (optional): Optional bool to indicate whether or not only error-level logs should be + returned. Defaults to true. **Returns:** @@ -2720,9 +2689,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPartLogs = await appClient.tailRobotPartLogs( - '' -); +const robotPartLogs = await appClient.tailRobotPartLogs(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#tailrobotpartlogs). @@ -2743,7 +2710,7 @@ Get a list containing the history of a machine {{< glossary_tooltip term_id="par **Returns:** -- ([List[RobotPartHistoryEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPartHistoryEntry)): : The list of the machine part’s history. +- ([list[RobotPartHistoryEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.RobotPartHistoryEntry)): : The list of the machine part’s history. **Raises:** @@ -2796,9 +2763,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPartHistory = await appClient.getRobotPartHistory( - '' -); +const robotPartHistory = await appClient.getRobotPartHistory(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getrobotparthistory). @@ -2818,7 +2783,7 @@ You can only change the name and configuration of the machine part, not the loca - `robot_part_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the robot part to update. - `name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): New name to be updated on the robot part. -- `robot_config` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Optional new config represented as a dictionary to be updated on the machine part. The machine part’s config will remain as is (no change) if one isn’t passed. +- `robot_config` ([collections.abc.Mapping[str, viam.utils.ValueTypes]](https://python.viam.dev/autoapi/viam/components/component_base/index.html#viam.components.component_base.ValueTypes)) (optional): Optional new config represented as a dictionary to be updated on the machine part. The machine part’s config will remain as is (no change) if one isn’t passed. - `last_known_update` ([datetime.datetime](https://docs.python.org/3/library/datetime.html)) (optional): Optional time of the last known update to this part’s config. If provided, this will result in a GRPCError if the upstream config has changed since this time, indicating that the local config is out of date. Omitting this parameter will result in an overwrite of the upstream config. - `robot_config_json` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): Optional raw JSON string of the robot config, preserving user-defined key order. When set, this takes precedence over robot_config for storage purposes. @@ -2892,15 +2857,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The updated robot part. +- (Promise<[RobotPart](https://ts.viam.dev/classes/appApi.RobotPart.html) | undefined>): The updated robot part. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPart = await appClient.updateRobotPart( - '', - 'newName' -); +const robotPart = await appClient.updateRobotPart('', 'newName'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#updaterobotpart). @@ -2978,10 +2940,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPartId = await appClient.newRobotPart( - '', - 'newPart' -); +const robotPartId = await appClient.newRobotPart('', 'newPart'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#newrobotpart). @@ -3260,14 +3219,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The robot part object. +- (Promise<[RobotPart](https://ts.viam.dev/classes/appApi.RobotPart.html) | undefined>): The robot part object. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotPart = await appClient.createRobotPartSecret( - '' -); +const robotPart = await appClient.createRobotPartSecret(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createrobotpartsecret). @@ -3344,10 +3301,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.deleteRobotPartSecret( - '', - '' -); +await appClient.deleteRobotPartSecret('', ''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deleterobotpartsecret). @@ -3368,7 +3322,7 @@ Get a list of all machines in a specified location. **Returns:** -- ([List[viam.proto.app.Robot]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Robot)): : The list of robots. +- ([list[viam.proto.app.Robot]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Robot)): : The list of robots. **Raises:** @@ -3425,6 +3379,43 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfac {{% /tab %}} {{< /tabs >}} +### ListMachineSummaries + +List summary information for the machines in an organization, optionally filtered by fragment or location. + +{{< tabs >}} +{{% tab name="Go" %}} + +**Parameters:** + +- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. +- `organizationID` [(string)](https://pkg.go.dev/builtin#string) +- `fragmentIDs` +- `locationIDs` [([]string)](https://pkg.go.dev/builtin#string) +- `limit` [(int32)](https://pkg.go.dev/builtin#int32) + +**Returns:** + +- [([]*LocationSummary)](https://pkg.go.dev/go.viam.com/rdk/app#LocationSummary) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} + summaries, err := cloud.ListMachineSummaries( + context.Background(), + "a1bcdefghi2jklmnopqrstuvw3xyzabc", + []string{locationID}, + []string{fragmetnID}, + 0, + ) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/app#AppClient.ListMachineSummaries). + +{{% /tab %}} +{{< /tabs >}} + ### NewRobot Create a new {{< glossary_tooltip term_id="machine" text="machine" >}}. @@ -3490,10 +3481,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const robotId = await appClient.newRobot( - '', - 'newRobot' -); +const robotId = await appClient.newRobot('', 'newRobot'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#newrobot). @@ -3588,7 +3576,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The newly-modified robot object. +- (Promise<[appApi](https://ts.viam.dev/modules/appApi.html).[Robot](https://ts.viam.dev/classes/appApi.Robot.html) | undefined>): The newly-modified robot object. **Example:** @@ -3596,7 +3584,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a const robot = await appClient.updateRobot( '', '', - 'newName' + 'newName', ); ``` @@ -3687,7 +3675,7 @@ Gets the user-defined metadata for a machine. **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. **Example:** @@ -3755,7 +3743,7 @@ Gets the user-defined metadata for a machine part. **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The user-defined metadata converted from JSON to a Python dictionary. **Example:** @@ -3802,9 +3790,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const metadata = await appClient.getRobotPartMetadata( - '' -); +const metadata = await appClient.getRobotPartMetadata(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getrobotpartmetadata). @@ -3823,7 +3809,7 @@ User-defined metadata is billed as data. **Parameters:** - `robot_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the robot with which to associate the user-defined metadata. You can obtain your robot ID from the machine page. -- `metadata` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. +- `metadata` (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. **Returns:** @@ -3902,7 +3888,7 @@ User-defined metadata is billed as data. **Parameters:** - `robot_part_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required) -- `metadata` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. +- `metadata` (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (required): The user-defined metadata converted from JSON to a Python dictionary. **Returns:** @@ -3981,11 +3967,11 @@ Get a list of {{< glossary_tooltip term_id="fragment" text="fragments" >}} in th - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to list fragments for. You can obtain your organization ID from the organization settings page. - `show_public` ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)) (required): Optional boolean specifying whether or not to only show public fragments. If True, only public fragments will return. If False, only private fragments will return. Defaults to True. Deprecated since version 0.25.0: Use visibilities instead. -- `visibilities` ([List[Fragment]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment.Visibility)) (optional): List of FragmentVisibilities specifying which types of fragments to include in the results. If empty, by default only public fragments will be returned. +- `visibilities` ([list[Fragment]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment.Visibility)) (optional): List of FragmentVisibilities specifying which types of fragments to include in the results. If empty, by default only public fragments will be returned. **Returns:** -- ([List[Fragment]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): : The list of fragments. +- ([list[Fragment]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment)): : The list of fragments. **Example:** @@ -4029,9 +4015,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** - `organizationId` (string) (required): The ID of the organization to list fragments for. -- `publicOnly` (boolean) (optional): Optional, deprecated boolean. Use fragmentVisibilities - instead. If true then only public fragments will be listed. Defaults to - true. +- `publicOnly` (boolean) (optional): Optional, deprecated boolean. Use fragmentVisibilities instead. If true then + only public fragments will be listed. Defaults to true. - `fragmentVisibility` ([FragmentVisibility](https://ts.viam.dev/enums/appApi.FragmentVisibility.html)) (optional) **Returns:** @@ -4041,9 +4026,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const fragments = await appClient.listFragments( - '' -); +const fragments = await appClient.listFragments(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#listfragments). @@ -4082,24 +4065,21 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** -- `machineId` (string) (required): The machine ID used to filter fragments defined in a - machine's parts. Also returns any fragments nested within the fragments - defined in parts. -- `additionalFragmentIds` (string) (optional): Additional fragment IDs to append to the - response. Useful when needing to view fragments that will be - provisionally added to the machine alongside existing fragments. +- `machineId` (string) (required): The machine ID used to filter fragments defined in a machine's parts. Also + returns any fragments nested within the fragments defined in parts. +- `additionalFragmentIds` (string) (optional): Additional fragment IDs to append to the response. Useful when + needing to view fragments that will be provisionally added to the machine alongside existing + fragments. **Returns:** -- (Promise<[Fragment](https://ts.viam.dev/classes/appApi.Fragment.html)[]>): The list of top level and nested fragments for a machine, as well -as additionally specified fragment IDs. +- (Promise<[Fragment](https://ts.viam.dev/classes/appApi.Fragment.html)[]>): The list of top level and nested fragments for a machine, as well as additionally +specified fragment IDs. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const fragments = await appClient.listMachineFragments( - '' -); +const fragments = await appClient.listMachineFragments(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#listmachinefragments). @@ -4109,7 +4089,7 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfac ### ListMachineSummaries -Lists machine summaries for an organization, optionally filtered by fragment IDs, location IDs, and limit. +List summary information for the machines in an organization, optionally filtered by fragment or location. {{< tabs >}} {{% tab name="TypeScript" %}} @@ -4128,12 +4108,7 @@ Lists machine summaries for an organization, optionally filtered by fragment IDs **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const summaries = await appClient.listMachineSummaries( - 'orgId', - ['frag1'], - ['loc1'], - 10 -); +const summaries = await appClient.listMachineSummaries('orgId', ['frag1'], ['loc1'], 10); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#listmachinesummaries). @@ -4203,14 +4178,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The requested fragment. +- (Promise<[Fragment](https://ts.viam.dev/classes/appApi.Fragment.html) | undefined>): The requested fragment. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const fragment = await appClient.getFragment( - '12a12ab1-1234-5678-abcd-abcd01234567' -); +const fragment = await appClient.getFragment('12a12ab1-1234-5678-abcd-abcd01234567'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getfragment). @@ -4229,7 +4202,7 @@ Create a new private {{< glossary_tooltip term_id="fragment" text="fragment" >}} - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to create the fragment within. You can obtain your organization ID from the organization settings page. - `name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Name of the fragment. -- `config` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Optional Dictionary representation of new config to assign to specified fragment. Can be assigned by updating the fragment. +- `config` ([collections.abc.Mapping[str, viam.utils.ValueTypes]](https://python.viam.dev/autoapi/viam/components/component_base/index.html#viam.components.component_base.ValueTypes)) (optional): Optional Dictionary representation of new config to assign to specified fragment. Can be assigned by updating the fragment. **Returns:** @@ -4293,22 +4266,18 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** -- `organizationId` (string) (required): The ID of the organization to create the fragment - under. +- `organizationId` (string) (required): The ID of the organization to create the fragment under. - `name` (string) (required): The name of the new fragment. - `config` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The new fragment's config. **Returns:** -- (Promise): The newly created fragment. +- (Promise<[Fragment](https://ts.viam.dev/classes/appApi.Fragment.html) | undefined>): The newly created fragment. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const fragment = await appClient.createFragment( - '', - 'newFragment' -); +const fragment = await appClient.createFragment('', 'newFragment'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createfragment). @@ -4327,9 +4296,9 @@ Update a {{< glossary_tooltip term_id="fragment" text="fragment" >}} name and it - `fragment_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the fragment to update. - `name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): New name to associate with the fragment. -- `config` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Optional Dictionary representation of new config to assign to specified fragment. Not passing this parameter will leave the fragment’s config unchanged. +- `config` ([collections.abc.Mapping[str, viam.utils.ValueTypes]](https://python.viam.dev/autoapi/viam/components/component_base/index.html#viam.components.component_base.ValueTypes)) (optional): Optional Dictionary representation of new config to assign to specified fragment. Not passing this parameter will leave the fragment’s config unchanged. - `public` ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)) (optional): Boolean specifying whether the fragment is public. Not passing this parameter will leave the fragment’s visibility unchanged. A fragment is private by default when created. Deprecated since version 0.25.0: Use visibility instead. -- `visibility` ([Fragment](https://python.viam.dev/autoapi/viam/gen/app/v1/app_pb2/index.html#viam.gen.app.v1.app_pb2.FragmentVisibility)) (optional): Optional FragmentVisibility list specifying who should be allowed to view the fragment. Not passing this parameter will leave the fragment’s visibility unchanged. A fragment is private by default when created. +- `visibility` ([Fragment](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.Fragment.Visibility)) (optional): Optional FragmentVisibility list specifying who should be allowed to view the fragment. Not passing this parameter will leave the fragment’s visibility unchanged. A fragment is private by default when created. - `last_known_update` ([datetime.datetime](https://docs.python.org/3/library/datetime.html)) (optional): Optional time of the last known update to this fragment’s config. If provided, this will result in a GRPCError if the upstream config has changed since this time, indicating that the local config is out of date. Omitting this parameter will result in an overwrite of the upstream config. **Returns:** @@ -4398,25 +4367,24 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a - `id` (string) (required): The ID of the fragment to update. - `name` (string) (required): The name to update the fragment to. - `config` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The config to update the fragment to. -- `makePublic` (boolean) (optional): Optional, deprecated boolean specifying whether the - fragment should be public or not. If not passed, the visibility will be - unchanged. Fragments are private by default when created. -- `visibility` ([FragmentVisibility](https://ts.viam.dev/enums/appApi.FragmentVisibility.html)) (optional): Optional FragmentVisibility specifying the updated - fragment visibility. If not passed, the visibility will be unchanged. If - visibility is not set and makePublic is set, makePublic takes effect. If - makePublic and visibility are set, they must not be conflicting. If - neither is set, the fragment visibility will remain unchanged. +- `makePublic` (boolean) (optional): Optional, deprecated boolean specifying whether the fragment should be public + or not. If not passed, the visibility will be unchanged. Fragments are private by default + when created. +- `visibility` ([FragmentVisibility](https://ts.viam.dev/enums/appApi.FragmentVisibility.html)) (optional): Optional FragmentVisibility specifying the updated fragment visibility. If + not passed, the visibility will be unchanged. If visibility is not set and makePublic is set, + makePublic takes effect. If makePublic and visibility are set, they must not be conflicting. + If neither is set, the fragment visibility will remain unchanged. **Returns:** -- (Promise): The updated fragment. +- (Promise<[Fragment](https://ts.viam.dev/classes/appApi.Fragment.html) | undefined>): The updated fragment. **Example:** ```ts {class="line-numbers linkable-line-numbers"} const fragment = await appClient.updateFragment( '12a12ab1-1234-5678-abcd-abcd01234567', - 'better_name' + 'better_name', ); ``` @@ -4509,7 +4477,7 @@ Get fragment history. **Returns:** -- ([List[FragmentHistoryEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.FragmentHistoryEntry)): : A list of documents with the fragment history. +- ([list[FragmentHistoryEntry]](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.FragmentHistoryEntry)): : A list of documents with the fragment history. **Raises:** @@ -4568,8 +4536,8 @@ Add a role under the organization you are currently authenticated to. - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to create the role in. You can obtain your organization ID from the organization settings page. - `identity_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the entity the role belongs to (for example, a user ID). -- `role` (Literal['owner'] | Literal['operator']) (required): The role to add (either `"owner"` or `"operator"`). -- `resource_type` (Literal['organization'] | Literal['location'] | Literal['robot']) (required): The type of the resource to add the role to (either `"organization"`, `"location"`, or `"robot"`). Must match the type of the `resource_id`'s resource. +- `role` (_ROLE_TYPE) (required): The role to add (either `"owner"` or `"operator"`). +- `resource_type` (_RESOURCE_TYPE_TYPE) (required): The type of the resource to add the role to (either `"organization"`, `"location"`, or `"robot"`). Must match the type of the `resource_id`'s resource. - `resource_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the resource the role applies to (the ID of either an {{< glossary_tooltip term_id="organization" text="organization" >}}, {{< glossary_tooltip term_id="location" text="location" >}}, or {{< glossary_tooltip term_id="machine" text="machine" >}}.). **Returns:** @@ -4618,11 +4586,10 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** - `organizationId` (string) (required): The ID of the organization to create the role under. -- `entityId` (string) (required): The ID of the entity the role belongs to (for example a - user ID). +- `entityId` (string) (required): The ID of the entity the role belongs to (for example a user ID). - `role` (string) (required): The role to add ("owner" or "operator"). -- `resourceType` (string) (required): The type of resource to create the role for ("robot", - "location", or "organization"). +- `resourceType` (string) (required): The type of resource to create the role for ("robot", "location", or + "organization"). - `resourceId` (string) (required): The ID of the resource the role is being created for. **Returns:** @@ -4637,7 +4604,7 @@ await appClient.addRole( '', 'owner', 'robot', - '' + '', ); ``` @@ -4657,8 +4624,8 @@ Remove a role under the organization you are currently authenticated to. - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization the role exists in. You can obtain your organization ID from the organization settings page. - `identity_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the entity the role belongs to (for example, a user ID). -- `role` (Literal['owner'] | Literal['operator']) (required): The role to remove. -- `resource_type` (Literal['organization'] | Literal['location'] | Literal['robot']) (required): Type of the resource the role is being removed from. Must match resource_id. +- `role` (_ROLE_TYPE) (required): The role to remove. +- `resource_type` (_RESOURCE_TYPE_TYPE) (required): Type of the resource the role is being removed from. Must match resource_id. - `resource_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the resource the role applies to (that is, either an organization, location, or robot ID). **Returns:** @@ -4703,11 +4670,10 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** - `organizationId` (string) (required): The ID of the organization to remove the role from. -- `entityId` (string) (required): The ID of the entity the role belongs to (for example a - user ID). +- `entityId` (string) (required): The ID of the entity the role belongs to (for example a user ID). - `role` (string) (required): The role to remove ("owner" or "operator"). -- `resourceType` (string) (required): The type of resource to remove the role from ("robot", - "location", or "organization"). +- `resourceType` (string) (required): The type of resource to remove the role from ("robot", "location", or + "organization"). - `resourceId` (string) (required): The ID of the resource the role is being removes from. **Returns:** @@ -4722,7 +4688,7 @@ await appClient.removeRole( '', 'owner', 'robot', - '' + '', ); ``` @@ -4742,12 +4708,12 @@ Changes an existing role to a new role. - `organization_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the organization. - `old_identity_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the entity the role belongs to (for example, a user ID). -- `old_role` (Literal['owner'] | Literal['operator']) (required): The role to be changed. -- `old_resource_type` (Literal['organization'] | Literal['location'] | Literal['robot']) (required): Type of the resource the role is added to. Must match old_resource_id. +- `old_role` (_ROLE_TYPE) (required): The role to be changed. +- `old_resource_type` (_RESOURCE_TYPE_TYPE) (required): Type of the resource the role is added to. Must match old_resource_id. - `old_resource_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the resource the role applies to (that is, either an organization, location, or robot ID). - `new_identity_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): New ID of the entity the role belongs to (for example, a user ID). -- `new_role` (Literal['owner'] | Literal['operator']) (required): The new role. -- `new_resource_type` (Literal['organization'] | Literal['location'] | Literal['robot']) (required): Type of the resource to add role to. Must match new_resource_id. +- `new_role` (_ROLE_TYPE) (required): The new role. +- `new_resource_type` (_RESOURCE_TYPE_TYPE) (required): Type of the resource to add role to. Must match new_resource_id. - `new_resource_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): New ID of the resource the role applies to (that is, either an organization, location, or robot ID). **Returns:** @@ -4845,11 +4811,11 @@ If no resource IDs are provided, all resource authorizations within the organiza **Parameters:** - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to list authorizations for. -- `resource_ids` (List[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (optional): IDs of the resources to retrieve authorizations from. If None, defaults to all resources. +- `resource_ids` (list[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (optional): IDs of the resources to retrieve authorizations from. If None, defaults to all resources. **Returns:** -- ([List[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)): : The list of authorizations. +- ([list[viam.proto.app.Authorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)): : The list of authorizations. **Raises:** @@ -4897,8 +4863,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** - `organizationId` (string) (required): The ID of the organization to list authorizations for. -- `resourceIds` (string) (optional): Optional list of IDs of resources to list authorizations - for. If not provided, all resources will be included. +- `resourceIds` (string) (optional): Optional list of IDs of resources to list authorizations for. If not + provided, all resources will be included. **Returns:** @@ -4918,11 +4884,11 @@ Check if the organization, location, or robot your `ViamClient` is authenticated **Parameters:** -- `permissions` ([List[viam.proto.app.AuthorizedPermissions]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.AuthorizedPermissions)) (required): the permissions to validate (for example, “read_organization”, “control_robot”). +- `permissions` ([list[viam.proto.app.AuthorizedPermissions]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.AuthorizedPermissions)) (required): the permissions to validate (for example, “read_organization”, “control_robot”). **Returns:** -- ([List[viam.proto.app.AuthorizedPermissions]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.AuthorizedPermissions)): : The permissions argument, with invalid permissions filtered out. +- ([list[viam.proto.app.AuthorizedPermissions]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.AuthorizedPermissions)): : The permissions argument, with invalid permissions filtered out. **Raises:** @@ -5103,14 +5069,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The requested item. +- (Promise<[RegistryItem](https://ts.viam.dev/classes/appApi.RegistryItem.html) | undefined>): The requested item. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const registryItem = await appClient.getRegistryItem( - '' -); +const registryItem = await appClient.getRegistryItem(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#getregistryitem). @@ -5176,8 +5140,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** -- `organizationId` (string) (required): The ID of the organization to create the registry - item under. +- `organizationId` (string) (required): The ID of the organization to create the registry item under. - `name` (string) (required): The name of the registry item. - `type` (PackageType) (required): The type of the item in the registry. @@ -5188,11 +5151,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -await appClient.createRegistryItem( - '', - 'newRegistryItemName', - 5 -); +await appClient.createRegistryItem('', 'newRegistryItemName', 5); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createregistryitem). @@ -5287,7 +5246,7 @@ await appClient.updateRegistryItem( '', 5, // Package: ML Model 'new description', - 1 // Private + 1, // Private ); ``` @@ -5306,16 +5265,16 @@ List the registry items in an organization. **Parameters:** - `organization_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to return registry items for. -- `types` (List[viam.proto.app.packages.PackageType.ValueType]) (required): The types of registry items. -- `visibilities` (List[viam.proto.app.Visibility.ValueType]) (required): The visibilities of registry items. -- `platforms` (List[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (required): The platforms of registry items. -- `statuses` (List[viam.proto.app.RegistryItemStatus.ValueType]) (required): The types of the items in the registry. +- `types` (list[viam.proto.app.packages.PackageType.ValueType]) (required): The types of registry items. +- `visibilities` (list[viam.proto.app.Visibility.ValueType]) (required): The visibilities of registry items. +- `platforms` (list[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (required): The platforms of registry items. +- `statuses` (list[viam.proto.app.RegistryItemStatus.ValueType]) (required): The types of the items in the registry. - `search_term` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): The search term of the registry items. - `page_token` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): The page token of the registry items. **Returns:** -- ([List[viam.proto.app.RegistryItem]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.RegistryItem)): : The list of registry items. +- ([list[viam.proto.app.RegistryItem]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.RegistryItem)): : The list of registry items. **Example:** @@ -5391,18 +5350,14 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** -- `organizationId` (string) (required): The ID of the organization to query registry items - for. +- `organizationId` (string) (required): The ID of the organization to query registry items for. - `types` (PackageType) (required): A list of types to query. If empty, will not filter on type. -- `visibilities` ([Visibility](https://ts.viam.dev/enums/appApi.Visibility.html)) (required): A list of visibilities to query for. If empty, will not - filter on visibility. -- `platforms` (string) (required): A list of platforms to query for. If empty, will not - filter on platform. -- `statuses` ([RegistryItemStatus](https://ts.viam.dev/enums/appApi.RegistryItemStatus.html)) (required): A list of statuses to query for. If empty, will not filter - on status. +- `visibilities` ([Visibility](https://ts.viam.dev/enums/appApi.Visibility.html)) (required): A list of visibilities to query for. If empty, will not filter on + visibility. +- `platforms` (string) (required): A list of platforms to query for. If empty, will not filter on platform. +- `statuses` ([RegistryItemStatus](https://ts.viam.dev/enums/appApi.RegistryItemStatus.html)) (required): A list of statuses to query for. If empty, will not filter on status. - `searchTerm` (string) (optional): Optional search term to filter on. -- `pageToken` (string) (optional): Optional page token for results. If not provided, will - return all results. +- `pageToken` (string) (optional): Optional page token for results. If not provided, will return all results. **Returns:** @@ -5416,7 +5371,7 @@ const registryItems = await appClient.listRegistryItems( [], // All package types [1], // Private packages [], - [1] // Active packages + [1], // Active packages ); ``` @@ -5490,6 +5445,198 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfac {{% /tab %}} {{< /tabs >}} +### DeprecateRegistryItem + +Mark a registry item, such as a module or training script, as deprecated. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `item_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the registry item to deprecate, containing either the namespace and module name (for example, my-org:my-module) or organization ID and module name (org-id:my-module). +- `message` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Message explaining the reason for deprecation. + +**Returns:** + +- None. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +await cloud.deprecate_registry_item("your-namespace:your-name", "This item is deprecated") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient.deprecate_registry_item). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `itemId` (string) (required): The ID of the item to deprecate. +- `message` (string) (required): The reason for deprecation. + +**Returns:** + +- (Promise) + +**Example:** + +```ts {class="line-numbers linkable-line-numbers"} +await appClient.deprecateRegistryItem('', 'reason for deprecation'); +``` + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deprecateregistryitem). + +{{% /tab %}} +{{< /tabs >}} + +### UndeprecateRegistryItem + +Remove the deprecated status from a registry item. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `item_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the registry item to undeprecate, containing either the namespace and module name (for example, my-org:my-module) or organization ID and module name (org-id:my-module). + +**Returns:** + +- None. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +await cloud.undeprecate_registry_item("your-namespace:your-name") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient.undeprecate_registry_item). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `itemId` (string) (required): The ID of the item to undeprecate. + +**Returns:** + +- (Promise) + +**Example:** + +```ts {class="line-numbers linkable-line-numbers"} +await appClient.undeprecateRegistryItem(''); +``` + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#undeprecateregistryitem). + +{{% /tab %}} +{{< /tabs >}} + +### DeprecateRegistryItemVersion + +Mark a specific version of a registry item as deprecated. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `item_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the registry item, containing either the namespace and module name (for example, my-org:my-module) or organization ID and module name (org-id:my-module). +- `version` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The semver string of the version to deprecate. +- `message` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Message explaining the reason for deprecation. + +**Returns:** + +- None. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +await cloud.deprecate_registry_item_version("your-namespace:your-name", "1.0.0", "This version has a bug") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient.deprecate_registry_item_version). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `itemId` (string) (required): The ID of the registry item. +- `version` (string) (required): The semver string of the version to deprecate. +- `message` (string) (required): The reason for deprecation. + +**Returns:** + +- (Promise) + +**Example:** + +```ts {class="line-numbers linkable-line-numbers"} +await appClient.deprecateRegistryItemVersion( + '', + '1.2.3', + 'reason for deprecation', +); +``` + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#deprecateregistryitemversion). + +{{% /tab %}} +{{< /tabs >}} + +### UndeprecateRegistryItemVersion + +Remove the deprecated status from a specific version of a registry item. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `item_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the registry item, containing either the namespace and module name (for example, my-org:my-module) or organization ID and module name (org-id:my-module). +- `version` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The semver string of the version to undeprecate. + +**Returns:** + +- None. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +await cloud.undeprecate_registry_item_version("your-namespace:your-name", "1.0.0") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient.undeprecate_registry_item_version). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `itemId` (string) (required): The ID of the registry item. +- `version` (string) (required): The semver string of the version to undeprecate. + +**Returns:** + +- (Promise) + +**Example:** + +```ts {class="line-numbers linkable-line-numbers"} +await appClient.undeprecateRegistryItemVersion('', '1.2.3'); +``` + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#undeprecateregistryitemversion). + +{{% /tab %}} +{{< /tabs >}} + ### CreateModule Create a {{< glossary_tooltip term_id="module" text="module" >}} under the organization you are currently authenticated to. @@ -5504,7 +5651,7 @@ Create a {{< glossary_tooltip term_id="module" text="module" >}} under the organ **Returns:** -- (Tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : A tuple containing the ID [0] of the new module and its URL [1]. +- (tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : A tuple containing the ID [0] of the new module and its URL [1]. **Raises:** @@ -5561,10 +5708,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const module = await appClient.createModule( - '', - 'newModule' -); +const module = await appClient.createModule('', 'newModule'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createmodule). @@ -5584,7 +5728,7 @@ Update the documentation URL, description, models, entrypoint, and/or the visibi - `module_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): ID of the module being updated, containing either the namespace and module name (for example, my-org:my-module) or organization ID and module name (org-id:my-module). - `url` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The url to reference for documentation and code (NOT the url of the module itself). - `description` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): A short description of the module that explains its purpose. -- `models` ([List[viam.proto.app.Model]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Model)) (optional): list of models that are available in the module. +- `models` ([list[viam.proto.app.Model]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Model)) (optional): list of models that are available in the module. - `entrypoint` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The executable to run to start the module program. - `public` ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)) (required): The visibility that should be set for the module. Defaults to False (private). @@ -5690,7 +5834,7 @@ const module = await appClient.updateModule( 'https://example.com', 'new description', [{ model: 'namespace:group:model1', api: 'rdk:component:generic' }], - 'entrypoint' + 'entrypoint', ); ``` @@ -5821,7 +5965,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Returns:** -- (Promise): The requested module. +- (Promise<[Module](https://ts.viam.dev/classes/appApi.Module.html) | undefined>): The requested module. **Example:** @@ -5847,7 +5991,7 @@ List the {{< glossary_tooltip term_id="module" text="modules" >}} under the orga **Returns:** -- ([List[viam.proto.app.Module]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Module)): : The list of modules. +- ([list[viam.proto.app.Module]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Module)): : The list of modules. **Example:** @@ -5911,12 +6055,12 @@ Create a new [API key](/organization/api-keys/). **Parameters:** - `org_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization to create the key for. You can obtain your organization ID from the organization settings page. -- `authorizations` ([List[APIKeyAuthorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (required): A list of authorizations to associate with the key. +- `authorizations` ([list[APIKeyAuthorization]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.Authorization)) (required): A list of authorizations to associate with the key. - `name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (optional): A name for the key. If None, defaults to the current timestamp. **Returns:** -- (Tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The api key and api key ID. +- (tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The api key and api key ID. **Raises:** @@ -5966,8 +6110,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/a **Parameters:** - `authorizations` ([Authorization](https://ts.viam.dev/classes/appApi.Authorization.html)) (required): The list of authorizations to provide for the API key. -- `name` (string) (optional): An optional name for the key. If none is passed, defaults to - present timestamp. +- `name` (string) (optional): An optional name for the key. If none is passed, defaults to present timestamp. **Returns:** @@ -6056,7 +6199,7 @@ Rotate an [API key](/organization/api-keys/#rotate-a-key). **Returns:** -- (Tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The API key and API key id. +- (tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The API key and API key id. **Example:** @@ -6123,7 +6266,7 @@ List all keys for the {{< glossary_tooltip term_id="organization" text="organiza **Returns:** -- ([List[viam.proto.app.APIKeyWithAuthorizations]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.APIKeyWithAuthorizations)): : The existing API keys and authorizations. +- ([list[viam.proto.app.APIKeyWithAuthorizations]](https://python.viam.dev/autoapi/viam/proto/app/index.html#viam.proto.app.APIKeyWithAuthorizations)): : The existing API keys and authorizations. **Example:** @@ -6219,7 +6362,7 @@ Create a new API key with an existing key’s authorizations. **Returns:** -- (Tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The API key and API key id. +- (tuple[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), [str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]): : The API key and API key id. **Example:** @@ -6244,10 +6387,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const key = - await appClient.createKeyFromExistingKeyAuthorizations( - '' - ); +const key = await appClient.createKeyFromExistingKeyAuthorizations(''); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/interfaces/AppClient.html#createkeyfromexistingkeyauthorizations). @@ -6276,7 +6416,7 @@ Retrieve the app content for an organization. ```ts {class="line-numbers linkable-line-numbers"} const appContent = await appClient.getAppContent( '', - '' + '', ); ``` @@ -6306,7 +6446,7 @@ Retrieves the app branding for an organization or app. ```ts {class="line-numbers linkable-line-numbers"} const branding = await appClient.getAppBranding( '', - '' + '', ); ``` diff --git a/static/include/app/apis/overrides/protos/app.DeprecateRegistryItem.md b/static/include/app/apis/overrides/protos/app.DeprecateRegistryItem.md new file mode 100644 index 0000000000..d2fb492a38 --- /dev/null +++ b/static/include/app/apis/overrides/protos/app.DeprecateRegistryItem.md @@ -0,0 +1 @@ +Mark a registry item, such as a module or training script, as deprecated. diff --git a/static/include/app/apis/overrides/protos/app.DeprecateRegistryItemVersion.md b/static/include/app/apis/overrides/protos/app.DeprecateRegistryItemVersion.md new file mode 100644 index 0000000000..654e431bf6 --- /dev/null +++ b/static/include/app/apis/overrides/protos/app.DeprecateRegistryItemVersion.md @@ -0,0 +1 @@ +Mark a specific version of a registry item as deprecated. diff --git a/static/include/app/apis/overrides/protos/app.ListMachineSummaries.md b/static/include/app/apis/overrides/protos/app.ListMachineSummaries.md index 198ea62b89..6bb0bcc1ed 100644 --- a/static/include/app/apis/overrides/protos/app.ListMachineSummaries.md +++ b/static/include/app/apis/overrides/protos/app.ListMachineSummaries.md @@ -1 +1 @@ -Lists machine summaries for an organization, optionally filtered by fragment IDs, location IDs, and limit. +List summary information for the machines in an organization, optionally filtered by fragment or location. diff --git a/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItem.md b/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItem.md new file mode 100644 index 0000000000..014ba6de94 --- /dev/null +++ b/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItem.md @@ -0,0 +1 @@ +Remove the deprecated status from a registry item. diff --git a/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItemVersion.md b/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItemVersion.md new file mode 100644 index 0000000000..1579a821b7 --- /dev/null +++ b/static/include/app/apis/overrides/protos/app.UndeprecateRegistryItemVersion.md @@ -0,0 +1 @@ +Remove the deprecated status from a specific version of a registry item. diff --git a/static/include/services/apis/generated/data_manager-table.md b/static/include/services/apis/generated/data_manager-table.md index ed08a2db27..19c7298dad 100644 --- a/static/include/services/apis/generated/data_manager-table.md +++ b/static/include/services/apis/generated/data_manager-table.md @@ -3,6 +3,7 @@ | ----------- | ----------- | --------------------------- | | [`Sync`](/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | | [`UploadBinaryDataToDatasets`](/reference/apis/services/data/#uploadbinarydatatodatasets) | Upload Binary data to the specified datasets. | | +| [`UploadImageToDatasets`](/reference/apis/services/data/#uploadimagetodatasets) | Upload an image from the machine to one or more datasets, with optional tags. | | | [`Reconfigure`](/reference/apis/services/data/#reconfigure) | Reconfigure this resource. | | | [`DoCommand`](/reference/apis/services/data/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | | | [`GetStatus`](/reference/apis/services/data/#getstatus) | Get the current status of the data management service as a map of key-value pairs describing its state. | | diff --git a/static/include/services/apis/generated/data_manager.md b/static/include/services/apis/generated/data_manager.md index 247a471889..913fca1e19 100644 --- a/static/include/services/apis/generated/data_manager.md +++ b/static/include/services/apis/generated/data_manager.md @@ -109,6 +109,31 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### UploadImageToDatasets + +Upload an image from the machine to one or more datasets, with optional tags. + +{{< tabs >}} +{{% tab name="Go" %}} + +**Parameters:** + +- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. +- `image` [(image.Image)](https://pkg.go.dev/image#Image) +- `datasetIDs` +- `tags` [([]string)](https://pkg.go.dev/builtin#string) +- `mimeType` [(datasyncpb.MimeType)](https://pkg.go.dev/go.viam.com/api/app/datasync/v1#MimeType) +- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. + +**Returns:** + +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/datamanager#Service). + +{{% /tab %}} +{{< /tabs >}} + ### Reconfigure Reconfigure this resource. diff --git a/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md b/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md index 9345cb9a2e..325dcf6325 100644 --- a/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md +++ b/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md @@ -1 +1 @@ -Upload an image data to the specified datasets. +Upload an image from the machine to one or more datasets, with optional tags. From 72dc9d724b0d3f09f21b186691f140ac158d820c Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 13 Jul 2026 15:12:07 -0600 Subject: [PATCH 2/2] Move UploadImageToDatasets to its own PR Split the data manager service method out so the fleet-page changes and the data manager change can be reviewed independently; they share no generated files. --- .github/workflows/sdk_protos_map.csv | 1 - .../apis/generated/data_manager-table.md | 1 - .../services/apis/generated/data_manager.md | 25 ------------------- .../data_manager.UploadImageToDatasets.md | 2 +- 4 files changed, 1 insertion(+), 28 deletions(-) diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index 77df7c4b17..6787238911 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -276,7 +276,6 @@ base_remote_control,Close,,,Close,, ## Data Manager data_manager,Sync,No,,Sync,,sync data_manager,UploadBinaryDataToDatasets,No,,UploadBinaryDataToDatasets,,uploadBinaryDataToDatasets -data_manager,UploadImageToDatasets,No,,UploadImageToDatasets,, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: data_manager,Reconfigure,No,,Reconfigure,, data_manager,DoCommand,No,,DoCommand,,doCommand diff --git a/static/include/services/apis/generated/data_manager-table.md b/static/include/services/apis/generated/data_manager-table.md index 19c7298dad..ed08a2db27 100644 --- a/static/include/services/apis/generated/data_manager-table.md +++ b/static/include/services/apis/generated/data_manager-table.md @@ -3,7 +3,6 @@ | ----------- | ----------- | --------------------------- | | [`Sync`](/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | | [`UploadBinaryDataToDatasets`](/reference/apis/services/data/#uploadbinarydatatodatasets) | Upload Binary data to the specified datasets. | | -| [`UploadImageToDatasets`](/reference/apis/services/data/#uploadimagetodatasets) | Upload an image from the machine to one or more datasets, with optional tags. | | | [`Reconfigure`](/reference/apis/services/data/#reconfigure) | Reconfigure this resource. | | | [`DoCommand`](/reference/apis/services/data/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | | | [`GetStatus`](/reference/apis/services/data/#getstatus) | Get the current status of the data management service as a map of key-value pairs describing its state. | | diff --git a/static/include/services/apis/generated/data_manager.md b/static/include/services/apis/generated/data_manager.md index 913fca1e19..247a471889 100644 --- a/static/include/services/apis/generated/data_manager.md +++ b/static/include/services/apis/generated/data_manager.md @@ -109,31 +109,6 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} -### UploadImageToDatasets - -Upload an image from the machine to one or more datasets, with optional tags. - -{{< tabs >}} -{{% tab name="Go" %}} - -**Parameters:** - -- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. -- `image` [(image.Image)](https://pkg.go.dev/image#Image) -- `datasetIDs` -- `tags` [([]string)](https://pkg.go.dev/builtin#string) -- `mimeType` [(datasyncpb.MimeType)](https://pkg.go.dev/go.viam.com/api/app/datasync/v1#MimeType) -- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. - -**Returns:** - -- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. - -For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/datamanager#Service). - -{{% /tab %}} -{{< /tabs >}} - ### Reconfigure Reconfigure this resource. diff --git a/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md b/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md index 325dcf6325..9345cb9a2e 100644 --- a/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md +++ b/static/include/services/apis/overrides/protos/data_manager.UploadImageToDatasets.md @@ -1 +1 @@ -Upload an image from the machine to one or more datasets, with optional tags. +Upload an image data to the specified datasets.