@coinbase/cdp-sdk
Version:
SDK for interacting with the Coinbase Developer Platform Wallet API
30 lines (29 loc) • 1.08 kB
text/typescript
export type SecuritySchemeKey = string;
/**
* A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
* All schemes in the collection must be satisfied for authentication to be successful.
*/
export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
export type AuthScope = string;
export type EndpointMetadata = {
/**
* An array of security scheme collections. Each collection represents an alternative way to authenticate.
*/
security?: SecuritySchemeCollection[];
/**
* The HTTP method of the endpoint (e.g. "POST").
*/
method?: string;
/**
* The endpoint's path, including path parameter placeholders (e.g. "/v2/end-users/{userId}").
*/
path?: string;
/**
* A stable identifier for the endpoint (operation id).
*/
operationId?: string;
/**
* The wire names of headers declared on the endpoint (including managed headers such as "X-Wallet-Auth").
*/
headers?: string[];
};