api

Documentation

Overview

Copyright © 2020 Bob Callaway <bcallawa@redhat.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Bob Callaway <bcallawa@redhat.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Bob Callaway <bcallawa@redhat.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func ConfigureAPI()
• func CreateLogEntryHandler(params entries.CreateLogEntryParams) middleware.Responder
• func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder
• func GetLogEntryByUUIDHandler(params entries.GetLogEntryByUUIDParams) middleware.Responder
• func GetLogEntryProofHandler(params entries.GetLogEntryProofParams) middleware.Responder
• func GetLogInfoHandler(params tlog.GetLogInfoParams) middleware.Responder
• func GetLogProofHandler(params tlog.GetLogProofParams) middleware.Responder
• func GetPublicKeyHandler(params tlog.GetPublicKeyParams) middleware.Responder
• func SearchIndexHandler(params index.SearchIndexParams) middleware.Responder
• func SearchIndexNotImplementedHandler(params index.SearchIndexParams) middleware.Responder
• func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Responder
• type API
  • func NewAPI() (*API, error)
• type Response
• type TrillianClient
  • func NewTrillianClient(ctx context.Context) TrillianClient

Variables

var (
	MetricLatency = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "rekor_api_latency",
		Help: "Api Latency on calls",
	}, []string{"path", "code"})
)

Functions

func ConfigureAPI

func ConfigureAPI()

func CreateLogEntryHandler

func CreateLogEntryHandler(params entries.CreateLogEntryParams) middleware.Responder

func GetLogEntryByIndexHandler

func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder

func GetLogEntryByUUIDHandler

func GetLogEntryByUUIDHandler(params entries.GetLogEntryByUUIDParams) middleware.Responder

func GetLogEntryProofHandler

func GetLogEntryProofHandler(params entries.GetLogEntryProofParams) middleware.Responder

func GetLogInfoHandler

func GetLogInfoHandler(params tlog.GetLogInfoParams) middleware.Responder

func GetLogProofHandler

func GetLogProofHandler(params tlog.GetLogProofParams) middleware.Responder

func GetPublicKeyHandler

func GetPublicKeyHandler(params tlog.GetPublicKeyParams) middleware.Responder

func SearchIndexHandler

func SearchIndexHandler(params index.SearchIndexParams) middleware.Responder

func SearchIndexNotImplementedHandler

func SearchIndexNotImplementedHandler(params index.SearchIndexParams) middleware.Responder

func SearchLogQueryHandler

func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Responder

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func NewAPI

func NewAPI() (*API, error)

type Response

type Response struct {
	// contains filtered or unexported fields
}

type TrillianClient

type TrillianClient struct {
	// contains filtered or unexported fields
}

func NewTrillianClient

func NewTrillianClient(ctx context.Context) TrillianClient