Skip to content

Commit

Permalink
feat(docs): Update API docs and models with new endpoints and fields
Browse files Browse the repository at this point in the history
  • Loading branch information
mason-at-pieces committed Jul 8, 2024
1 parent 2ed27d1 commit c87ddf7
Show file tree
Hide file tree
Showing 18 changed files with 907 additions and 61 deletions.
2 changes: 1 addition & 1 deletion docs/Activity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Activity

consider a rename to Event? That being said if we go with event we need to think about a word to pre/post fix event because it is likely to be a reserved word. additional documentation: https://www.notion.so/getpieces/Activity-4da8de193733441f85f87b510235fb74 Notes: - user/asset/format are all optional, NOT required that one of these are present. - if mechanism == internal we will not display to the user. Thoughts around additional properties. - hmm dismissed array here, that is an array of strings, where the string is the userId that dismissed this notification? or we could potentially do it based on the os_ID. -


## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/AnchorApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description
[**anchor_associate_workstream_summary**](AnchorApi.md#anchor_associate_workstream_summary) | **POST** /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} | /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]
[**anchor_disassociate_asset**](AnchorApi.md#anchor_disassociate_asset) | **POST** /anchor/{anchor}/assets/disassociate/{asset} | /anchor/{anchor}/assets/disassociate/{asset} [POST]
[**anchor_disassociate_conversation**](AnchorApi.md#anchor_disassociate_conversation) | **POST** /anchor/{anchor}/conversations/disassociate/{conversation} | /anchor/{anchor}/conversations/disassociate/{conversation} [POST]
[**anchor_disassociate_person**](AnchorApi.md#anchor_disassociate_person) | **POST** /anchors/{anchor}/persons/disassociate/{person} | /anchor/{anchor}/persons/disassociate/{person} [POST]
[**anchor_disassociate_person**](AnchorApi.md#anchor_disassociate_person) | **POST** /anchor/{anchor}/persons/disassociate/{person} | /anchor/{anchor}/persons/disassociate/{person} [POST]
[**anchor_disassociate_workstream_summary**](AnchorApi.md#anchor_disassociate_workstream_summary) | **POST** /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} | /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]
[**anchor_rename**](AnchorApi.md#anchor_rename) | **POST** /anchor/{anchor}/rename | /anchor/{anchor}/rename [POST]
[**anchor_scores_increment**](AnchorApi.md#anchor_scores_increment) | **POST** /anchor/{anchor}/scores/increment | '/anchor/{anchor}/scores/increment' [POST]
Expand Down
136 changes: 136 additions & 0 deletions docs/AssetApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**asset_associate_anchor**](AssetApi.md#asset_associate_anchor) | **POST** /asset/{asset}/anchors/associate/{anchor} | /asset/{asset}/persons/associate/{anchor} [POST]
[**asset_associate_conversation**](AssetApi.md#asset_associate_conversation) | **POST** /asset/{asset}/conversations/associate/{conversation} | /asset/{asset}/conversations/associate/{conversation} [POST]
[**asset_associate_hint**](AssetApi.md#asset_associate_hint) | **POST** /asset/{asset}/hints/associate/{hint} | /asset/{asset}/hints/associate/{hint} [POST]
[**asset_associate_person**](AssetApi.md#asset_associate_person) | **POST** /asset/{asset}/persons/associate/{person} | /asset/{asset}/persons/associate/{person} [POST]
[**asset_associate_tag**](AssetApi.md#asset_associate_tag) | **POST** /asset/{asset}/tags/associate/{tag} | /asset/{asset}/tags/associate/{tag} [POST]
[**asset_associate_website**](AssetApi.md#asset_associate_website) | **POST** /asset/{asset}/websites/associate/{website} | /asset/{asset}/websites/associate/{website} [POST]
[**asset_associate_workstream_summary**](AssetApi.md#asset_associate_workstream_summary) | **POST** /asset/{asset}/workstream_summaries/associate/{workstream_summary} | /asset/{asset}/workstream_summaries/associate/{workstream_summary} [POST]
[**asset_disassociate_anchor**](AssetApi.md#asset_disassociate_anchor) | **POST** /asset/{asset}/anchors/disassociate/{anchor} | /asset/{asset}/anchors/disassociate/{anchor} [POST]
[**asset_disassociate_conversation**](AssetApi.md#asset_disassociate_conversation) | **POST** /asset/{asset}/conversations/disassociate/{conversation} | /asset/{asset}/conversations/disassociate/{conversation} [POST]
[**asset_disassociate_hint**](AssetApi.md#asset_disassociate_hint) | **POST** /asset/{asset}/hints/disassociate/{hint} | /asset/{asset}/hints/disassociate/{hint} [POST]
[**asset_disassociate_person**](AssetApi.md#asset_disassociate_person) | **POST** /asset/{asset}/persons/disassociate/{person} | /asset/{asset}/persons/disassociate/{person} [POST]
[**asset_disassociate_tag**](AssetApi.md#asset_disassociate_tag) | **POST** /asset/{asset}/tags/disassociate/{tag} | /asset/{asset}/tags/disassociate/{tag} [POST]
[**asset_disassociate_website**](AssetApi.md#asset_disassociate_website) | **POST** /asset/{asset}/websites/disassociate/{website} | /asset/{asset}/websites/disassociate/{website} [POST]
Expand Down Expand Up @@ -161,6 +163,73 @@ No authorization required

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **asset_associate_hint**
> asset_associate_hint(asset, hint)
/asset/{asset}/hints/associate/{hint} [POST]

associates an asset and a hint. It performs the same action as the hint equivalent.

### Example

```python
import time
import os
import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host = "http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AssetApi(api_client)
asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access.
hint = 'hint_example' # str | This is a specific hint uuid

try:
# /asset/{asset}/hints/associate/{hint} [POST]
api_instance.asset_associate_hint(asset, hint)
except Exception as e:
print("Exception when calling AssetApi->asset_associate_hint: %s\n" % e)
```



### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset** | **str**| The id (uuid) of the asset that you are trying to access. |
**hint** | **str**| This is a specific hint uuid |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **asset_associate_person**
> asset_associate_person(asset, person)
Expand Down Expand Up @@ -563,6 +632,73 @@ No authorization required

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **asset_disassociate_hint**
> asset_disassociate_hint(asset, hint)
/asset/{asset}/hints/disassociate/{hint} [POST]

Disassociates an asset from a hint. It performs the same action as the hint equivalent.

### Example

```python
import time
import os
import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host = "http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AssetApi(api_client)
asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access.
hint = 'hint_example' # str | This is a specific hint uuid

try:
# /asset/{asset}/hints/disassociate/{hint} [POST]
api_instance.asset_disassociate_hint(asset, hint)
except Exception as e:
print("Exception when calling AssetApi->asset_disassociate_hint: %s\n" % e)
```



### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset** | **str**| The id (uuid) of the asset that you are trying to access. |
**hint** | **str**| This is a specific hint uuid |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **asset_disassociate_person**
> asset_disassociate_person(asset, person)
Expand Down
23 changes: 4 additions & 19 deletions docs/CheckedOSUpdate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: CheckedOSUpdate | Python SDK
---

# CheckedOSUpdate

This is the model for the progress of the current update of Pieces os. /os/update/check/stream && /os/update/check/ we will emit on a progress update updated: is an optional property that will let us know when the update was checked last. NOTE: it is reccommended to use the stream instead of pulling. NOTE: lets think about if we want to have a closing(as well as how we want to handle restarts)
Expand All @@ -11,23 +15,4 @@ Name | Type | Description | Notes
**updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional]
**percentage** | **float** | Optionally if the update is in progress you will recieve a download percent(from 0-100). | [optional]

## Example

```python
from pieces_os_client.models.checked_os_update import CheckedOSUpdate

# TODO update the JSON string below
json = "{}"
# create an instance of CheckedOSUpdate from a JSON string
checked_os_update_instance = CheckedOSUpdate.from_json(json)
# print the JSON string representation of the object
print CheckedOSUpdate.to_json()

# convert the object into a dict
checked_os_update_dict = checked_os_update_instance.to_dict()
# create an instance of CheckedOSUpdate from a dict
checked_os_update_form_dict = checked_os_update.from_dict(checked_os_update_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


4 changes: 2 additions & 2 deletions docs/FlattenedHint.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Name | Type | Description | Notes
**created** | [**GroupedTimestamp**](GroupedTimestamp.md) | |
**updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | |
**deleted** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional]
**mechanism** | [**MechanismEnum**](MechanismEnum.md) | | [optional]
**asset** | [**ReferencedAsset**](ReferencedAsset.md) | | [optional]
**mechanisms** | [**Dict[str, MechanismEnum]**](MechanismEnum.md) | This is a Map<String, MechanismEnum> where the the key is an asset id. | [optional]
**assets** | [**FlattenedAssets**](FlattenedAssets.md) | | [optional]
**type** | [**HintTypeEnum**](HintTypeEnum.md) | |
**text** | **str** | This is the text of the hint. |
**model** | [**ReferencedModel**](ReferencedModel.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/Hint.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Name | Type | Description | Notes
**created** | [**GroupedTimestamp**](GroupedTimestamp.md) | |
**updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | |
**deleted** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional]
**mechanism** | [**MechanismEnum**](MechanismEnum.md) | | [optional]
**asset** | [**ReferencedAsset**](ReferencedAsset.md) | | [optional]
**mechanisms** | [**Dict[str, MechanismEnum]**](MechanismEnum.md) | This is a Map<String, MechanismEnum> where the the key is an asset id. | [optional]
**assets** | [**FlattenedAssets**](FlattenedAssets.md) | | [optional]
**type** | [**HintTypeEnum**](HintTypeEnum.md) | |
**text** | **str** | This is the text of the hint. |
**model** | [**ReferencedModel**](ReferencedModel.md) | | [optional]
Expand Down
136 changes: 136 additions & 0 deletions docs/HintApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,147 @@ All URIs are relative to *http://localhost:1000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**hint_associate_asset**](HintApi.md#hint_associate_asset) | **POST** /hint/{hint}/assets/associate/{asset} | /hint/{hint}/assets/associate/{asset} [POST]
[**hint_disassociate_asset**](HintApi.md#hint_disassociate_asset) | **POST** /hint/{hint}/assets/disassociate/{asset} | /hint/{hint}/assets/disassociate/{asset} [POST]
[**hint_scores_increment**](HintApi.md#hint_scores_increment) | **POST** /hint/{hint}/scores/increment | '/hint/{hint}/scores/increment' [POST]
[**hint_specific_hint_snapshot**](HintApi.md#hint_specific_hint_snapshot) | **GET** /hint/{hint} | /hint/{hint} [POST]
[**hint_update**](HintApi.md#hint_update) | **POST** /hint/update | /hint/update [POST]


# **hint_associate_asset**
> hint_associate_asset(hint, asset)
/hint/{hint}/assets/associate/{asset} [POST]

associates a hint and an asset. It performs the same action as the asset equivalent.

### Example

```python
import time
import os
import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host = "http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.HintApi(api_client)
hint = 'hint_example' # str | This is a specific hint uuid
asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access.

try:
# /hint/{hint}/assets/associate/{asset} [POST]
api_instance.hint_associate_asset(hint, asset)
except Exception as e:
print("Exception when calling HintApi->hint_associate_asset: %s\n" % e)
```



### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**hint** | **str**| This is a specific hint uuid |
**asset** | **str**| The id (uuid) of the asset that you are trying to access. |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **hint_disassociate_asset**
> hint_disassociate_asset(hint, asset)
/hint/{hint}/assets/disassociate/{asset} [POST]

Disassociates a hint from an asset. It performs the same action as the asset equivalent.

### Example

```python
import time
import os
import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host = "http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.HintApi(api_client)
hint = 'hint_example' # str | This is a specific hint uuid
asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access.

try:
# /hint/{hint}/assets/disassociate/{asset} [POST]
api_instance.hint_disassociate_asset(hint, asset)
except Exception as e:
print("Exception when calling HintApi->hint_disassociate_asset: %s\n" % e)
```



### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**hint** | **str**| This is a specific hint uuid |
**asset** | **str**| The id (uuid) of the asset that you are trying to access. |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **hint_scores_increment**
> hint_scores_increment(hint, seeded_score_increment=seeded_score_increment)
Expand Down
Loading

0 comments on commit c87ddf7

Please sign in to comment.