#community-help

Live GraphQL Endpoint for TypeSense API Conversion

TLDR Paul is trying to convert TypeSense API to GraphQL and wants a live endpoint for a better schema. Jason suggests forking the openapi spec and adding their document structure.

3mo

Join the chat

Jun 13, 2023 (3 months ago)

Photo of md5-38acaeddf8807738f5b4d355349769fd

Paul

09:24 AM

Hi there! I’m trying to convert the TypeSense API to GraphQL with GraphQL Mesh and that seems to be going well. However the spec https://github.com/typesense/typesense-api-spec/blob/master/openapi.yml isn’t ‘live’, as in: It doesn’t describe the fields, etc. of the documents. Might it be possible to get a ‘live’ endpoint that also describes all possible schema’s?

The way it works, is that the GraphQL Mesh openapi handler will automatically convert any written openapi specification to a fully compatible GraphQL schema. If the Openapi schema is describing the current API sufficiently enough it will expose everything to GraphQL.

Is that something you guys might be interested in?

Photo of md5-4e872368b2b2668460205b409e95c2ea

Kishore Nallan

10:32 AM

Hi Paul, can you please elaborate what you mean by "doesn't describe the fields"?

Paul

11:19 AM

It would specifically be amazing if this could be more detailed: https://github.com/typesense/typesense-api-spec/blob/master/openapi.yml#L1440 So the type of actual possible documents are exposed.

Photo of md5-8813087cccc512313602b6d9f9ece19f

Jason

02:50 PM

Documents are fully user-defined key-value pairs… since users can store any JSON objects in Typesense

Jun 14, 2023 (3 months ago)

Paul

10:16 AM

Yeah I understand that but ‘user defined’ usually means ‘backend developer defined’, woud be nice if a ‘frontend developer’ could get the expected document structure, wouldn’t it?

Jason

04:34 PM

I see… You’d essentially have to fork that openapi spec and add your documents’ structure to it

Jun 15, 2023 (3 months ago)

Paul

10:40 AM

Yeah, that is the plan right now. But if it was exposed from a typesense instance it could do that automatically

Typesense

Lightning-fast, open source search engine for everyone | Knowledge Base powered by Struct.AI

Indexed 2779 threads (79% resolved)

Join Our Community Manage subscription

Similar Threads

Resolving Issues with Scoped API Keys in Typesense with Golang

Suvarna had problems with generating and using scoped API keys in Typesense with Golang. Several bugs misleading the user were found and fixed by Kishore Nallan.

158

26mo

Discussing Features for Typesense Cloud Dashboard

Stephano expressed the need for a Typesense Cloud dashboard to manage collections. Jason confirmed its development, also including features like editing and deleting items. James and Mica added comments about API key management and self-hosted Typesense compatibility.

30mo

Handling Large JSON File for Typesense

Matt struggled with processing a large JSON file for Typesense. Kishore Nallan explained how to create a schema, convert to JSONL, and import the file. They also identified the necessary keys from the JSON.

6mo