Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Limit the depth when openapi params reference itself #229

Merged
merged 1 commit into from
Dec 1, 2024
Merged

Limit the depth when openapi params reference itself #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/scans.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ jobs:
"simple_api_key.openapi.json",
"simple_http_bearer_jwt.openapi.json",
"simple_http_bearer.openapi.json",
"complex.openapi.json",
]

steps:
Expand Down
3 changes: 1 addition & 2 deletions openapi/operation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ func GetOperationPath(p string, params openapi3.Parameters) (string, error) {
if v.Value.In != "path" {
continue
}

subs[v.Value.Name] = getSchemaValue(v.Value.Schema.Value)
subs[v.Value.Name] = getSchemaValue(v.Value.Schema.Value, 0)
}

return stduritemplate.Expand(p, subs)
Expand Down
18 changes: 13 additions & 5 deletions openapi/param.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
"github.com/getkin/kin-openapi/openapi3"
)

const maximumDepth = 4

func getParameterValue(param *openapi3.Parameter) string {
if param.Schema != nil {
value := getSchemaValue(param.Schema.Value)
value := getSchemaValue(param.Schema.Value, 0)
switch {
case param.Schema.Value.Type.Is("string"):
return value.(string)
Expand Down Expand Up @@ -66,7 +68,7 @@
if requestBody.Content != nil {
for mediaType, mediaTypeValue := range requestBody.Content {
if mediaTypeValue.Schema != nil {
body := getSchemaValue(mediaTypeValue.Schema.Value)
body := getSchemaValue(mediaTypeValue.Schema.Value, 0)
switch mediaType {
case "application/json":
return mapRequestBodyFakeValueToJSON(mediaTypeValue.Schema.Value, body), "application/json"
Expand All @@ -80,7 +82,7 @@
return bytes.NewBuffer(nil), ""
}

func getSchemaValue(schema *openapi3.Schema) interface{} {
func getSchemaValue(schema *openapi3.Schema, depth int) interface{} {
if schema.Example != nil {
return schema.Example
} else if len(schema.Enum) > 0 {
Expand All @@ -94,11 +96,17 @@
case schema.Type.Is("boolean"):
return gofakeit.Bool()
case schema.Type.Is("array"):
return []interface{}{getSchemaValue(schema.Items.Value)}
if depth > maximumDepth {
return []interface{}{}
}

Check warning on line 101 in openapi/param.go

View check run for this annotation

Codecov / codecov/patch

openapi/param.go#L100-L101 

Added lines #L100 - L101 were not covered by tests
return []interface{}{getSchemaValue(schema.Items.Value, depth+1)}
case schema.Type.Is("object"):
object := map[string]interface{}{}
if depth > maximumDepth {
return object
}
for key, value := range schema.Properties {
object[key] = getSchemaValue(value.Value)
object[key] = getSchemaValue(value.Value, depth+1)
}
return object
case schema.Type.Is("string"):
Expand Down
14 changes: 14 additions & 0 deletions openapi/param_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,3 +265,17 @@ func TestGetSchemaValue_WhenRequestBodyParametersWithObjectExampleAndArrayExampl
assert.NotNil(t, operations[0].Body)
assert.Equal(t, expected, operations[0].Body)
}

func TestRecursiveParameters(t *testing.T) {
openapiContract, operr := openapi.LoadFromData(
context.Background(),
[]byte(`{"openapi":"3.0.2","servers":[{"url":"http://localhost:8080"}],"paths":{"/":{"post":{"summary":"Create an item","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"responses":{"201":{"description":"Item created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}}}}}},"components":{"schemas":{"Item":{"type":"object","properties":{"details":{"type":"object","properties":{"description":{"type":"string"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}}}},"Attribute":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"subAttributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}}}}}}`),
)

securitySchemesMap, _ := openapiContract.SecuritySchemeMap(openapi.NewEmptySecuritySchemeValues())
operations, err := openapiContract.Operations(nil, securitySchemesMap)

assert.NoError(t, operr)
assert.NoError(t, err)
assert.NotNil(t, operations[0].Body)
}
155 changes: 155 additions & 0 deletions test/stub/complex.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
{
"openapi": "3.0.2",
"info": {
"title": "Complex API",
"description": "API with complex and recursive parameters",
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost:8080"
}
],
"paths": {
"/": {
"get": {
"summary": "Get items",
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
}
}
}
}
}
},
"security": [
{
"bearer_auth": []
},
{
"api_key_auth": []
}
]
},
"post": {
"summary": "Create an item",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"responses": {
"201": {
"description": "Item created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
}
},
"security": [
{
"bearer_auth": []
},
{
"api_key_auth": []
}
]
}
}
},
"components": {
"securitySchemes": {
"bearer_auth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"api_key_auth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key"
}
},
"schemas": {
"Item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"details": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
}
}
}
}
}
},
"Attribute": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"subAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
}
}
}
}
}
}
}