Skip to content

Commit d82ed66

Browse files
iwilltry42iwilltry42
authored
add: OpenAPI v2 tools support (#345)
When encountering OpenAPI v2 we just convert it to OpenAPI v3 (after transforming YAML to JSON if necessary) and the follow the same steps as before
1 parent 4a35d81 commit d82ed66

File tree

7 files changed

+512
-4
lines changed

7 files changed

+512
-4
lines changed

‎go.mod‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ require (
3030
golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc
3131
golang.org/x/sync v0.7.0
3232
golang.org/x/term v0.19.0
33+
gopkg.in/yaml.v3 v3.0.1
34+
sigs.k8s.io/yaml v1.4.0
3335
)
3436

3537
require (
@@ -80,7 +82,6 @@ require (
8082
golang.org/x/sys v0.19.0 // indirect
8183
golang.org/x/text v0.14.0 // indirect
8284
golang.org/x/tools v0.20.0 // indirect
83-
gopkg.in/yaml.v3 v3.0.1 // indirect
8485
gotest.tools/v3 v3.5.1 // indirect
8586
mvdan.cc/gofumpt v0.6.0 // indirect
8687
)

‎go.sum‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,3 +488,5 @@ mvdan.cc/gofumpt v0.6.0/go.mod h1:4L0wf+kgIPZtcCWXynNS2e6bhmj73umwnuXSZarixzA=
488488
rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
489489
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
490490
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
491+
sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
492+
sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=

‎pkg/loader/loader.go‎

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ import (
1212
"path"
1313
"path/filepath"
1414
"slices"
15+
"strconv"
1516
"strings"
1617
"time"
1718
"unicode/utf8"
1819

20+
"github.com/getkin/kin-openapi/openapi2"
21+
"github.com/getkin/kin-openapi/openapi2conv"
1922
"github.com/getkin/kin-openapi/openapi3"
2023
"github.com/gptscript-ai/gptscript/pkg/assemble"
2124
"github.com/gptscript-ai/gptscript/pkg/builtin"
@@ -24,6 +27,8 @@ import (
2427
"github.com/gptscript-ai/gptscript/pkg/parser"
2528
"github.com/gptscript-ai/gptscript/pkg/system"
2629
"github.com/gptscript-ai/gptscript/pkg/types"
30+
"gopkg.in/yaml.v3"
31+
kyaml "sigs.k8s.io/yaml"
2732
)
2833

2934
const CacheTimeout = time.Hour
@@ -142,9 +147,34 @@ func loadOpenAPI(prg *types.Program, data []byte) *openapi3.T {
142147
prg.OpenAPICache = map[string]any{}
143148
}
144149

145-
openAPIDocument, err = openapi3.NewLoader().LoadFromData(data)
146-
if err != nil || openAPIDocument.Paths.Len() == 0 {
147-
openAPIDocument = nil
150+
switch isOpenAPI(data) {
151+
case 2:
152+
// Convert OpenAPI v2 to v3
153+
jsondata := data
154+
if !json.Valid(data) {
155+
jsondata, err = kyaml.YAMLToJSON(data)
156+
if err != nil {
157+
return nil
158+
}
159+
}
160+
161+
doc := &openapi2.T{}
162+
if err := doc.UnmarshalJSON(jsondata); err != nil {
163+
return nil
164+
}
165+
166+
openAPIDocument, err = openapi2conv.ToV3(doc)
167+
if err != nil {
168+
return nil
169+
}
170+
case 3:
171+
// Use OpenAPI v3 as is
172+
openAPIDocument, err = openapi3.NewLoader().LoadFromData(data)
173+
if err != nil {
174+
return nil
175+
}
176+
default:
177+
return nil
148178
}
149179

150180
prg.OpenAPICache[openAPICacheKey] = openAPIDocument
@@ -399,3 +429,42 @@ func input(ctx context.Context, cache *cache.Client, base *source, name string)
399429

400430
return nil, fmt.Errorf("can not load tools path=%s name=%s", base.Path, name)
401431
}
432+
433+
// isOpenAPI checks if the data is an OpenAPI definition and returns the version if it is.
434+
func isOpenAPI(data []byte) int {
435+
var fragment struct {
436+
Paths map[string]any `json:"paths,omitempty"`
437+
Swagger string `json:"swagger,omitempty"`
438+
OpenAPI string `json:"openapi,omitempty"`
439+
}
440+
441+
if err := json.Unmarshal(data, &fragment); err != nil {
442+
if err := yaml.Unmarshal(data, &fragment); err != nil {
443+
return 0
444+
}
445+
}
446+
if len(fragment.Paths) == 0 {
447+
return 0
448+
}
449+
450+
if v, _, _ := strings.Cut(fragment.OpenAPI, "."); v != "" {
451+
ver, err := strconv.Atoi(v)
452+
if err != nil {
453+
log.Debugf("invalid OpenAPI version: openapi=%q", fragment.OpenAPI)
454+
return 0
455+
}
456+
return ver
457+
}
458+
459+
if v, _, _ := strings.Cut(fragment.Swagger, "."); v != "" {
460+
ver, err := strconv.Atoi(v)
461+
if err != nil {
462+
log.Debugf("invalid Swagger version: swagger=%q", fragment.Swagger)
463+
return 0
464+
}
465+
return ver
466+
}
467+
468+
log.Debugf("no OpenAPI version found in input data: openapi=%q, swagger=%q", fragment.OpenAPI, fragment.Swagger)
469+
return 0
470+
}

‎pkg/loader/loader_test.go‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ package loader
33
import (
44
"context"
55
"encoding/json"
6+
"os"
67
"testing"
78

9+
"github.com/gptscript-ai/gptscript/pkg/types"
810
"github.com/hexops/autogold/v2"
911
"github.com/stretchr/testify/require"
1012
)
@@ -17,6 +19,64 @@ func toString(obj any) string {
1719
return string(s)
1820
}
1921

22+
func TestIsOpenAPI(t *testing.T) {
23+
datav2, err := os.ReadFile("testdata/openapi_v2.yaml")
24+
require.NoError(t, err)
25+
v := isOpenAPI(datav2)
26+
require.Equal(t, 2, v, "(yaml) expected openapi v2")
27+
28+
datav2, err = os.ReadFile("testdata/openapi_v2.json")
29+
require.NoError(t, err)
30+
v = isOpenAPI(datav2)
31+
require.Equal(t, 2, v, "(json) expected openapi v2")
32+
33+
datav3, err := os.ReadFile("testdata/openapi_v3.yaml")
34+
require.NoError(t, err)
35+
v = isOpenAPI(datav3)
36+
require.Equal(t, 3, v, "(json) expected openapi v3")
37+
}
38+
39+
func TestLoadOpenAPI(t *testing.T) {
40+
numOpenAPITools := func(set types.ToolSet) int {
41+
num := 0
42+
for _, v := range set {
43+
if v.IsOpenAPI() {
44+
num++
45+
}
46+
}
47+
return num
48+
}
49+
50+
prgv3 := types.Program{
51+
ToolSet: types.ToolSet{},
52+
}
53+
datav3, err := os.ReadFile("testdata/openapi_v3.yaml")
54+
require.NoError(t, err)
55+
_, err = readTool(context.Background(), nil, &prgv3, &source{Content: datav3}, "")
56+
require.NoError(t, err, "failed to read openapi v3")
57+
require.Equal(t, 3, numOpenAPITools(prgv3.ToolSet), "expected 3 openapi tools")
58+
59+
prgv2json := types.Program{
60+
ToolSet: types.ToolSet{},
61+
}
62+
datav2, err := os.ReadFile("testdata/openapi_v2.json")
63+
require.NoError(t, err)
64+
_, err = readTool(context.Background(), nil, &prgv2json, &source{Content: datav2}, "")
65+
require.NoError(t, err, "failed to read openapi v2")
66+
require.Equal(t, 3, numOpenAPITools(prgv2json.ToolSet), "expected 3 openapi tools")
67+
68+
prgv2yaml := types.Program{
69+
ToolSet: types.ToolSet{},
70+
}
71+
datav2, err = os.ReadFile("testdata/openapi_v2.yaml")
72+
require.NoError(t, err)
73+
_, err = readTool(context.Background(), nil, &prgv2yaml, &source{Content: datav2}, "")
74+
require.NoError(t, err, "failed to read openapi v2 (yaml)")
75+
require.Equal(t, 3, numOpenAPITools(prgv2yaml.ToolSet), "expected 3 openapi tools")
76+
77+
require.EqualValuesf(t, prgv2json.ToolSet, prgv2yaml.ToolSet, "expected same toolset for openapi v2 json and yaml")
78+
}
79+
2080
func TestHelloWorld(t *testing.T) {
2181
prg, err := Program(context.Background(),
2282
"https://raw.githubusercontent.com/ibuildthecloud/test/bafe5a62174e8a0ea162277dcfe3a2ddb7eea928/example/sub/tool.gpt",

‎pkg/loader/testdata/openapi_v2.json‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "1.0.0",
5+
"title": "Swagger Petstore",
6+
"license": {
7+
"name": "MIT"
8+
}
9+
},
10+
"host": "petstore.swagger.io",
11+
"basePath": "/v1",
12+
"schemes": [
13+
"http"
14+
],
15+
"consumes": [
16+
"application/json"
17+
],
18+
"produces": [
19+
"application/json"
20+
],
21+
"paths": {
22+
"/pets": {
23+
"get": {
24+
"summary": "List all pets",
25+
"operationId": "listPets",
26+
"tags": [
27+
"pets"
28+
],
29+
"parameters": [
30+
{
31+
"name": "limit",
32+
"in": "query",
33+
"description": "How many items to return at one time (max 100)",
34+
"required": false,
35+
"type": "integer",
36+
"format": "int32"
37+
}
38+
],
39+
"responses": {
40+
"200": {
41+
"description": "An paged array of pets",
42+
"headers": {
43+
"x-next": {
44+
"type": "string",
45+
"description": "A link to the next page of responses"
46+
}
47+
},
48+
"schema": {
49+
"$ref": "#/definitions/Pets"
50+
}
51+
},
52+
"default": {
53+
"description": "unexpected error",
54+
"schema": {
55+
"$ref": "#/definitions/Error"
56+
}
57+
}
58+
}
59+
},
60+
"post": {
61+
"summary": "Create a pet",
62+
"operationId": "createPets",
63+
"tags": [
64+
"pets"
65+
],
66+
"responses": {
67+
"201": {
68+
"description": "Null response"
69+
},
70+
"default": {
71+
"description": "unexpected error",
72+
"schema": {
73+
"$ref": "#/definitions/Error"
74+
}
75+
}
76+
}
77+
}
78+
},
79+
"/pets/{petId}": {
80+
"get": {
81+
"summary": "Info for a specific pet",
82+
"operationId": "showPetById",
83+
"tags": [
84+
"pets"
85+
],
86+
"parameters": [
87+
{
88+
"name": "petId",
89+
"in": "path",
90+
"required": true,
91+
"description": "The id of the pet to retrieve",
92+
"type": "string"
93+
}
94+
],
95+
"responses": {
96+
"200": {
97+
"description": "Expected response to a valid request",
98+
"schema": {
99+
"$ref": "#/definitions/Pets"
100+
}
101+
},
102+
"default": {
103+
"description": "unexpected error",
104+
"schema": {
105+
"$ref": "#/definitions/Error"
106+
}
107+
}
108+
}
109+
}
110+
}
111+
},
112+
"definitions": {
113+
"Pet": {
114+
"required": [
115+
"id",
116+
"name"
117+
],
118+
"properties": {
119+
"id": {
120+
"type": "integer",
121+
"format": "int64"
122+
},
123+
"name": {
124+
"type": "string"
125+
},
126+
"tag": {
127+
"type": "string"
128+
}
129+
}
130+
},
131+
"Pets": {
132+
"type": "array",
133+
"items": {
134+
"$ref": "#/definitions/Pet"
135+
}
136+
},
137+
"Error": {
138+
"required": [
139+
"code",
140+
"message"
141+
],
142+
"properties": {
143+
"code": {
144+
"type": "integer",
145+
"format": "int32"
146+
},
147+
"message": {
148+
"type": "string"
149+
}
150+
}
151+
}
152+
}
153+
}

0 commit comments

Comments
 (0)