Docs updates and List size constraints (#22)

palantir · Sep 18, 2024 · e7e4ec8 · e7e4ec8
1 parent 8d3ec69
commit e7e4ec8
Show file tree

Hide file tree

Showing 48 changed files with 345 additions and 324 deletions.
diff --git a/README.md b/README.md
@@ -37,11 +37,6 @@ You can install the Python package using `pip`:
 pip install foundry-platform-sdk
 ```
 
-Then, import the package:
-```python
-import foundry.v2
-```
-
 <a id="major-version-link"></a>
 ## API Versioning
 Every endpoint of the Foundry API is versioned using a version number that appears in the URL. For example,
@@ -86,6 +81,8 @@ You can pass in the hostname and token as keyword arguments when
 initializing the `UserTokenAuth`:
 
 ```python
+import foundry
+
 foundry_client = foundry.v2.FoundryClient(
     auth=foundry.UserTokenAuth(
         hostname="example.palantirfoundry.com",
@@ -107,6 +104,8 @@ the sign-in process using the `sign_in_as_service_user` method. As these service
 automatically retry all operations one time if a `401` (Unauthorized) error is thrown after refreshing the token.
 
 ```python
+import foundry
+
 auth = foundry.ConfidentialClientAuth(
     client_id=os.environ["CLIENT_ID"],
     client_secret=os.environ["CLIENT_SECRET"],
@@ -124,6 +123,8 @@ auth.sign_in_as_service_user()
 After creating the `ConfidentialClientAuth` object, pass it in to the `FoundryClient`,
 
 ```python
+import foundry.v2
+
 foundry_client = foundry.v2.FoundryClient(auth=auth, hostname="example.palantirfoundry.com")
 ```
 
@@ -135,7 +136,7 @@ purposes.
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -158,7 +159,7 @@ try:
     )
     print("The create response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.create: %s\n" % e)
 
 ```
@@ -201,7 +202,7 @@ the [Pydantic error documentation](https://docs.pydantic.dev/latest/errors/error
 experience. See [Static Type Analysis](#static-types) below for more information.
 
 ### HTTP exceptions
-When an HTTP error status is returned, a `PalantirRPCException` is thrown. All HTTP error exception classes inherit from `ApiException`.
+When an HTTP error status is returned, a `PalantirRPCException` is thrown.
 
 ```python
 from foundry import PalantirRPCException

diff --git a/changelog/@unreleased/pr-22.v2.yml b/changelog/@unreleased/pr-22.v2.yml
@@ -0,0 +1,7 @@
+type: improvement
+improvement:
+  description: |-
+    - Docs updates including updating examples and fixing imports
+    - Adding size constraints around List types when applicable
+  links:
+  - https://github.com/palantir/foundry-platform-python/pull/22
diff --git a/docs/v1/Datasets/Branch.md b/docs/v1/Datasets/Branch.md
@@ -29,7 +29,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -52,7 +52,7 @@ try:
     )
     print("The create response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.create: %s\n" % e)
 
 ```
@@ -90,7 +90,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -110,7 +110,7 @@ try:
     )
     print("The delete response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.delete: %s\n" % e)
 
 ```
@@ -148,7 +148,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -168,7 +168,7 @@ try:
     )
     print("The get response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.get: %s\n" % e)
 
 ```
@@ -206,7 +206,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -225,7 +225,7 @@ try:
         page_size=page_size,
     ):
         pprint(branch)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.list: %s\n" % e)
 
 ```
@@ -264,7 +264,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -287,7 +287,7 @@ try:
     )
     print("The page response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Branch.page: %s\n" % e)
 
 ```

diff --git a/docs/v1/Datasets/Dataset.md b/docs/v1/Datasets/Dataset.md
@@ -26,7 +26,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -46,7 +46,7 @@ try:
     )
     print("The create response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.create: %s\n" % e)
 
 ```
@@ -83,7 +83,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -109,7 +109,7 @@ try:
     )
     print("The delete_schema response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.delete_schema: %s\n" % e)
 
 ```
@@ -146,7 +146,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -163,7 +163,7 @@ try:
     )
     print("The get response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.get: %s\n" % e)
 
 ```
@@ -200,7 +200,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -226,7 +226,7 @@ try:
     )
     print("The get_schema response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.get_schema: %s\n" % e)
 
 ```
@@ -271,7 +271,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -306,7 +306,7 @@ try:
     )
     print("The read response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.read: %s\n" % e)
 
 ```
@@ -400,7 +400,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -426,7 +426,7 @@ try:
     )
     print("The replace_schema response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling Dataset.replace_schema: %s\n" % e)
 
 ```

diff --git a/docs/v1/Datasets/File.md b/docs/v1/Datasets/File.md
@@ -44,7 +44,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -70,7 +70,7 @@ try:
     )
     print("The delete response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.delete: %s\n" % e)
 
 ```
@@ -132,7 +132,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -161,7 +161,7 @@ try:
     )
     print("The get response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.get: %s\n" % e)
 
 ```
@@ -225,7 +225,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -253,7 +253,7 @@ try:
         start_transaction_rid=start_transaction_rid,
     ):
         pprint(file)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.list: %s\n" % e)
 
 ```
@@ -338,7 +338,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -370,7 +370,7 @@ try:
     )
     print("The page response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.page: %s\n" % e)
 
 ```
@@ -433,7 +433,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -462,7 +462,7 @@ try:
     )
     print("The read response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.read: %s\n" % e)
 
 ```
@@ -521,7 +521,7 @@ Name | Type | Description  | Notes |
 
 ```python
 from foundry.v1 import FoundryClient
-from foundry import PalantirRPCException
+import foundry
 from pprint import pprint
 
 foundry_client = FoundryClient(
@@ -553,7 +553,7 @@ try:
     )
     print("The upload response:\n")
     pprint(api_response)
-except PalantirRPCException as e:
+except foundry.PalantirRPCException as e:
     print("HTTP error when calling File.upload: %s\n" % e)
 
 ```