polymathy 0.2.0

Turn search results into answers - a web service that fetches, chunks, and returns semantic content from search queries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# OpenAPI Specification

Polymathy provides an OpenAPI 3.0 specification for API integration.

## Accessing the Specification

The OpenAPI specification is available at:

```
http://localhost:8080/openapi.json
```

## Using the Specification

### Fetch with curl

```bash
curl http://localhost:8080/openapi.json | jq .
```

### Generate Client Code

Use tools like `openapi-generator` to create client libraries:

```bash
# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate Python client
openapi-generator-cli generate \
  -i http://localhost:8080/openapi.json \
  -g python \
  -o ./polymathy-python-client

# Generate TypeScript client
openapi-generator-cli generate \
  -i http://localhost:8080/openapi.json \
  -g typescript-fetch \
  -o ./polymathy-ts-client
```

## Interactive Documentation

Polymathy includes several interactive documentation UIs:

### Swagger UI

Available at `/swagger`

![Swagger UI](https://swagger.io/swagger/media/assets/images/swagger-ui.png)

Features:
- Try out API calls directly in the browser
- View request/response schemas
- Explore all endpoints

### ReDoc

Available at `/redoc`

Features:
- Clean, three-panel design
- Responsive layout
- Markdown support in descriptions

### RapiDoc

Available at `/rapidoc`

Features:
- Modern, customizable interface
- Dark/light themes
- API console for testing

### Scalar

Available at `/scalar`

Features:
- Beautiful modern design
- Code samples in multiple languages
- Interactive request builder

## Specification Example

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Polymath API",
    "description": "This is the polymath API",
    "version": "0.1.0"
  },
  "servers": [
    {
      "url": "/"
    }
  ],
  "paths": {
    "/v1/search": {
      "get": {
        "summary": "Process a query and return processed content",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```