OpenApiYamlWriter Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
YAML writer.
public class OpenApiYamlWriter : Microsoft.OpenApi.Writers.OpenApiWriterBasetype OpenApiYamlWriter = class
inherit OpenApiWriterBasePublic Class OpenApiYamlWriter
Inherits OpenApiWriterBase- Inheritance
Constructors
| OpenApiYamlWriter(TextWriter) |
Initializes a new instance of the OpenApiYamlWriter class. |
| OpenApiYamlWriter(TextWriter, OpenApiWriterSettings) |
Initializes a new instance of the OpenApiYamlWriter class. |
Fields
| IndentationString |
The indentation string to prepand to each line for each indentation level. (Inherited from OpenApiWriterBase) |
| Scopes |
Scope of the Open API element - object, array, property. (Inherited from OpenApiWriterBase) |
Properties
| BaseIndentation |
Base Indentation Level. This denotes how many indentations are needed for the property in the base object. |
| Settings |
Settings for controlling how the OpenAPI document will be written out. (Inherited from OpenApiWriterBase) |
| UseLiteralStyle |
Allow rendering of multi-line strings using YAML | syntax |
| Writer |
The text writer. (Inherited from OpenApiWriterBase) |
Methods
| CurrentScope() |
Get current scope. (Inherited from OpenApiWriterBase) |
| DecreaseIndentation() |
Decreases the level of indentation applied to the output. (Inherited from OpenApiWriterBase) |
| EndScope(ScopeType) |
End the scope of the given scope type. (Inherited from OpenApiWriterBase) |
| Flush() |
Flush the writer. (Inherited from OpenApiWriterBase) |
| IncreaseIndentation() |
Increases the level of indentation applied to the output. (Inherited from OpenApiWriterBase) |
| IsArrayScope() |
Whether the current scope is an array scope. (Inherited from OpenApiWriterBase) |
| IsObjectScope() |
Whether the current scope is an object scope. (Inherited from OpenApiWriterBase) |
| IsTopLevelScope() |
Whether the current scope is the top level (outermost) scope. (Inherited from OpenApiWriterBase) |
| StartScope(ScopeType) |
Start the scope given the scope type. (Inherited from OpenApiWriterBase) |
| VerifyCanWritePropertyName(String) |
Verifies whether a property name can be written based on whether the property name is a valid string and whether the current scope is an object scope. (Inherited from OpenApiWriterBase) |
| WriteEndArray() |
Write YAML end array. |
| WriteEndObject() |
Write YAML end object. |
| WriteIndentation() |
Write the indentation. (Inherited from OpenApiWriterBase) |
| WriteNull() |
Write null value. |
| WritePropertyName(String) |
Write the property name and the delimiter. |
| WriteRaw(String) |
Writes the content raw value. |
| WriteStartArray() |
Write YAML start array. |
| WriteStartObject() |
Write YAML start object. |
| WriteValue(Boolean) |
Write boolean value. (Inherited from OpenApiWriterBase) |
| WriteValue(DateTime) |
Write DateTime value. (Inherited from OpenApiWriterBase) |
| WriteValue(DateTimeOffset) |
Write DateTimeOffset value. (Inherited from OpenApiWriterBase) |
| WriteValue(Decimal) |
Write decimal value. (Inherited from OpenApiWriterBase) |
| WriteValue(Double) |
Write double value. (Inherited from OpenApiWriterBase) |
| WriteValue(Int32) |
Write integer value. (Inherited from OpenApiWriterBase) |
| WriteValue(Int64) |
Write long value. (Inherited from OpenApiWriterBase) |
| WriteValue(Object) |
Write object value. (Inherited from OpenApiWriterBase) |
| WriteValue(Single) |
Write float value. (Inherited from OpenApiWriterBase) |
| WriteValue(String) |
Write string value. |
| WriteValueSeparator() |
Write value separator. |