X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=dmaap-mediator-producer%2Fmain.go;h=65a84a2150b70fcfcf1daa95859daf61194e7354;hb=43b5864e8e5d8fad832c308301dd81ed02fbc2f5;hp=819ffa9d811ee143a8b4b109619ccaa799646dee;hpb=1b732d17463fad74721391b3a87a2a12172da63c;p=nonrtric.git

diff --git a/dmaap-mediator-producer/main.go b/dmaap-mediator-producer/main.go
index 819ffa9d..65a84a21 100644
--- a/dmaap-mediator-producer/main.go
+++ b/dmaap-mediator-producer/main.go
@@ -22,16 +22,21 @@ package main
 
 import (
 	"crypto/tls"
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"time"
 
+	"github.com/gorilla/mux"
 	log "github.com/sirupsen/logrus"
+	_ "oransc.org/nonrtric/dmaapmediatorproducer/api"
 	"oransc.org/nonrtric/dmaapmediatorproducer/internal/config"
 	"oransc.org/nonrtric/dmaapmediatorproducer/internal/jobs"
 	"oransc.org/nonrtric/dmaapmediatorproducer/internal/kafkaclient"
 	"oransc.org/nonrtric/dmaapmediatorproducer/internal/restclient"
 	"oransc.org/nonrtric/dmaapmediatorproducer/internal/server"
+
+	httpSwagger "github.com/swaggo/http-swagger"
 )
 
 var configuration *config.Config
@@ -41,6 +46,12 @@ func init() {
 	configuration = config.New()
 }
 
+// @title    DMaaP Mediator Producer
+// @version  1.1.0
+
+// @license.name  Apache 2.0
+// @license.url   http://www.apache.org/licenses/LICENSE-2.0.html
+
 func main() {
 	log.SetLevel(configuration.LogLevel)
 	log.Debug("Initializing DMaaP Mediator Producer")
@@ -87,20 +98,20 @@ func validateConfiguration(configuration *config.Config) error {
 	}
 	return nil
 }
-func registerTypesAndProducer(jobTypesHandler jobs.JobTypesManager, infoCoordinatorAddress string, callbackAddress string, client restclient.HTTPClient) error {
+func registerTypesAndProducer(jobTypesManager jobs.JobTypesManager, infoCoordinatorAddress string, callbackAddress string, client restclient.HTTPClient) error {
 	registrator := config.NewRegistratorImpl(infoCoordinatorAddress, client)
 	configTypes, err := config.GetJobTypesFromConfiguration("configs")
 	if err != nil {
 		return fmt.Errorf("unable to register all types due to: %v", err)
 	}
-	regErr := registrator.RegisterTypes(jobTypesHandler.LoadTypesFromConfiguration(configTypes))
+	regErr := registrator.RegisterTypes(jobTypesManager.LoadTypesFromConfiguration(configTypes))
 	if regErr != nil {
 		return fmt.Errorf("unable to register all types due to: %v", regErr)
 	}
 
 	producer := config.ProducerRegistrationInfo{
 		InfoProducerSupervisionCallbackUrl: callbackAddress + server.HealthCheckPath,
-		SupportedInfoTypes:                 jobTypesHandler.GetSupportedTypes(),
+		SupportedInfoTypes:                 jobTypesManager.GetSupportedTypes(),
 		InfoJobCallbackUrl:                 callbackAddress + server.AddJobPath,
 	}
 	if err := registrator.RegisterProducer("DMaaP_Mediator_Producer", &producer); err != nil {
@@ -112,6 +123,7 @@ func registerTypesAndProducer(jobTypesHandler jobs.JobTypesManager, infoCoordina
 func startCallbackServer(jobsManager jobs.JobsManager, callbackAddress string) {
 	log.Debugf("Starting callback server at port %v", configuration.InfoProducerPort)
 	r := server.NewRouter(jobsManager, statusHandler)
+	addSwaggerHandler(r)
 	if restclient.IsUrlSecure(callbackAddress) {
 		log.Fatalf("Server stopped: %v", http.ListenAndServeTLS(fmt.Sprintf(":%v", configuration.InfoProducerPort), configuration.ProducerCertPath, configuration.ProducerKeyPath, r))
 	} else {
@@ -119,12 +131,34 @@ func startCallbackServer(jobsManager jobs.JobsManager, callbackAddress string) {
 	}
 }
 
+type ProducerStatus struct {
+	// The registration status of the producer in Information Coordinator Service. Either `registered` or `not registered`
+	RegisteredStatus string `json:"registeredStatus" swaggertype:"string" example:"registered"`
+} // @name  ProducerStatus
+
+// @Summary      Get status
+// @Description  Get the status of the producer. Will show if the producer has registered in ICS.
+// @Tags         Data producer (callbacks)
+// @Produce      json
+// @Success      200  {object}  ProducerStatus
+// @Router       /health_check [get]
 func statusHandler(w http.ResponseWriter, r *http.Request) {
-	registeredStatus := "not registered"
+	status := ProducerStatus{
+		RegisteredStatus: "not registered",
+	}
 	if registered {
-		registeredStatus = "registered"
+		status.RegisteredStatus = "registered"
 	}
-	fmt.Fprintf(w, `{"status": "%v"}`, registeredStatus)
+	json.NewEncoder(w).Encode(status)
+}
+
+// @Summary      Get Swagger Documentation
+// @Description  Get the Swagger API documentation for the producer.
+// @Tags         Admin
+// @Success      200
+// @Router       /swagger [get]
+func addSwaggerHandler(r *mux.Router) {
+	r.PathPrefix("/swagger").Handler(httpSwagger.WrapHandler)
 }
 
 func keepProducerAlive() {