blob: 39fd69013c81f1eae033e6765602e4913c2e3b51 [file] [log] [blame]
// Copyright 2024 The LUCI Authors.
//
// 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.
// Package pubsub allows to register handlers called by Cloud Pub/Sub.
//
// The HTTP endpoints exposed by this module perform necessary authorization
// checks and route requests to registered handlers, collecting monitoring
// metrics from them.
//
// Note that you still need to configure Cloud Pub/Sub Push subscriptions. By
// default registered handlers are exposed as "/internal/pubsub/<handler-id>"
// POST endpoints. This URL path should be used when configuring Cloud Pub/Sub
// subscriptions.
//
// Cloud Pub/Sub push subscriptions used with this module must be configured
// to send Wrapped messages. See https://cloud.google.com/pubsub/docs/push
// for more.
package pubsub