Skip to content

Commit

Permalink
feat: remove endpoints scheduled for deletion + update lamb2 API (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hugo Arregui authored May 10, 2023
1 parent 7d8f871 commit 9cf2bab
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 126 deletions.
10 changes: 4 additions & 6 deletions openapi/catalyst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,6 @@ paths:
$ref: paths/content/content@status.yaml
/lambdas/status:
$ref: paths/lambdas/lambdas@status.yaml
/lambdas/health:
$ref: paths/lambdas/lambdas@health.yaml
/lambdas/collections:
$ref: paths/lambdas/lambdas@collections.yaml
/lambdas/collections/contents/{urn}/thumbnail:
Expand All @@ -100,13 +98,13 @@ 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}:
/lambdas/nfts/users/{address}/wearables:
$ref: 'paths/lambdas/lambdas@nfts@wearables@{address}.yaml'
/lambdas/nfts/emotes/{address}:
/lambdas/nfts/users/{address}/emotes:
$ref: 'paths/lambdas/lambdas@nfts@emotes@{address}.yaml'
/lambdas/nfts/names/{address}:
/lambdas/nfts/users/{address}/names:
$ref: 'paths/lambdas/lambdas@nfts@names@{address}.yaml'
/lambdas/nfts/lands/{address}:
/lambdas/nfts/users/{address}/lands:
$ref: 'paths/lambdas/lambdas@nfts@lands@{address}.yaml'
/lambdas/collections/wearables:
$ref: 'paths/lambdas/lambdas@collections@wearables.yaml'
Expand Down
7 changes: 0 additions & 7 deletions openapi/components/examples/lambdas/200-health.json

This file was deleted.

7 changes: 0 additions & 7 deletions openapi/components/examples/lambdas/503-health.json

This file was deleted.

8 changes: 0 additions & 8 deletions openapi/components/schemas/lambdas/200-health.yaml

This file was deleted.

8 changes: 0 additions & 8 deletions openapi/components/schemas/lambdas/503-health.yaml

This file was deleted.

27 changes: 12 additions & 15 deletions openapi/lambdas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ openapi: 3.0.3
info:
title: API Specification for the Decentraland Catalyst Lambdas Service
version: '1.0'
description: >-
description: >-
The current specification details the Lambdas service
x-logo:
url: 'https://cryptologos.cc/logos/decentraland-mana-logo.png'
license:
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html

servers:
- url: 'https://peer.decentraland.zone/lambdas'
description: Catalyst Development instance
Expand All @@ -19,21 +19,19 @@ servers:
description: First production Catalyst node
tags:
- name: Lambdas
description: >-
This service provides a set of utilities required by the Catalyst Server Clients\Consumers in order to
retrieve or validate data.
description: >-
This service provides a set of utilities required by the Catalyst Server Clients\Consumers in order to
retrieve or validate data.
paths:
/status:
$ref: paths/lambdas/lambdas@status.yaml
/health:
$ref: paths/lambdas/lambdas@health.yaml
/collections:
$ref: paths/lambdas/lambdas@collections.yaml
$ref: paths/lambdas/lambdas@collections.yaml
/collections/contents/{urn}/thumbnail:
$ref: 'paths/lambdas/lambdas@collections@contents@{urn}@thumbnail.yaml'
$ref: 'paths/lambdas/lambdas@collections@contents@{urn}@thumbnail.yaml'
/collections/contents/{urn}/image:
$ref: 'paths/lambdas/lambdas@collections@contents@{urn}@image.yaml'
$ref: 'paths/lambdas/lambdas@collections@contents@{urn}@image.yaml'
/collections/standard/erc721/{chainId}/{contract}/{option}/{emission}:
$ref: 'paths/lambdas/lambdas@collections@standard@erc721@{chainId}@{contract}@{option}@{emission}.yaml'
/collections/wearables:
Expand All @@ -45,8 +43,8 @@ paths:
/collections/emotes-by-owner/{address}:
$ref: 'paths/lambdas/lambdas@collections@emotes-by-owner@{address}.yaml'
/contentv2/scenes:
$ref: 'paths/lambdas/lambdas@contentv2@scenes.yaml'
/contentv2/parcel_info:
$ref: 'paths/lambdas/lambdas@contentv2@scenes.yaml'
/contentv2/parcel_info:
$ref: 'paths/lambdas/lambdas@contentv2@parcel_info.yaml'
/contentv2/contents/{cid}:
$ref: 'paths/lambdas/lambdas@contentv2@contents@{cid}.yaml'
Expand All @@ -56,7 +54,7 @@ paths:
$ref: 'paths/lambdas/lambdas@contracts@pois.yaml'
/contracts/denylisted-names:
$ref: 'paths/lambdas/lambdas@contracts@denylisted-names.yaml'
/crypto/validate-signature:
/crypto/validate-signature:
$ref: 'paths/lambdas/lambdas@crypto@validate-signature.yaml'
/explore/hot-scenes:
$ref: 'paths/lambdas/lambdas@explore@hot-scenes.yaml'
Expand All @@ -68,4 +66,3 @@ paths:
$ref: 'paths/lambdas/lambdas@profiles@{id}.yaml'
/third-party-integrations:
$ref: 'paths/lambdas/lambdas@third-party-integrations.yaml'

26 changes: 0 additions & 26 deletions openapi/paths/lambdas/lambdas@health.yaml

This file was deleted.

18 changes: 9 additions & 9 deletions openapi/paths/lambdas/lambdas@nfts@emotes@{address}.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
get:
get:
operationId: getPaginatedEmotes
summary: Get list of emotes for an address
tags:
Expand All @@ -10,36 +10,36 @@ get:
schema:
type: string
example: 'urn:decentraland:matic:collections-thirdparty:ntr1-meta:ntr1-meta-1ef79e7b'
description: >-
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
name: includeEntities
schema:
type: boolean
example: true
description: >-
If present, response will be extended with the definition data.
description: >-
If present, response will be extended with the entity data.
- in: path
name: address
required: true
schema:
type: string
example: '0xf4f7512c68f358856514cd4e449fc6c5ac04bb15'
description: >-
description: >-
Ethereum address from which you want to get the list of emotes
- in: query
name: pageNum
schema:
type: string
example: "1"
description: >-
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: >-
description: >-
The size of the requested page. It needs `pageNum` to be present to enable a paginated response.
responses:
Expand All @@ -53,4 +53,4 @@ get:
default:
$ref: ../../components/examples/lambdas/200-emotes-paginated.json
'500':
description: 'Failed to fetch emotes for the address'
description: 'Failed to fetch emotes for the address'
22 changes: 11 additions & 11 deletions openapi/paths/lambdas/lambdas@nfts@wearables@{address}.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
get:
get:
operationId: getPaginatedWearables
summary: Get list of wearables for an address
tags:
Expand All @@ -11,49 +11,49 @@ get:
schema:
type: string
example: '0xa87d168717538e86d71ac48baccaeb84162de602'
description: >-
description: >-
Ethereum address from which you want to get the list of wearables
- in: query
name: collectionId
schema:
type: string
example: 'urn:decentraland:matic:collections-thirdparty:ntr1-meta:ntr1-meta-1ef79e7b'
description: >-
description: >-
Third Party collection Id to filter wearables, if this param is not sent then the 3rd parties wearables are not shown. If it is sent, only the 3rd parties wearables are shown.
- in: query
name: includeDefinitions
name: includeEntities
schema:
type: boolean
example: true
description: >-
If present, response will be extended with the definition data.
description: >-
If present, response will be extended with the entity data.
- in: query
name: includeThirdParty
schema:
type: boolean
example: true
description: >-
description: >-
If present, response will include the third-party wearables owned by the address. They will appear before other wearables if the response is paginated.
- in: query
name: pageNum
schema:
type: string
example: "1"
description: >-
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: >-
description: >-
The size of the requested page. It needs `pageNum` to be present to enable a paginated response.
- in: query
name: orderBy
schema:
type: string
example: rarity
description: >-
description: >-
Determines the field to be sort by. By default it will be by `transferredAt`. Possible values: `transferredAt` and `rarity`.
responses:
Expand All @@ -67,4 +67,4 @@ get:
default:
$ref: ../../components/examples/lambdas/200-wearables-paginated.json
'500':
description: 'Failed to fetch wearables for the address'
description: 'Failed to fetch wearables for the address'
32 changes: 3 additions & 29 deletions openapi/paths/lambdas/lambdas@profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,17 @@ post:
description: Returns all the Avatars details associated with the Ethereum addresses in the body
requestBody:
description: >-
The body only has the `ids` property representing a list of Ethereum addresses
The body only has the `ids` property representing a list of Ethereum addresses
content:
application/json; charset=utf-8:
schema:
$ref: ../../components/schemas/lambdas/post-profiles.yaml
$ref: ../../components/schemas/lambdas/post-profiles.yaml
examples:
default:
$ref: ../../components/examples/lambdas/post-profiles.json
responses:
'200':
description: Array of Avatars
content:
application/json:
schema:
$ref: ../../components/schemas/lambdas/200-profiles-ids.yaml
examples:
default:
$ref: ../../components/examples/lambdas/200-profiles-ids.json

get:
deprecated: true
operationId: getAvatarsDetails
summary: Get Avatars details
tags:
- Lambdas
description: Given a list of Ethereum address of a user, return all the Avatars details associated with them.
parameters:
- in: query
name: id
required: true
schema:
type: array
example: '0x22480812a9a0669783c06d359182a583bd1d9fc2'
description: List of Ethereum addresses of the users that you want to retrieve the profiles
responses:
'200':
description: Array of Avatars
description: Array of Avatars
content:
application/json:
schema:
Expand Down

0 comments on commit 9cf2bab

Please sign in to comment.