describe.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_ACTIONS_DESCRIBE_H_
#define A11_ACTIONS_DESCRIBE_H_
 
#include <string>
#include <string_view>
#include <vector>
 
#include <absl/status/statusor.h>
#include <nlohmann/json_fwd.hpp>
 
#include "a11/actions/schema.h"
 
namespace a11::actions {
 
class ActionRegistry;
 
inline constexpr std::string_view kSchemaDocumentFormat = "a11.actions/v1";
 
enum class PortView {
  kCallable,  
  kAll,       
};
 
struct SchemaQuery {
  std::vector<std::string> names;
  std::vector<std::string> exact;
  PortView ports = PortView::kCallable;
  bool include_reserved = false;
  bool runnable_only = false;
};
 
absl::StatusOr<SchemaQuery> ParseSchemaQuery(std::string_view encoded);
 
absl::StatusOr<SchemaQuery> ParseSchemaQueryString(std::string_view query);
 
bool SchemaQueryAccepts(const SchemaQuery& query, std::string_view name);
 
nlohmann::json SchemaToJson(const ActionSchema& schema, bool runnable,
                            PortView ports = PortView::kCallable);
 
nlohmann::json RegistryToJson(const ActionRegistry& registry,
                              const SchemaQuery& query);
 
absl::StatusOr<std::string> RegistryToJsonText(const ActionRegistry& registry,
                                               const SchemaQuery& query);
 
absl::StatusOr<std::string> SchemaToJsonText(
    const ActionSchema& schema, bool runnable,
    PortView ports = PortView::kCallable);
 
absl::StatusOr<ActionSchema> SchemaFromJson(const nlohmann::json& entry);
 
absl::StatusOr<ActionSchema> SchemaFromJsonText(std::string_view encoded);
 
absl::StatusOr<std::vector<nlohmann::json>> SchemasInDocument(
    const nlohmann::json& document);
 
}  // namespace a11::actions
 
#endif  // A11_ACTIONS_DESCRIBE_H_