US102307: Added swagger annotations for ACS Connectors APIs. #108
Conversation
| this.uaaClientSecret = other.uaaClientSecret; | ||
| } | ||
|
|
||
| @ApiModelProperty(value = "URL to a remote attribute store adapter", required = true) |
There was a problem hiding this comment.
Might be more clearly worded as "URL to retrieve attributes from"?
There was a problem hiding this comment.
Then it sounds like it's a URL to attribute store itself. How about "Adapter URL to retrieve attributes from"?
There was a problem hiding this comment.
Did we decide to change this or leave it? Latest rebase (4a2f699) doesn't show this line being changed.
There was a problem hiding this comment.
Missed it. Try again now.
| } | ||
|
|
||
| @ApiModelProperty( | ||
| value = "An OAuth client that coud be used to obtain an access token for this adapter", |
There was a problem hiding this comment.
Typo: coud -> could. Also might be more clearly worded as "OAuth client used to obtain an access token for this adapter"?
| this.uaaClientId = uaaClientId; | ||
| } | ||
|
|
||
| @ApiModelProperty(value = "A secret for an OAuth client for this adapter", required = true) |
There was a problem hiding this comment.
Might be more clearly worded as "OAuth client secret used to obtain an access token for this adapter"?
| import io.swagger.annotations.ApiModel; | ||
| import io.swagger.annotations.ApiModelProperty; | ||
|
|
||
| @ApiModel(description = "Connector configuration for external resource or subject atributes.") |
There was a problem hiding this comment.
Typo: atributes -> attributes
|
|
||
| private Set<AttributeAdapterConnection> adapters; | ||
|
|
||
| @ApiModelProperty(value = "A flag to enable or disable attribute connector. Disabled by default") |
There was a problem hiding this comment.
Might be more clearly worded as "A flag to enable or disable the retrieval of remote attributes. Disabled by default."?
| } | ||
|
|
||
| @ApiOperation( | ||
| value = "Deletes connector configururation for external subject attributes for the given zone.", |
There was a problem hiding this comment.
Typo: configururation -> configuration
| tags = { "Attribute Connector Management" }, | ||
| response = AttributeConnector.class) | ||
| @ApiResponses( | ||
| value = { @ApiResponse(code = 404, message = "Connector configuration for the given zone is not found.") }) |
There was a problem hiding this comment.
See comment above re. mentioning all possible response codes.
| response = AttributeConnector.class) | ||
| @ApiResponses( | ||
| value = { @ApiResponse( | ||
| code = 201, |
There was a problem hiding this comment.
See comment above re. mentioning all possible response codes.
| consumes = MediaType.APPLICATION_JSON_VALUE) | ||
| public ResponseEntity<AttributeConnector> putSubjectConnector(@RequestBody final AttributeConnector connector) { | ||
| consumes = MediaType.APPLICATION_JSON_VALUE, | ||
| produces = MediaType.APPLICATION_JSON_VALUE) |
There was a problem hiding this comment.
See comment above re. redundant produces field
There was a problem hiding this comment.
Good catch. I changed return type from ResponseEntity to ResponseEntity<?>
| this.maxCachedIntervalMinutes = maxCachedIntervalMinutes; | ||
| } | ||
|
|
||
| @ApiModelProperty(value = "A set of attribute store adapters associated with this connector", required = true) |
There was a problem hiding this comment.
Might be more clearly worded as "A set of adapters used to retrieve attributes from"? Also should we mention here or in a controller-related Swagger annotation that only one adapter is currently supported?
|
Addressed pull request comments. Please review |
| import io.swagger.annotations.ApiOperation; | ||
| import io.swagger.annotations.ApiParam; | ||
| import io.swagger.annotations.ApiResponse; | ||
| import io.swagger.annotations.ApiResponses;; |
There was a problem hiding this comment.
Remove extra semicolon?
|
@irinaepshteyn please merge once PR integration tests pass |
No description provided.