Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RestApiQueryView

An off-chain view using a REST API described in a separate OpenAPI specification. The following parameters form a pointer to the localtion in the OpenAPI description.

Hierarchy

  • RestApiQueryView

Index

Properties

Properties

restApiQuery

restApiQuery: { baseUri?: undefined | string; method?: "GET" | "POST" | "PUT"; path: string; specificationUri: string }

Type declaration

  • Optional baseUri?: undefined | string

    The URI-prefix to use to query the API.

  • Optional method?: "GET" | "POST" | "PUT"

    The HTTP method to use.

  • path: string

    The path component of the URI to look-up in the OpenAPI specification.

  • specificationUri: string

    A URI pointing at the location of the OpenAPI specification.

Generated using TypeDoc