Skip to content

AtloriaAPIExplorer

reference
1 min readUpdated

Kind: Class

Source: atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts

Extends: ExplorerElement

Methods

MethodSignatureReturns
willUpdate`willUpdate(changed: Map<stringnumber
connectedCallbackconnectedCallback()void
disconnectedCallbackdisconnectedCallback()void
renderrender()void

Properties

PropertyType
stylesany
stringsExplorerStrings
specOpenAPISpec
endpointsAPIEndpoint[]
environmentsEnvironment[]
mode`'explorer'
defaultEndpointstring
proxyUrlstring
presetBearerTokenstring
readerApiKeystring
paramOptionsUrlstring
sendDisabledReasonstring
allowCredentialLoginany
getKeyUrlany
oauthClientIdany
oauthRedirectUriany
projectKeyany

Where it refuses work

  • AtloriaAPIExplorer stops the work with Error when bytes > MAX_PROXY_UPLOAD_BYTES, in 2 places.
  • AtloriaAPIExplorer stops the work with Error when !loginEndpoint — “No login endpoint found”.
  • AtloriaAPIExplorer stops the work with Error when !token — “No token found in login response”.
  • AtloriaAPIExplorer stops the work with Error when !proxied.ok.
  • AtloriaAPIExplorer stops the work with Error when !response.ok.
  • AtloriaAPIExplorer stops the work with OAuth2Error when response.error — “provider-error”.

When something fails

  • AtloriaAPIExplorer handles failure in 16 places: it logs it and continues in 6, discards it silently in 5, turns it into a return value in 4, and lets it reach the caller in 1. A failure discarded silently leaves no trace for whoever debugs this later.

Was this page helpful?

Download as PDF