Skip to content

Commit f2c1d97

Browse files
yosriadyclaude
andcommitted
docs(api): consolidate profiles label/property endpoint naming
Standardize the single and batch label/property write endpoints on a <verb> <resource> scheme with a Batch prefix for the multi-wallet variant, and regroup the Profiles API sidebar by resource: - "Update Profile" -> "Update Properties" - "Create Properties" -> "Batch Update Properties" - "Create Label" -> "Add Labels" - "Create Labels" -> "Batch Add Labels" Rename the page slugs to match and add redirects from the old slugs. operationIds are unchanged. Summaries in api/openapi.json updated to match (mirrored in the formono backend spec). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 9e61a57 commit f2c1d97

7 files changed

Lines changed: 31 additions & 13 deletions

File tree

api/openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5049,7 +5049,7 @@
50495049
"/v0/profiles/labels": {
50505050
"post": {
50515051
"operationId": "batchUpsertUserLabels",
5052-
"summary": "Create Labels",
5052+
"summary": "Batch add or update user labels",
50535053
"description": "Upsert up to 100 labels across many wallets in one request; each item carries its own `address`. Modelled on the events ingest API: rows with an invalid address (ENS names are NOT resolved here; pass a literal EVM `0x...` or Solana address) are quarantined (skipped and reported in the response) rather than failing the whole batch. A request where every row is invalid returns 400. Requires profiles:write scope.",
50545054
"tags": [
50555055
"Profiles"
@@ -5146,7 +5146,7 @@
51465146
"/v0/profiles/properties": {
51475147
"post": {
51485148
"operationId": "batchUpdateUserProperties",
5149-
"summary": "Create Properties",
5149+
"summary": "Batch update user properties",
51505150
"description": "Set first-party properties for up to 100 wallets in one request. Each item is a flat object with a required `address` (literal EVM `0x...` or Solana; ENS names are NOT resolved here) plus any of the allowed profile keys. Unknown keys are ignored; a row left with no valid keys, or with an invalid address, is quarantined (skipped and reported) rather than failing the batch. A request where every row is invalid returns 400. Requires profiles:write scope.",
51515151
"tags": [
51525152
"Profiles"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Create Label'
2+
title: 'Add Labels'
33
description: 'Add or update one or more labels on a wallet profile. Labels tag wallets with custom attributes like VIP tier, airdrop eligibility, or verification status.'
44
openapi: 'POST /v0/profiles/{address}/labels'
55
---
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Create Labels'
2+
title: 'Batch Add Labels'
33
description: 'Add or update up to 100 labels across many wallets in a single request. Each item carries its own address; rows with an invalid address are quarantined and reported rather than failing the whole batch.'
44
openapi: 'POST /v0/profiles/labels'
55
---
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Create Properties'
2+
title: 'Batch Update Properties'
33
description: 'Set first-party profile properties for up to 100 wallets in a single request. Each item is a flat object with a required address; unknown keys are ignored and invalid rows are quarantined rather than failing the whole batch.'
44
openapi: 'POST /v0/profiles/properties'
55
---

api/profiles/delete-label.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ openapi: 'DELETE /v0/profiles/{address}/labels'
55
---
66

77
<Note>
8-
This endpoint tombstones the label at the current server time. To record a removal at a *past* point in time (for example, when importing a label's history), use [Create Label](/api/profiles/create-label) with `_is_deleted: 1` and a past `timestamp` instead.
8+
This endpoint tombstones the label at the current server time. To record a removal at a *past* point in time (for example, when importing a label's history), use [Add Labels](/api/profiles/add-labels) with `_is_deleted: 1` and a past `timestamp` instead.
99
</Note>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Update Profile'
2+
title: 'Update Properties'
33
description: 'Merge-update profile properties for a wallet. Set display name, email, socials, avatar, location, and other identity fields via a single PUT request.'
44
openapi: 'PUT /v0/profiles/{address}/properties'
55
---

docs.json

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,12 @@
154154
"pages": [
155155
"api/profiles/get",
156156
"api/profiles/search",
157-
"api/profiles/import",
158-
"api/profiles/update",
159-
"api/profiles/create-label",
157+
"api/profiles/update-properties",
158+
"api/profiles/batch-update-properties",
159+
"api/profiles/add-labels",
160160
"api/profiles/delete-label",
161-
"api/profiles/create-labels",
162-
"api/profiles/create-properties"
161+
"api/profiles/batch-add-labels",
162+
"api/profiles/import"
163163
]
164164
},
165165
{
@@ -347,5 +347,23 @@
347347
},
348348
"apiReference": {
349349
"spec": "api/openapi.json"
350-
}
350+
},
351+
"redirects": [
352+
{
353+
"source": "/api/profiles/update",
354+
"destination": "/api/profiles/update-properties"
355+
},
356+
{
357+
"source": "/api/profiles/create-properties",
358+
"destination": "/api/profiles/batch-update-properties"
359+
},
360+
{
361+
"source": "/api/profiles/create-label",
362+
"destination": "/api/profiles/add-labels"
363+
},
364+
{
365+
"source": "/api/profiles/create-labels",
366+
"destination": "/api/profiles/batch-add-labels"
367+
}
368+
]
351369
}

0 commit comments

Comments
 (0)