Skip to content

Commit dcd5939

Browse files
committed
Add documentation tags
These help generating the example codes in 1Password Developer docs.
1 parent 4d98bb9 commit dcd5939

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

example/desktop_app.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,19 @@ async def main():
3232
print(overview.title)
3333
# [developer-docs.sdk.python.list-items]-end
3434

35-
# Vault get overview
35+
# [developer-docs.sdk.python.get-vault-overview]-start
36+
# Get vault overview
3637
vaultOverview = await client.vaults.get_overview(vault_id)
3738
print(vaultOverview)
39+
# [developer-docs.sdk.python.get-vault-overview]-end
3840

39-
# Vault get details
41+
# [developer-docs.sdk.python.get-vault-details]-start
42+
# Get vault details
4043
vault = await client.vaults.get(vaultOverview.id, VaultGetParams(accessors=False))
4144
print(vault)
45+
# [developer-docs.sdk.python.get-vault-details]-end
4246

47+
# [developer-docs.sdk.python.batch-create-items]-start
4348
items_to_create = []
4449
for i in range(1, 4):
4550
items_to_create.append(ItemCreateParams(
@@ -84,7 +89,7 @@ async def main():
8489
],
8590
))
8691

87-
# Batch item create
92+
# Create all items in the same vault in a single batch
8893
batchCreateResponse = await client.items.create_all(vault.id, items_to_create)
8994

9095
item_ids = []
@@ -95,23 +100,28 @@ async def main():
95100
item_ids.append(res.content.id)
96101
elif res.error is not None:
97102
print("[Batch create] Something went wrong: {}".format(res.error))
103+
# [developer-docs.sdk.python.batch-create-items]-end
98104

99-
# Batch item get
105+
# [developer-docs.sdk.python.batch-get-items]-start
106+
# Get multiple items form the same vault in a single batch
100107
batchGetReponse = await client.items.get_all(vault.id, item_ids)
101108
for res in batchGetReponse.individual_responses:
102109
if res.content is not None:
103110
print('Obtained item "{}" ({})'.format(
104111
res.content.title, res.content.id))
105112
elif res.error is not None:
106113
print("[Batch get] Something went wrong: {}".format(res.error))
114+
# [developer-docs.sdk.python.batch-get-items]-end
107115

108-
# Batch item delete
116+
# [developer-docs.sdk.python.batch-delete-items]-start
117+
# Delete multiple items from the same vault in a single batch
109118
batchDeleteResponse = await client.items.delete_all(vault.id, item_ids)
110119
for id, res in batchDeleteResponse.individual_responses.items():
111120
if res.error is not None:
112121
print("[Batch delete] Something went wrong: {}".format(res.error))
113122
else:
114123
print("Deleted item {}".format(id))
124+
# [developer-docs.sdk.python.batch-delete-items]-end
115125

116126

117127
if __name__ == "__main__":

0 commit comments

Comments
 (0)