Skip to content

Commit 5047c66

Browse files
committed
fix(schema): add missing examples to LDAP request body schema properties
Resolves oas3-missing-example vacuum lint violations that caused the 'Should be a completely valid schema' CI test to fail. Missing example values in request body schemas for: - /settings/ldap/test POST: add examples for bindPassword, tlsVerify, starttls - /settings/ldap/test-auth POST: add examples for serverUrl, bindDN, bindPassword, searchBase, userAttribute These 4 oas3-missing-example warnings caused vacuum lint to fail with --fail-severity=warn (-n=warn).
1 parent a29c8a2 commit 5047c66

2 files changed

Lines changed: 16 additions & 8 deletions

File tree

backend/schema/paths/settings/ldap/test-auth/post.json

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,24 @@
2828
"example": "hunter2"
2929
},
3030
"serverUrl": {
31-
"type": "string"
31+
"type": "string",
32+
"example": "ldap://dc.example.com"
3233
},
3334
"bindDN": {
34-
"type": "string"
35+
"type": "string",
36+
"example": "cn=svc,dc=example,dc=com"
3537
},
3638
"bindPassword": {
37-
"type": "string"
39+
"type": "string",
40+
"example": "s3cr3t"
3841
},
3942
"searchBase": {
40-
"type": "string"
43+
"type": "string",
44+
"example": "dc=example,dc=com"
4145
},
4246
"userAttribute": {
43-
"type": "string"
47+
"type": "string",
48+
"example": "uid"
4449
}
4550
}
4651
}

backend/schema/paths/settings/ldap/test/post.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,20 @@
2525
"example": "cn=svc,dc=example,dc=com"
2626
},
2727
"bindPassword": {
28-
"type": "string"
28+
"type": "string",
29+
"example": "s3cr3t"
2930
},
3031
"searchBase": {
3132
"type": "string",
3233
"example": "dc=example,dc=com"
3334
},
3435
"tlsVerify": {
35-
"type": "boolean"
36+
"type": "boolean",
37+
"example": true
3638
},
3739
"starttls": {
38-
"type": "boolean"
40+
"type": "boolean",
41+
"example": false
3942
}
4043
}
4144
}

0 commit comments

Comments
 (0)