This documentation is for WSO2 Governance Registry 5.3.0. View documentation for the latest release.
||
Skip to end of metadata
Go to start of metadata

This section describes the REST URIs for working with the comments of a resource.

Query parameters

The following terms explain the meaning of the query parameters passed with the following REST URIs:

ParameterExplanation
pathPath of the resource
idIdentifier of the comment
startStart page number (optional)
sizeNumber of comments to be fetched (optional)

The {start page} and {number of records} can be any value greater than or equal to 0. The {start page} and {number of records} begin with 1. If both of them are 0, then all the comments are retrieved. Note that start and size are optional parameters and will default to 0 by default.

For details on security (the authorization header) and the URI syntax (port, context, etc.), see Registry REST API.

Get all comments on a resource

AttributesValues

HTTP Method                

GET
Request URI/comments?path={ resource path }&start={ start page }&size={ number of records }
HTTP Request HeaderAuthorization: Basic { base64encoded(username:password) }
DescriptionThis retrieves all the comments posted on the specific resource.
ResponseHTTP 200 OK
Response Typeapplication/json
Sample request

curl -X GET -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" "https://localhost:9443/resource/1.0.0/comments?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService" -i -k

 

Get a specific comment on a resource

AttributesValues

HTTP Method                

GET
Request URI/comment?path={ resource path }&id={ comment id }
HTTP Request HeaderAuthorization: Basic { base64encoded(username:password) }
DescriptionThis retrieves the specific comment associated with the given comment id.
ResponseHTTP 200 OK
Response Typeapplication/json
Sample request

curl -X GET -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" "https://localhost:9443/resource/1.0.0/comment?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService&id=1" -i -k

 

Add a comment to a resource

AttributesValues

HTTP Method                

POST
Request URI/comment?path={ resource path }
HTTP Request Header

Authorization: Basic { base64encoded(username:password) }

Content-Type: text/plain

PayloadComment appears in text format
DescriptionAdd the payload comment to the requested resource
ResponseHTTP 204 No Content
Response Typeapplication/json
Sample request

curl -X POST -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" -d 'Sample Comment' "https://localhost:9443/resource/1.0.0/comment?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService" -i -k

 

Update a comment on a resource

AttributesValues

HTTP Method                

PUT
Request URI/comment?path={ resource path }&id={ comment id}
HTTP Request Header

Authorization: Basic { base64encoded(username:password) }

Content-Type: text/plain

PayloadNew comment to be updated as TEXT.
DescriptionIt replaces the new comment for the given comment id
ResponseHTTP 204 No Content
Response Typeapplication/json
Sample request

curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" -d 'Sample 123' "https://localhost:9443/resource/1.0.0/comment?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService&id=2" -i -k

 

Delete a comment on a resource

AttributesValues

HTTP Method                

DELETE
Request URI/comment?path={ resource path }&id={ comment id}
HTTP Request HeaderAuthorization: Basic { base64encoded(username:password) }
ResponseHTTP 204 No Content
Response Typeapplication/json
Sample request

curl -X DELETE -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" -d 'Sample 123 sdfsdafsdfdsfdsasdf' "https://localhost:9443/resource/1.0.0/comment?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService&id=1" -i -k

  • No labels