https://github.com/typesense/typesense-api-spec

Contains the API specs for the Typesense HTTP API
https://github.com/typesense/typesense-api-spec

openapi-spec typesense

Last synced: 3 months ago
JSON representation

Contains the API specs for the Typesense HTTP API

• Host: GitHub
• URL: https://github.com/typesense/typesense-api-spec
• Owner: typesense
• Created: 2018-01-02T03:12:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T20:21:17.000Z (3 months ago)
• Last Synced: 2024-10-28T21:25:22.185Z (3 months ago)
• Topics: openapi-spec, typesense
• Homepage:
• Size: 2.7 MB
• Stars: 16
• Watchers: 6
• Forks: 26
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Typesense API Specs

This repository contains the API specs for the Typesense HTTP API.

Some of the client libraries use the specs from this repo to generate types.

## Usage

You can use Swagger Editor to view/edit the API spec files.

Clone this repo, and then from the root of this repo, run:

```bash

docker run -p 8080:8080 -v $(pwd):/tmp -e SWAGGER_FILE=/tmp/openapi.yml swaggerapi/swagger-editor

```

Now visit [http://localhost:8080](http://localhost:8080) in your browser to view the spec file in your browser.

Once you've made edits, click on File -> Save as YAML. Then copy that file into this repo and rename the file to use a `.yml` extension.