VirtualizedAPIMethod

Summary

Represents a virtualized API method as part of a frontend API.

Description

A VirtualizedAPIMethod is the frontend exposure of a backend APIDefinition. The documentation for the original method can be overridden using descriptionType. When the documentation is overridden, the API Catalog will reflect the changes, allowing the method's documentation to be maintained even after the API is published. When the descriptionType is original, the documentation is obtained from the method from the original API definition. When descriptionType is manual, the text is obtained from descriptionManual and can use markdown syntax. When descriptionType is url, the descriptionUrl should point to an externally resolvable resource.

Fields

Field Name	Type	Since Version	Description
id	String		Unique ID of the method.
virtualizedApiId	String		The identifier of the VirtualizedAPI.
name	String		The virtualized method name. This defaults to the original APIDefinition method name.
apiId	String		The reference identifier for the original APIDefinition that was virtualized.
apiMethodId	String		The reference identifier for the original API APIDefinition method that was virtualized.
summary	String		A summary of the API Method.
descriptionType	String		The source for the method's description. One of: original, manual, markdown, or url. Defaults to original.
descriptionManual	String		Specifies a manual description, which can be markdown text.
descriptionMarkdown	String		specifies a markdown file to use for description.
descriptionUrl	String		Specifies a URL to use instead of description text.
tags	Map		The list of tags associated with this API method. Each tag can have multiple values.

Example JSON

{
  "id" : "f2a0d13a-51f3-4256-855e-2b1d838a5cd2",
  "virtualizedApiId" : "bacb827e-e555-43fa-b006-50c7404aa990",
  "name" : "MyMethod",
  "apiId" : "ec5e0a01-832b-4ecb-8cae-b35630527bb4",
  "apiMethodId" : "21490aa6-ed14-4059-b8b7-d5bf0dc22dc6",
  "summary" : "This is a summary of my API Method",
  "descriptionType" : "original",
  "descriptionManual" : "This is _my_ API method",
  "descriptionMarkdown" : "${environment.VINSTDIR}/../markdown/myapi/method.md",
  "descriptionUrl" : "https://myapi.org/docs/api#method",
  "tags" : {
    "Category" : [ "Social Network, Photos" ],
    "Type" : [ "REST" ]
  }
}