typesense-api-spec
typesense-api-spec copied to clipboard
typesense
Contains the API specs for the Typesense HTTP API
## Description The OpenAPI spec is incorrect. Multi search does not have a required parameter for search. https://github.com/typesense/typesense-api-spec/blob/b76b640b94e93a80777e3a58bbe930e2a7bb88ef/openapi.yml#L1180-L1185 This is a screen shot from the example: There is no `search`...
## Change Summary Fixed https://github.com/typesense/typesense-api-spec/issues/51 Seems that this was copied from the single search by mistake ## PR Checklist - [x] I have read and signed the [Contributor License Agreement](https://forms.gle/PZyiY5N2GDQU8GsV9).
## Description The response HTTP status code, as shown below in line 62, in the `openapi.yml` file should be quoted: ```yaml 61 responses: 62 200: 63 description: List of all...
## Description ## Steps to reproduce ``` $ cd /tmp $ wget https://raw.githubusercontent.com/typesense/typesense-api-spec/master/openapi.yml $ npx @redocly/cli lint openapi.yml ``` ## Expected Behavior There should not be any errors or warnings....
## Change Summary This PR introduces a new `SearchHighlightV2` type which is used for the `SearchResultHit#highlight` field. I've opened this as a draft as this version of the spec doesn't...
## Description The `highlight` field doesn't have associated object type whereas the old `highlights` field had those. ## Expected Behavior Highlight would be `object` with keys of field names and...
## Change Summary ## PR Checklist - [x] I have read and signed the [Contributor License Agreement](https://forms.gle/PZyiY5N2GDQU8GsV9).
## Change Summary ~And also make the `q` and `query_by` in `SearchParameters` optional in favor of presets~ ## PR Checklist - [x] I have read and signed the [Contributor License...
https://github.com/typesense/typesense-api-spec/blob/7ce239ed8fe9a9383547203199ee8b1ef1a0f0fb/openapi.yml#L1741-L1757 https://typesense.org/docs/26.0/api/vector-search.html#using-openai-compatible-apis
https://github.com/typesense/typesense-api-spec/blob/7ce239ed8fe9a9383547203199ee8b1ef1a0f0fb/openapi.yml#L1689-L1757 https://typesense.org/docs/26.0/api/collections.html#field-parameters