Struct OpenApiAdapter

#[non_exhaustive]
pub struct OpenApiAdapter { /* private fields */ }

Implementations

impl OpenApiAdapter

pub const SCHEMA_TEXT: &'static str = "schema {\r\n query: RootSchemaQuery\r\n}\r\ndirective @filter(\r\n \"\"\"\r\n Name of the filter operation to perform.\r\n \"\"\"\r\n op: String!\r\n \"\"\"\r\n List of string operands for the operator.\r\n \"\"\"\r\n value: [String!]\r\n) repeatable on FIELD | INLINE_FRAGMENT\r\ndirective @tag(\r\n \"\"\"\r\n Name to apply to the given property field.\r\n \"\"\"\r\n name: String\r\n) on FIELD\r\ndirective @output(\r\n \"\"\"\r\n What to designate the output field generated from this property field.\r\n \"\"\"\r\n name: String\r\n) on FIELD\r\ndirective @optional on FIELD\r\ndirective @recurse(\r\n \"\"\"\r\n Recurse up to this many times on this edge. A depth of 1 produces the current\r\n vertex and its immediate neighbors along the given edge.\r\n \"\"\"\r\n depth: Int!\r\n) on FIELD\r\ndirective @fold on FIELD\r\ndirective @transform(\r\n \"\"\"\r\n Name of the transformation operation to perform.\r\n \"\"\"\r\n op: String!\r\n) on FIELD\r\n\r\ntype RootSchemaQuery {\r\n \"\"\"\r\n OpenAPI doc info\r\n \"\"\"\r\n Info: Info!\r\n \r\n \"\"\"\r\n OpenAPI doc tags\r\n \"\"\"\r\n Tags: [Tag!]!\r\n\r\n \"\"\"\r\n OpenAPI doc paths\r\n \"\"\"\r\n Paths: [Path!]!\r\n\r\n \"\"\"\r\n OpenAPI doc path\r\n\r\n path: the path to the endpoint\r\n \"\"\"\r\n Path(path: String!): Path\r\n\r\n}\r\n\r\ntype Info {\r\n title: String!\r\n version: String!\r\n description: String\r\n}\r\n\r\ntype Tag {\r\n name: String!\r\n description: String\r\n}\r\n\r\ntype Path {\r\n path: String!\r\n get: Operation\r\n post: Operation\r\n put: Operation\r\n delete: Operation\r\n patch: Operation\r\n options: Operation\r\n operations: [Operation!]!\r\n}\r\n\r\ntype Operation {\r\n summary: String\r\n method: String!\r\n description: String\r\n tags: [String!]\r\n xAmazonApigatewayIntegration: AmazonApigatewayIntegration\r\n}\r\n\r\ntype AmazonApigatewayIntegration {\r\n type: String!\r\n httpMethod: String!\r\n uri: String!\r\n passthroughBehavior: String!\r\n timeoutInMillis: Int\r\n trigger: String!\r\n arn: String\r\n}\r\n"

pub fn schema() -> &'static Schema

Get the defined schema for the adapter

pub fn new() -> Self

Create a new OpenAPI default adapter

pub fn new_with_files(files: Vec<PathBuf>) -> Result<Self, OpenAPIAdapterErrors>

New instance with selected files to used

pub fn new_with_path(path: PathBuf) -> Result<Self, OpenAPIAdapterErrors>

pub fn files(&mut self, files: Vec<PathBuf>) -> Result<(), OpenAPIAdapterErrors>

Set the files that are to be used

pub fn set_path(&mut self, path: PathBuf) -> Result<(), OpenAPIAdapterErrors>

Sets the directory that files are to be found

Trait Implementations

impl<'a> Adapter<'a> for OpenApiAdapter

type Vertex = Vertex

The type of vertices in the dataset this adapter queries. Unless your intended vertex type is cheap to clone, consider wrapping it an Rc or Arc to make cloning it cheaper since that’s a fairly common operation when queries are evaluated.

fn resolve_starting_vertices( &self, edge_name: &Arc<str>, parameters: &EdgeParameters, _resolve_info: &ResolveInfo, ) -> VertexIterator<'a, Self::Vertex>

Produce an iterator of vertices for the specified starting edge.

fn resolve_property<V: AsVertex<Self::Vertex> + 'a>( &self, contexts: ContextIterator<'a, V>, type_name: &Arc<str>, property_name: &Arc<str>, resolve_info: &ResolveInfo, ) -> ContextOutcomeIterator<'a, V, FieldValue>

Resolve a property required by the query that’s being evaluated.

fn resolve_neighbors<V: AsVertex<Self::Vertex> + 'a>( &self, contexts: ContextIterator<'a, V>, type_name: &Arc<str>, edge_name: &Arc<str>, parameters: &EdgeParameters, resolve_info: &ResolveEdgeInfo, ) -> ContextOutcomeIterator<'a, V, VertexIterator<'a, Self::Vertex>>

Resolve the neighboring vertices across an edge.

fn resolve_coercion<V: AsVertex<Self::Vertex> + 'a>( &self, contexts: ContextIterator<'a, V>, _type_name: &Arc<str>, coerce_to_type: &Arc<str>, _resolve_info: &ResolveInfo, ) -> ContextOutcomeIterator<'a, V, bool>

Attempt to coerce vertices to a subtype, as required by the query that’s being evaluated.

impl Debug for OpenApiAdapter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiAdapter

fn default() -> OpenApiAdapter

Returns the “default value” for a type.