Skip to content

Commit

Permalink
docs: add lambdos endpoints (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
manumena authored Feb 13, 2023
1 parent a756503 commit e7f154e
Show file tree
Hide file tree
Showing 15 changed files with 550 additions and 0 deletions.
8 changes: 8 additions & 0 deletions openapi/catalyst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,14 @@ paths:
$ref: 'paths/lambdas/lambdas@collections@contents@{urn}@image.yaml'
/lambdas/collections/standard/erc721/{chainId}/{contract}/{option}/{emission}:
$ref: 'paths/lambdas/lambdas@collections@standard@erc721@{chainId}@{contract}@{option}@{emission}.yaml'
/lambdas/nfts/wearables/{address}:
$ref: 'paths/lambdas/lambdas@nfts@wearables@{address}.yaml'
/lambdas/nfts/emotes/{address}:
$ref: 'paths/lambdas/lambdas@nfts@emotes@{address}.yaml'
/lambdas/nfts/names/{address}:
$ref: 'paths/lambdas/lambdas@nfts@names@{address}.yaml'
/lambdas/nfts/lands/{address}:
$ref: 'paths/lambdas/lambdas@nfts@lands@{address}.yaml'
/lambdas/collections/wearables:
$ref: 'paths/lambdas/lambdas@collections@wearables.yaml'
/lambdas/collections/wearables-by-owner/{address}:
Expand Down
25 changes: 25 additions & 0 deletions openapi/components/examples/lambdas/200-emotes-paginated.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"value": {
"emotes": [
{
"urn": "urn:decentraland:matic:collections-v2:0xa5b27856547a7d7c238b0e6c2de7a73556b915ba:0",
"amount": 1
},
{
"urn": "urn:decentraland:matic:collections-v2:0x7f26599ad1e9ad0ce6d47c5043d70d3bcd3d259a:0",
"amount": 1
},
{
"urn": "urn:decentraland:matic:collections-v2:0xeed6bdbdec460e258688e15816e8a9f760c3651a:0",
"amount": 1
},
{
"urn": "urn:decentraland:matic:collections-v2:0xa6c722476bdd17bf2adb65e96388345d83259f3b:0",
"amount": 1
}
],
"totalAmount": 973,
"pageNum": "3",
"pageSize": "4"
}
}
28 changes: 28 additions & 0 deletions openapi/components/examples/lambdas/200-lands-paginated.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"value": {
"lands": [
{
"name": "No rules red light",
"contractAddress": "0x959e104e1a4db6317fa58f8295f586e1a978c297",
"tokenId": "2178",
"category": "estate",
"description": "No rules red light",
"price": "13850000000000000000000",
"image": "https://api.decentraland.org/v1/estates/2178/map.png"
},
{
"name": null,
"contractAddress": "0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d",
"tokenId": "115792089237316195423570985008687907830471066081937686987411485309984659472358",
"category": "parcel",
"x": "-68",
"y": "-26",
"price": null,
"image": "https://api.decentraland.org/v1/parcels/-68/-26/map.png"
}
],
"totalAmount": 692,
"pageNum": "1",
"pageSize": "2"
}
}
33 changes: 33 additions & 0 deletions openapi/components/examples/lambdas/200-names-paginated.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"value": {
"names": [
{
"name": "Gojo",
"contractAddress": "0x2a187453064356c898cae034eaed119e1663acb8",
"tokenId": "115307283102801270656452808194409685445355100338904720773052040552422075323100",
"price": "25000000000000000000000"
},
{
"name": "Ugh",
"contractAddress": "0x2a187453064356c898cae034eaed119e1663acb8",
"tokenId": "109851145768931514038649521124955142005672037705020471158837454870244371101640",
"price": "20000000000000000000000"
},
{
"name": "Pain",
"contractAddress": "0x2a187453064356c898cae034eaed119e1663acb8",
"tokenId": "37860252415586502442474289153833538639704044038329376660459632788847982021683",
"price": "35000000000000000000000"
},
{
"name": "Hawks",
"contractAddress": "0x2a187453064356c898cae034eaed119e1663acb8",
"tokenId": "61045570331711729163571591712822027676157304898474053802260900686360273563216",
"price": "30000000000000000000000"
}
],
"totalAmount": 812,
"pageNum": "2",
"pageSize": "4"
}
}
93 changes: 93 additions & 0 deletions openapi/components/examples/lambdas/200-wearables-paginated.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{
"value": {
"wearables": [
{
"urn": "urn:decentraland:matic:collections-v2:0x6d83706836e820e79252edd48da419d2d03592d4:0",
"individualData": [
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-6407",
"tokenId": "6407",
"transferredAt": "1662738697",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-5452",
"tokenId": "5452",
"transferredAt": "1662738325",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-4497",
"tokenId": "4497",
"transferredAt": "1662737945",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-3542",
"tokenId": "3542",
"transferredAt": "1662737595",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-2587",
"tokenId": "2587",
"transferredAt": "1662737239",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-1632",
"tokenId": "1632",
"transferredAt": "1662736881",
"price": "10000000000000000000000000"
},
{
"id": "0x6d83706836e820e79252edd48da419d2d03592d4-677",
"tokenId": "677",
"transferredAt": "1662736515",
"price": "10000000000000000000000000"
}
],
"amount": 7
},
{
"urn": "urn:decentraland:matic:collections-v2:0x475abb52a7e925209b1334e52bfb62e1da9ebf62:1",
"individualData": [
{
"id": "0x475abb52a7e925209b1334e52bfb62e1da9ebf62-105312291668557186697918027683670432318895095400549111254310977681",
"tokenId": "105312291668557186697918027683670432318895095400549111254310977681",
"transferredAt": "1662040489",
"price": "1000000000000000000"
}
],
"amount": 1
},
{
"urn": "urn:decentraland:matic:collections-v2:0x710dce41dceace2f0e06c0cffee25fe65ad6f64c:0",
"individualData": [
{
"id": "0x710dce41dceace2f0e06c0cffee25fe65ad6f64c-339",
"tokenId": "339",
"transferredAt": "1662040423",
"price": "500000000000000000"
}
],
"amount": 1
},
{
"urn": "urn:decentraland:matic:collections-v2:0x293d1ae40b28c39d7b013d4a1fe3c5a8c016bf19:1",
"individualData": [
{
"id": "0x293d1ae40b28c39d7b013d4a1fe3c5a8c016bf19-105312291668557186697918027683670432318895095400549111254310977722",
"tokenId": "105312291668557186697918027683670432318895095400549111254310977722",
"transferredAt": "1662040329",
"price": "100000000000000000"
}
],
"amount": 1
}
],
"totalAmount": 23,
"pageNum": "2",
"pageSize": "4"
}
}
17 changes: 17 additions & 0 deletions openapi/components/schemas/lambdas/200-emotes-paginated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
type: object
properties:
emotes:
type: array
items:
type: object
properties:
urn:
type: string
amount:
type: number
totalAmount:
type: number
pageNum:
type: string
pageSize:
type: string
31 changes: 31 additions & 0 deletions openapi/components/schemas/lambdas/200-lands-paginated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
type: object
properties:
lands:
type: array
items:
type: object
properties:
name:
type: string
contractAddress:
type: string
tokenId:
type: string
price:
type: string
category:
type: string
x:
type: string
y:
type: string
image:
type: string
description:
type: string
totalAmount:
type: number
pageNum:
type: string
pageSize:
type: string
21 changes: 21 additions & 0 deletions openapi/components/schemas/lambdas/200-names-paginated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
type: object
properties:
names:
type: array
items:
type: object
properties:
name:
type: string
contractAddress:
type: string
tokenId:
type: string
price:
type: string
totalAmount:
type: number
pageNum:
type: string
pageSize:
type: string
30 changes: 30 additions & 0 deletions openapi/components/schemas/lambdas/200-wearables-paginated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
type: object
properties:
wearables:
type: array
items:
type: object
properties:
urn:
type: string
amount:
type: number
individualData:
type: array
items:
type: object
properties:
id:
type: string
tokenId:
type: string
transferredAt:
type: string
price:
type: string
totalAmount:
type: number
pageNum:
type: string
pageSize:
type: string
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
get:
operationId: getWearablesByOwner
deprecated: true
summary: Get list of wearables by owner
tags:
- Lambdas
Expand Down
56 changes: 56 additions & 0 deletions openapi/paths/lambdas/lambdas@nfts@emotes@{address}.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
get:
operationId: getPaginatedEmotes
summary: Get list of emotes for an address
tags:
- Lambdas
description: Get a list of emotes owned by the given address
parameters:
- in: query
name: collectionId
schema:
type: string
example: 'urn:decentraland:matic:collections-thirdparty:ntr1-meta:ntr1-meta-1ef79e7b'
description: >-
Third Party collection Id to filter emotes, if this param is not sent then the 3rd parties emotes are not shown. If it is sent, only the 3rd parties emotes are shown.
- in: query
name: includeDefinitions
schema:
type: boolean
example: true
description: >-
If present, response will be extended with the definition data.
- in: path
name: address
required: true
schema:
type: string
example: '0xf4f7512c68f358856514cd4e449fc6c5ac04bb15'
description: >-
Ethereum address from which you want to get the list of emotes
- in: query
name: pageNum
schema:
type: string
example: "1"
description: >-
The number of the requested page. It needs `pageSize` to be present to enable a paginated response.
- in: query
name: pageSize
schema:
type: string
example: "10"
description: >-
The size of the requested page. It needs `pageNum` to be present to enable a paginated response.
responses:
'200':
description: List of emotes owned by the given address
content:
application/json; charset=utf-8:
schema:
$ref: ../../components/schemas/lambdas/200-emotes-paginated.yaml
examples:
default:
$ref: ../../components/examples/lambdas/200-emotes-paginated.json
'500':
description: 'Failed to fetch emotes for the address'
Loading

0 comments on commit e7f154e

Please sign in to comment.