OpenApiUrlTreeNode Class

Definition

Namespace:

Microsoft.OpenApi.Services

Assembly:

Microsoft.OpenApi.dll

Package:

Microsoft.OpenApi v1.6.0

A directory structure representing the paths of an OpenAPI document.

public class OpenApiUrlTreeNode

type OpenApiUrlTreeNode = class

Public Class OpenApiUrlTreeNode

Inheritance

Object

OpenApiUrlTreeNode

Fields

MermaidNodeStyles

Dictionary that maps a set of HTTP methods to HTML color. Keys are sorted, uppercased, concatenated HTTP methods.

Properties

AdditionalData	A dictionary of key value pairs that contain information about a node.
Children	All the subdirectories of a node.
IsParameter	Flag indicating whether a node segment is a path parameter.
Path	The relative directory path of the current node from the root node.
PathItems	Dictionary of labels and Path Item objects that describe the operations available on a node.
Segment	The subdirectory of a relative path.

Methods

AddAdditionalData(Dictionary<String,List<String>>)	Adds additional data information to the AdditionalData property of the node.
Attach(OpenApiDocument, String)	Retrieves the paths from an OpenAPI document and appends the items to an OpenApiUrlTreeNode node.
Attach(String, OpenApiPathItem, String)	Appends a path and the PathItem to an OpenApiUrlTreeNode node.
Create()	Creates an empty structured directory of OpenApiUrlTreeNode node.
Create(OpenApiDocument, String)	Creates a structured directory of OpenApiUrlTreeNode nodes from the paths of an OpenAPI document.
HasOperations(String)	Flag indicating whether the node's PathItems dictionary has operations under a given label.
WriteMermaid(TextWriter)	Write tree as Mermaid syntax