Tweak documentation

Signed-off-by: Andy Lo-A-Foe <andy.loafoe@gmail.com>

Author: loafoe

CHANGELOG.md

@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
+## v0.39.0
+- HSDP Notificatin support
+
 ## v0.38.1
 - Filter known sensitive fields form debug logs
 - Move cartel client to internal logger

README.md

@@ -16,7 +16,7 @@ The current implement covers only a subset of HSDP APIs. Basically we implement
   - [x] Device queries
   - [x] Application Resources management
   - [x] Device configuration management (firewall, logging)
-- [x] Public Key Infrastructe (PKI) management
+- [x] Public Key Infrastructure (PKI) management
 - [x] Identity and Access Management (IAM)
   - [x] Groups
   - [x] Organizations
@@ -44,6 +44,7 @@ The current implement covers only a subset of HSDP APIs. Basically we implement
 - [x] S3Creds Policy management
 - [x] DICOM Store
   - [x] Config management
+- [x] Notification service
 - [x] Hosted Application Streaming (HAS) management
 - [x] Service Discovery
 - [x] Console settings

notification/client.go

@@ -1,3 +1,4 @@
+// Package notification provides support for interacting with HSDP Notification services
 package notification
 
 import (
@@ -46,7 +47,7 @@ type Client struct {
 
 	notificationURL *url.URL
 
-	// User agent used when communicating with the HSDP Notification API.
+	// User agent used when communicating with the HSDP Notification API
 	UserAgent string
 
 	debugFile *os.File
@@ -58,8 +59,8 @@ type Client struct {
 	Topic        *TopicService
 }
 
-// NewClient returns a new HSDP Notification API client. Configured console and IAM clients
-// must be provided as the underlying API requires tokens from respective services
+// NewClient returns a new HSDP Notification API client. A configured IAM client
+// must be provided as the underlying API requires an IAM token
 func NewClient(iamClient *iam.Client, config *Config) (*Client, error) {
 	return newClient(iamClient, config)
 }
@@ -102,8 +103,7 @@ func (c *Client) Close() {
 	}
 }
 
-// SetNotificationURL sets the FHIR store URL for API requests to a custom endpoint. urlStr
-// should always be specified with a trailing slash.
+// SetNotificationURL sets the Notification URL for API requests
 func (c *Client) SetNotificationURL(urlStr string) error {
 	if urlStr == "" {
 		return ErrNotificationURLCannotBeEmpty

notification/publish.go

@@ -16,6 +16,7 @@ type PublishResponse struct {
 	TopicID      string `json:"topicId"`
 }
 
+// Publish publishes a message to a topic
 func (c *Client) Publish(request PublishRequest) (*PublishResponse, *Response, error) {
 	if err := c.validate.Struct(request); err != nil {
 		return nil, nil, err