Skip to content

Use security requirement names from spec #30

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

Merged
merged 1 commit into from
Aug 20, 2018
Merged

Use security requirement names from spec #30

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
14 changes: 10 additions & 4 deletions ...pi-gradle-plugin/src/main/kotlin/com/epages/restdocs/openapi/gradle/OpenApi20Generator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,6 @@ internal object OpenApi20Generator {
description = firstModelForPathAndMethod.description
consumes = modelsWithSamePathAndMethod.map { it.request.contentType }.distinct().filterNotNull().nullIfEmpty()
produces = modelsWithSamePathAndMethod.map { it.response.contentType }.distinct().filterNotNull().nullIfEmpty()
if (firstModelForPathAndMethod.request.securityRequirements != null) {
addSecurity(firstModelForPathAndMethod.request.securityRequirements.type.name,
securityRequirements2ScopesList(firstModelForPathAndMethod.request.securityRequirements))
}
parameters =
extractPathParameters(firstModelForPathAndMethod).plus(
firstModelForPathAndMethod.request.requestParameters.map {
Expand All @@ -180,6 +176,16 @@ internal object OpenApi20Generator {
responses = responsesByStatusCode(modelsWithSamePathAndMethod)
.mapValues { responseModel2Response(it.value) }
.nullIfEmpty()
}.apply {
if (firstModelForPathAndMethod.request.securityRequirements != null) {
val openApiSecurityType = when (firstModelForPathAndMethod.request.securityRequirements.type) {
SecurityType.OAUTH2 -> "oauth2"
SecurityType.API_KEY -> "apiKey"
SecurityType.BASIC -> "basic"
}
addSecurity(openApiSecurityType,
securityRequirements2ScopesList(firstModelForPathAndMethod.request.securityRequirements))
}
}
}

Expand Down
22 changes: 14 additions & 8 deletions ...radle-plugin/src/test/kotlin/com/epages/restdocs/openapi/gradle/OpenApi20GeneratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,20 +131,24 @@ class OpenApi20GeneratorTest {
val successfulGetProductModel = api[0]
val responseHeaders = successfulGetProductModel.response.headers
val productPath = openapi.paths.getValue(successfulGetProductModel.request.path)
val successfulGetResponse = productPath.get.responses.get(successfulGetProductModel.response.status.toString())
val successfulGetResponse = productPath.get.responses[successfulGetProductModel.response.status.toString()]

then(openapi.basePath).isNull()
then(productPath).isNotNull
then(openapi.basePath).isNull()
then(productPath.get.consumes).contains(successfulGetProductModel.request.contentType)

then(productPath.get.security).hasSize(1)
then(productPath.get.security.first().keys).containsOnly("oauth2")
then(productPath.get.security.first()["oauth2"]).isEqualTo(listOf("prod:r"))

then(successfulGetResponse).isNotNull
then(successfulGetResponse!!.headers).isNotNull
for (header in responseHeaders) {
then(successfulGetResponse.headers.get(header.name)!!).isNotNull
then(successfulGetResponse.headers.get(header.name)!!.description).isEqualTo(header.description)
then(successfulGetResponse.headers.get(header.name)!!.type).isEqualTo(header.type.toLowerCase())
}
then(productPath.get.security[0].get("OAUTH2"))
.isEqualTo(successfulGetProductModel.request.securityRequirements!!.requiredScopes)

then(successfulGetResponse
.examples.get(successfulGetProductModel.response.contentType)).isEqualTo(successfulGetProductModel.response.example)
thenParametersForGetMatch(productPath.get.parameters, successfulGetProductModel.request)
Expand Down Expand Up @@ -212,11 +216,13 @@ class OpenApi20GeneratorTest {

then(productPath).isNotNull
then(productPath.delete.consumes).isNull()
then(productPath.delete.responses.get(successfulDeleteProductModel.response.status.toString())).isNotNull
then(productPath.delete.security[0].get("OAUTH2"))
then(productPath.delete.responses[successfulDeleteProductModel.response.status.toString()]).isNotNull
then(productPath.delete.security.first()["oauth2"])
.isEqualTo(successfulDeleteProductModel.request.securityRequirements!!.requiredScopes)
then(productPath.delete.responses.get(successfulDeleteProductModel.response.status.toString())!!
.examples.get(successfulDeleteProductModel.response.contentType)).isEqualTo(successfulDeleteProductModel.response.example)
then(
productPath.delete.responses[successfulDeleteProductModel.response.status.toString()]!!
.examples[successfulDeleteProductModel.response.contentType]
).isEqualTo(successfulDeleteProductModel.response.example)
}

private fun givenGetProductResourceModel(): List<ResourceModel> {
Expand Down