Hulak Configuration

Hulak API client configuration file

Type object
File match **/*.hk.yaml **/*.hk.yml **/*.hk.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/hulak-configuration/latest.json
Source https://raw.githubusercontent.com/xaaha/hulak/refs/heads/main/assets/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for Hulak request YAML files https://github.com/xaaha/hulak

Properties

method string required

HTTP method for the request https://developer.mozilla.org/docs/Web/HTTP/Methods

Values: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS" "TRACE" "CONNECT"
url string required

Target URL for the API request https://developer.mozilla.org/docs/Web/HTTP/URLs

format=uri
kind string

Request type that determines the flow to follow.

Values: "API" "Auth" "GraphQL" "graphql" "api" "auth"
urlparams Record<string, string>

URL query parameters for the request https://developer.mozilla.org/docs/Web/API/URLSearchParams

headers Record<string, string>

HTTP headers included in the request https://developer.mozilla.org/docs/Web/HTTP/Headers

17 nested properties
Content-Type string

The MIME type of the body content https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Type

Values: "application/json" "application/xml" "application/x-www-form-urlencoded" "application/octet-stream" "application/pdf" "application/zip" "application/vnd.api+json" "application/javascript" "application/msword" "application/vnd.ms-excel" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "multipart/form-data" "multipart/byteranges" "multipart/related" "text/plain" "text/html" "text/css" "text/javascript" "text/csv" "text/markdown" "text/xml" "image/png" "image/jpeg" "image/gif" "image/svg+xml" "image/webp" "image/bmp" "image/tiff" "audio/mpeg" "audio/wav" "audio/ogg" "audio/aac" "audio/webm" "video/mp4" "video/mpeg" "video/ogg" "video/webm" "video/x-msvideo" "font/ttf" "font/woff" "font/woff2"
Accept string

Acceptable content types for the response

Values: "application/json" "application/xml" "application/x-www-form-urlencoded" "application/octet-stream" "application/pdf" "application/zip" "application/vnd.api+json" "application/javascript" "application/msword" "application/vnd.ms-excel" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "multipart/form-data" "multipart/byteranges" "multipart/related" "text/plain" "text/html" "text/css" "text/javascript" "text/csv" "text/markdown" "text/xml" "image/png" "image/jpeg" "image/gif" "image/svg+xml" "image/webp" "image/bmp" "image/tiff" "audio/mpeg" "audio/wav" "audio/ogg" "audio/aac" "audio/webm" "video/mp4" "video/mpeg" "video/ogg" "video/webm" "video/x-msvideo" "font/ttf" "font/woff" "font/woff2" "*/*"
Authorization string

Authentication credentials for the request

Default: "'{{.token}}'"
Cache-Control string

Directives for caching mechanisms in both requests and responses

User-Agent string

Information about the user agent originating the request

Content-Length string

The size of the request body in octets (8-bit bytes)

Accept-Encoding string

The encoding algorithm, usually a compression algorithm, that the client can understand

Accept-Language string

The natural languages that are preferred for the response

Connection string

Control options for the current connection

Values: "keep-alive" "close"
Cookie string

Contains stored HTTP cookies previously sent by the server with Set-Cookie

Host string

The domain name of the server and the TCP port number on which the server is listening

Origin string

Indicates where a fetch originates from

Referer string

The address of the previous web page from which a link to the currently requested page was followed

X-Requested-With string

Identifies Ajax requests (most JavaScript frameworks send this field with value of XMLHttpRequest)

X-Forwarded-For string

A de-facto standard header for identifying the originating IP address of a client connecting through a proxy

X-Forwarded-Proto string

A de-facto standard header for identifying the protocol that a client used to connect to a proxy

X-Csrf-Token string

Used to prevent cross-site request forgery

body object

Request body content https://developer.mozilla.org/docs/Web/API/Request/body

One of: rawBody object, object object, object object, object object
auth object

OAuth 2.0 authentication configuration https://oauth.net/2/

2 nested properties
type string

OAuth 2.0 flow type https://oauth.net/2/grant-types/

Values: "OAuth2.0"
access_token_url string

Endpoint to obtain the OAuth 2.0 access token https://oauth.net/2/access-tokens/

format=uri

All of

1. variant