Skip to content
Snippets Groups Projects
Commit a7a2068f authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update docs

parent e7b02f73
No related branches found
No related tags found
1 merge request!5Extend authorization: update docs and help
# Bash REST API client
A set of class like functions with a <code>http.</code> prefix.
This is a bash solution to script REST API calls.
The specialties of this component are
......@@ -7,8 +8,8 @@ The specialties of this component are
* It was build to simplify http calls and handle http response for scripts
* After making a request the response stays is in memory. There is no output to any file to grep something or to cleanup after usage.
* Its functions feel a bit like class methods, i.e. http.getResponse to get the response body or http.getResponseHeader for the Http response header
* This component wraps curl - ist supports any http method
* works with anonymous requests and Basic Authentication
* This component wraps curl - it supports any http method
* works with anonymous requests and authentication / authorization: (Basic authentication, Authorization header (tokens, NTLM) or any other request header variable
* The response can be stored ... and reimported later. After import you can use the http.get* functions to fetch results from the former request.
* Caching support for GET requests with a given TTL: if you repeat a request to the same url and ttl was not reached yet then you continue with the cached result
......
......@@ -9,8 +9,8 @@ The specialties of this component are
* It was build to simplify http calls and handle http response for scripts
* After making a request the response stays is in memory. There is no output to any file to grep something or to cleanup after usage.
* Its functions feel a bit like class methods, i.e. http.getResponse to get the response body or http.getResponseHeader for the Http response header
* This component wraps curl - ist supports any http method
* works with anonymous requests and Basic Authentication
* This component wraps curl - it supports any http method
* works with anonymous requests and authentication / authorization: (Basic authentication, Authorization header (tokens, NTLM) or any other request header variable
* The response can be stored ... and reimported later. After import you can use the http.get* functions to fetch results from the former request.
* Caching support for GET requests with a given TTL: if you repeat a request to the same url and ttl was not reached yet then you continue with the cached result
......
<html>
<div class="hero">
<h2>Bash REST API client</h2>
A set of class like functions with a <code>http.</code> prefix.
</div>
</html>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment