Hyperlyn Document

Hyperlyn documents have a hypclient extension.

They are SQLite databases that can be open on any platform where sqlite is available.

Tables

Hyperlyn data is kept in three tables

  • website — Holds information on Websites and Resources.
  • templates — Holds information on Request Templates.
  • exchanges — Holds HTTP ExchangesRequests and the corresponding Responses.
Website Table

The website table holds information on Websites and Resources.

  • id — A UUID for the Website.
  • scheme — Default scheme to be used — http or https — for communication.
  • name and port — The name and port of the Website server.
  • configuration — JSON object containing the hierarchy of Resources, parameters attached to resources, references to Request Templates and the global website options — Explicit Standard Headers, Manage Cookies and Follow Redirects.
Template Table

The template table holds information on Request Templates, their parameters and payloads, and other configuration.

  • id — A UUID for the Request Template.
  • scheme — Scheme to be used — inherited, http or https — for communication. The value inherited indicates that the default scheme for the Website should be used. The values http and https override the default scheme.
  • method — HTTP method to be used with Requests created from this template.
  • title — An optional title to be used in the Hyperlyn UI instead of the method name.
  • configuration — JSON object containing parameters and tags.
  • contentType — The content type of the payload, formatted as the corresponding HTTP Content-Type header.
  • payload — Blob containing the optional payload.
Exchange Table

The exchange table is where the application saves all HTTP Requests that were made and the corresponding Responses that were received.

  • id — A UUID for the Exchange.
  • websiteId — The UUID of the Website that generated this exchange.
  • sourceId — The UUID of the Resource or Request Template that generated this exchange.
  • timestamp — Date and time when the Request was sent.
  • serverName and serverPort — The name and port of the server to which the Request was sent.
  • scheme — Scheme used — http or https — for communication.
  • method — HTTP method sent in the Request.
  • path — HTTP path (including the optional query string) sent in the Request.
  • statusCode and statusMessage — HTTP status code and message received in the Response.
  • configuration — JSON object containing Request headers, Response headers, and tags.
  • requestPayload and responsePayload — Blobs containing payloads sent and received.

Last updated on 2023-12-05