Skip to content

Commit c1ec935

Browse files
rickyromborickyrombo
authored
Regenerate API docs - Add register api (#13790)
1 parent 0f52e75 commit c1ec935

4 files changed

Lines changed: 166 additions & 19 deletions

File tree

‎docs/docs/developers/api/register-developer-app-api-key.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: register-developer-app-api-key
3+
title: "Register Developer App API Key"
4+
description: "Register api_key and api_secret in api_keys table for developer apps created via entity manager transactions. Use when the client sends raw ManageEntity tx instead of POST /developer-apps. Inserts with rps=10, rpm=500000. Requires the app to exist in developer_apps and belong to the authenticated user."
5+
sidebar_label: "Register Developer App API Key"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJztV21zGjcQ/is7+oQ9B9iJkw83TWdw7TZO68Tj4Lip8TjitHAyh3SRdLyUuf/eWZ0OjkDsST7XX8CSdvfZZ19ZMcfHlsV3TOAMM52jeeB5btl9xATaxMjcSa1YzK5xLK1DAzyXDxNcAlfCf7eYGHQgVX1jwfFhhjDSBtZagbRCYpA7FDCTHFA56ZYw5YqP0YAzXFmekDXbgRuLME9RgUsRkkyicmBRCQuGz+HSy5xXCtwCpLIOuQA9gqsPH/vQXZttk9kOXCiLxlmYS5eCye2b46MITD598+qI/jpwjV8LadB6ezzPwWnAhbTer21qvONDzLQa0ysvULiU3Em8c4VF02ERIwlO/lyIJn9na0p6eQ69qwv4E5csYhaTwki3ZPHdip1yK5Ne4VIW392X0YqdIjdo1if3Ecu54VN0aKyXUHyKLGZk/EEKFjFJUftaoCHl27Hsp+hRwsUZcebqf+epBj1XFQtboWMRMxVFgsXOFBgxm6Q45SxeMbfMybR1RqoxKwluQMOFMGhtjSbnLt0Bc9a0A0ECWkTMBJcHP2T5vnqM1p1qsaQXi3aiBY5RtcNFe6jFsh3wTdFxwR3fYyTRyqFypIPneUaxlVp1Hy2BXu1i0MNHTNyWoju2qQ8qqNyQm06irbSu73Y82RcwIiTUWis3csYdEkGQ4uLA19pu0MoyYk66jDSbkH8PoUofAh8PxAcrS3pr0OZa2Qrfi6Mj+tgGEqICtTYUYIskQWtHRZZRpv00b9vsBK2Nh0OtM+Rqh5vbFF2KlfsVrKrqYM5tA9xzZFSeByJO9vl+ygUE0qDV6Hx1wA+2vK/UHO+quVHULrSR/6LYI3GyK7FdIUo7GOlC7Qq/2of6I5oZGkBjtPlGooyoAFJN7SnX1geBKjRm3zTQ7iqUZdmtmWvzXLYnoXGRhaoLFSZjMUudy23c7fJcdnghZGE7ie7OjhkVaN3nPlImVMFudLt1uEkHC7Xuw09vdoL/tt+/Ai8OvU0T9tGnVn9OmYHFFJoFQ7UyN9IhrDu07QzUQB0ebus4PKRTGkVPmCEDPvdybu1cGwEjiZkAIppLZWGpC7MXSDxQX758GaheSAevMA5mfhlyi69PWtSXqVnFQZBa4q9BcKDqRk4vIOEKhghcLWHGswI70G/CmhbW0f138dCoS3FB/Ey5g5ZnkLiSLtWFg6MF5AZHcnHg2Tpf8Gme4ZNeiL/fZ8n0VTq8vXl9+Xa8uHy8PHrf//zyw9lk/vn23eM/f3ya/iVPirVDh4dv9Rykg7k2ExtTBI4rP6jzCKRmXo2nTTRoqxAUEp7ZgXrRgfOFMzxx1butyBs93ROrgXrZgTM0chZ0r9mpp9FGcKNtoE78nkIi0m6eagO8yQUkKSYTu0mw9U2VX33ftsm4gDnPMnRrXXXIUBKgeKDanorwqjm5hyjVGHji949cK2gJaTBxNM7R2FTmByTdq2V9bDmtbLnRMxQRKE0jcqYnKGBsuHLrmeINtOo9baoFHgwUK6OtneT7desfsSh8+d0nF4vZu9v+d8dc9RScnqCiDPzgw/zuth+Omsg6hKWMGA2Y683sD9n57aBdrwq0kYy0xx1mQu/qYgdQzzcv+HQM1S31uermuHNESqhtTrmfbGGleHbP27Kw2jTk/zfsH96wQ8o5XLhunnHps9KPoFWYZI3fNR4oi1i8WUp3htl9xFIahPEdW62oA9+YrCzpuFqkacQJaYl8weIRzyw+EdDWdb0ZwE9t3HvdI5jNNd+3ehYzP1tn3EgC9/NAn9/G96IKh1wtm5BqtDXj5X0ZsRS5QOMRVre/VTjafdKxkd7ZHul3RSXRSxLM3ZNv7xu7DWUsNaDwk4A6GO2AfE4pwOcVUu158euIP1uxjKtxwcf0ttJJbYZvd7t6K6k+yae9TPhkqlacmzCuy5I1g+m7B3n4nPxVGF0N+XqaEb9l+R9UdpCm
9+
sidebar_class_name: "post api-method"
10+
info_path: developers/api/api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Register Developer App API Key"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/developer-apps/{address}/register-api-key"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Register api_key and api_secret in api_keys table for developer apps created via entity manager transactions. Use when the client sends raw ManageEntity tx instead of POST /developer-apps. Inserts with rps=10, rpm=500000. Requires the app to exist in developer_apps and belong to the authenticated user.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"user_id","in":"query","description":"The user ID of the user who owns the developer app","required":true,"schema":{"type":"string"}},{"name":"address","in":"path","description":"Developer app address (API key)","required":true,"schema":{"type":"string"}}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"x-codegen-request-body-name":"metadata","required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_secret"],"properties":{"api_secret":{"type":"string","description":"The API secret (private key hex) for the developer app"}},"title":"register_api_key_request_body"}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"API key registered successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the registration was successful"}},"title":"register_api_key_response"}}}},"400":{"description":"Bad request (api_secret required)","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Developer app not found","content":{}},"500":{"description":"Server error","content":{}}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/docs/developers/api/sidebar.generated.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -957,6 +957,12 @@ const sidebar = {
957957
label: "Update Developer App",
958958
className: "api-method put",
959959
},
960+
{
961+
type: "doc",
962+
id: "developers/api/register-developer-app-api-key",
963+
label: "Register Developer App API Key",
964+
className: "api-method post",
965+
},
960966
{
961967
type: "doc",
962968
id: "developers/api/deactivate-developer-app-access-key",

‎docs/docs/developers/api/sidebar.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -958,6 +958,12 @@ const sidebar: SidebarsConfig = {
958958
label: "Update Developer App",
959959
className: "api-method put",
960960
},
961+
{
962+
type: "doc",
963+
id: "developers/api/register-developer-app-api-key",
964+
label: "Register Developer App API Key",
965+
className: "api-method post",
966+
},
961967
{
962968
type: "doc",
963969
id: "developers/api/deactivate-developer-app-access-key",

‎docs/docs/developers/openapi.yaml‎

Lines changed: 83 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -690,6 +690,58 @@ paths:
690690
'500':
691691
description: Server error
692692
content: {}
693+
/developer-apps/{address}/register-api-key:
694+
post:
695+
tags:
696+
- developer_apps
697+
description: Register api_key and api_secret in api_keys table for developer
698+
apps created via entity manager transactions. Use when the client sends raw
699+
ManageEntity tx instead of POST /developer-apps. Inserts with rps=10,
700+
rpm=500000. Requires the app to exist in developer_apps and belong to the
701+
authenticated user.
702+
operationId: Register Developer App API Key
703+
security:
704+
- BasicAuth: []
705+
- BearerAuth: []
706+
parameters:
707+
- name: user_id
708+
in: query
709+
description: The user ID of the user who owns the developer app
710+
required: true
711+
schema:
712+
type: string
713+
- name: address
714+
in: path
715+
description: Developer app address (API key)
716+
required: true
717+
schema:
718+
type: string
719+
requestBody:
720+
x-codegen-request-body-name: metadata
721+
required: true
722+
content:
723+
application/json:
724+
schema:
725+
$ref: '#/components/schemas/register_api_key_request_body'
726+
responses:
727+
'200':
728+
description: API key registered successfully
729+
content:
730+
application/json:
731+
schema:
732+
$ref: '#/components/schemas/register_api_key_response'
733+
'400':
734+
description: Bad request (api_secret required)
735+
content: {}
736+
'401':
737+
description: Unauthorized
738+
content: {}
739+
'404':
740+
description: Developer app not found
741+
content: {}
742+
'500':
743+
description: Server error
744+
content: {}
693745
/developer-apps/{address}/access-keys/deactivate:
694746
post:
695747
tags:
@@ -11989,6 +12041,20 @@ components:
1198912041
type: string
1199012042
description: The ID of the user with a non-zero balance
1199112043
example: 7eP5n
12044+
register_api_key_request_body:
12045+
type: object
12046+
required:
12047+
- api_secret
12048+
properties:
12049+
api_secret:
12050+
type: string
12051+
description: The API secret (private key hex) for the developer app
12052+
register_api_key_response:
12053+
type: object
12054+
properties:
12055+
success:
12056+
type: boolean
12057+
description: Whether the registration was successful
1199212058
deactivate_access_key_request_body:
1199312059
type: object
1199412060
required:
@@ -13195,16 +13261,19 @@ components:
1319513261
data:
1319613262
$ref: '#/components/schemas/developer_app'
1319713263
remixes_response:
13198-
required:
13199-
- count
1320013264
type: object
1320113265
properties:
13202-
count:
13203-
type: integer
13204-
tracks:
13205-
type: array
13206-
items:
13207-
$ref: '#/components/schemas/track'
13266+
data:
13267+
type: object
13268+
required:
13269+
- count
13270+
properties:
13271+
count:
13272+
type: integer
13273+
tracks:
13274+
type: array
13275+
items:
13276+
$ref: '#/components/schemas/track'
1320813277
track:
1320913278
required:
1321013279
- access
@@ -14226,6 +14295,10 @@ components:
1422614295
type: string
1422714296
1000x1000:
1422814297
type: string
14298+
mirrors:
14299+
type: array
14300+
items:
14301+
type: string
1422914302
track_segment:
1423014303
required:
1423114304
- duration
@@ -15134,8 +15207,8 @@ components:
1513415207
type: string
1513515208
verified:
1513615209
type: boolean
15137-
profilePicture:
15138-
$ref: '#/components/schemas/profilePicture'
15210+
profile_picture:
15211+
$ref: '#/components/schemas/profile_picture'
1513915212
sub:
1514015213
type: string
1514115214
iat:
@@ -15169,15 +15242,6 @@ components:
1516915242
type: boolean
1517015243
description: Whether the account is in the user's in-app wallet
1517115244
example: true
15172-
profilePicture:
15173-
type: object
15174-
properties:
15175-
150x150:
15176-
type: string
15177-
480x480:
15178-
type: string
15179-
1000x1000:
15180-
type: string
1518115245
sales_json_content:
1518215246
type: object
1518315247
properties:

0 commit comments

Comments
 (0)