github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/internal/apiserver/route_get_msg_by_id.go (about)

     1  // Copyright © 2021 Kaleido, Inc.
     2  //
     3  // SPDX-License-Identifier: Apache-2.0
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package apiserver
    18  
    19  import (
    20  	"net/http"
    21  	"strings"
    22  
    23  	"github.com/kaleido-io/firefly/internal/config"
    24  	"github.com/kaleido-io/firefly/internal/i18n"
    25  	"github.com/kaleido-io/firefly/internal/oapispec"
    26  	"github.com/kaleido-io/firefly/pkg/fftypes"
    27  )
    28  
    29  var getMsgByID = &oapispec.Route{
    30  	Name:   "getMsgByID",
    31  	Path:   "namespaces/{ns}/messages/{msgid}",
    32  	Method: http.MethodGet,
    33  	PathParams: []*oapispec.PathParam{
    34  		{Name: "ns", ExampleFromConf: config.NamespacesDefault, Description: i18n.MsgTBD},
    35  		{Name: "msgid", Description: i18n.MsgTBD},
    36  	},
    37  	QueryParams: []*oapispec.QueryParam{
    38  		{Name: "data", IsBool: true, Description: i18n.MsgTBD},
    39  	},
    40  	FilterFactory:   nil,
    41  	Description:     i18n.MsgTBD,
    42  	JSONInputValue:  nil,
    43  	JSONOutputValue: func() interface{} { return &fftypes.MessageInput{} }, // can include full values, like on input
    44  	JSONOutputCode:  http.StatusOK,
    45  	JSONHandler: func(r oapispec.APIRequest) (output interface{}, err error) {
    46  		output, err = r.Or.GetMessageByID(r.Ctx, r.PP["ns"], r.PP["msgid"], strings.EqualFold(r.QP["data"], "true"))
    47  		return output, err
    48  	},
    49  }