Skip to content

Fix invalid operationId in README example - #4

Closed
CryptAm wants to merge 1 commit into
ProjectOpenSea:mainfrom
CryptAm:patch-2
Closed

CryptAm wants to merge 1 commit into
ProjectOpenSea:mainfrom
CryptAm:patch-2

Conversation

@CryptAm

@CryptAm CryptAm commented Oct 3, 2026

Copy link
Copy Markdown

Motivation

The README usage example references an operation ID that does not exist in the current OpenAPI spec:

type ListingsResult = OperationResponse<"get_listings_1">;

Verification

Searched opensea-api.json for:

  • get_listings_1 — no matches found
  • list_listings_collection_all — found as the operationId for GET /api/v2/listings/collection/{slug}/all

The README example therefore uses a stale/invalid operation ID.

Solution

Replace get_listings_1 with the operation ID currently defined in opensea-api.json:

type ListingsResult = OperationResponse<"list_listings_collection_all">;

The README usage example references an operation ID that does not exist in the current OpenAPI spec:

```ts
type ListingsResult = OperationResponse<"get_listings_1">;
```

### Verification

Searched `opensea-api.json` for:

* `get_listings_1` — no matches found
* `list_listings_collection_all` — found as the `operationId` for `GET /api/v2/listings/collection/{slug}/all`

The README example therefore uses a stale/invalid operation ID.

### Change

Replace `get_listings_1` with the operation ID currently defined in `opensea-api.json`:

```ts
type ListingsResult = OperationResponse<"list_listings_collection_all">;
```

This keeps the README example consistent with the OpenAPI source of truth.
@ryanio

ryanio commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Thanks! Confirmed with a type-check, where get_listings_1 fails against the current spec. Recreated in ProjectOpenSea/opensea-devtools#789 (now merged) with you credited.

This repo is a read-only mirror, so we can't merge here, but we review every PR.

@ryanio ryanio closed this Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants