OpenApiWorkspace 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.
Contains a set of OpenApi documents and document fragments that reference each other
public class OpenApiWorkspacetype OpenApiWorkspace = classPublic Class OpenApiWorkspace- Inheritance
-
OpenApiWorkspace
Constructors
| OpenApiWorkspace() |
Initialize workspace using current directory as the default location. |
| OpenApiWorkspace(OpenApiWorkspace) |
Initializes a copy of an OpenApiWorkspace object |
| OpenApiWorkspace(Uri) |
Initialize workspace pointing to a base URL to allow resolving relative document locations. Use a file:// url to point to a folder |
Properties
| Artifacts |
A list of document fragments that are contained in the workspace |
| BaseUrl |
The base location from where all relative references are resolved |
| Documents |
A list of OpenApiDocuments contained in the workspace |
| Fragments |
A list of document fragments that are contained in the workspace |
Methods
| AddArtifact(String, Stream) |
Add a stream based artificat to the workspace. Useful for images, examples, alternative schemas. |
| AddDocument(String, OpenApiDocument) |
Add an OpenApiDocument to the workspace. |
| AddFragment(String, IOpenApiReferenceable) |
Adds a fragment of an OpenApiDocument to the workspace. |
| Contains(String) |
Verify if workspace contains a document based on its URL. |
| GetArtifact(String) | |
| ResolveReference(OpenApiReference) |
Returns the target of an OpenApiReference from within the workspace. |