describe_endpoint.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 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.
 */
 
#ifndef A11_NET_DESCRIBE_ENDPOINT_H_
#define A11_NET_DESCRIBE_ENDPOINT_H_
 
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
#include <absl/base/nullability.h>
#include <absl/status/statusor.h>
 
#include "a11/concurrency/future.h"
#include "a11/net/http2.h"
 
namespace a11::net {
 
using DescribeActionsHandler = std::function<absl::StatusOr<std::string>(
    std::string_view name, std::string_view query)>;
 
inline constexpr std::string_view kDefaultDescribeEndpoint = "/actions";
 
struct DescribeEndpointOptions {
  DescribeActionsHandler handler{};
  std::string path = std::string(kDefaultDescribeEndpoint);
 
  [[nodiscard]] bool Enabled() const {
    return static_cast<bool>(handler) && !path.empty();
  }
};
 
bool MatchDescribePath(std::string_view path,
                       const DescribeEndpointOptions& options,
                       std::string* absl_nonnull name);
 
std::optional<a11::Task> TryDescribeOverHttp(
    const DescribeEndpointOptions& options, const HttpRequest& request,
    const std::shared_ptr<Http2ResponseWriter>& response,
    HttpHeaders extra_headers = {});
 
std::string_view QueryOfPath(std::string_view path);
 
}  // namespace a11::net
 
#endif  // A11_NET_DESCRIBE_ENDPOINT_H_