Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit d339423

Browse files
committed
update readme
1 parent c3ddb1d commit d339423

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,18 @@ The API supports environment variable `http_proxy`. If the variable is set, it i
4747

4848
If `endpointUrl` contains `localhost` or `127.0.0.1` proxy settings are ignored automatically.
4949

50-
## Logging
50+
### Logging
5151

52-
The Simple Logging Facade for Java [https://www.slf4j.org/](SLF4J) serves as a simple facade or abstraction for various logging frameworks (e.g. java.util.logging, logback, log4j) allowing the end user to plug in the desired logging framework at deployment time.
52+
The Simple Logging Facade for Java [https://www.slf4j.org/](SLF4J) serves as a simple facade or abstraction
53+
for various logging frameworks (e.g. java.util.logging, logback, log4j) allowing the end user to plug in the desired
54+
logging framework at deployment time.
5355

56+
### Request Limits
57+
The API of Airtable itself is limited to 5 requests per second. If you exceed this rate, you will receive a 429 status code and will
58+
need to wait 30 seconds before subsequent requests will succeed.
5459

55-
## Access Base
5660

57-
## Access Table
58-
59-
## CRUD-Operations on table items
61+
## CRUD-Operations on Table Records
6062

6163
## Select
6264
Select List of items from table:
@@ -102,13 +104,14 @@ actorTable.destroy("recapJ3Js8AEwt0Bf");
102104

103105
## Annotations
104106

105-
Use the Gson Annotation @SerializedName to annotate Names which contain - or an emtpy Charakter.
107+
Use the Gson Annotation `@SerializedName` to annotate Names which contain `-` or emtpy characters.
106108

107109
### Example
108110
```Java
109111

110112
import com.google.gson.annotations.SerializedName;
111113

114+
//Column in Airtable is named "First- & Lastname", which is mapped to field "name".
112115
@SerializedName("First- & Lastname")
113116
private String name;
114117
```
@@ -117,9 +120,9 @@ Use the Gson Annotation @SerializedName to annotate Names which contain - or an
117120
+ [x] Airtable Configure
118121
+ [x] configuration of `proxy`
119122
+ [x] configuration of `AIRTABLE_API_KEY` & `AIRTABLE_BASE`
120-
+ [ ] configuration of `requestTimeout`
123+
+ [x] configuration of `requestTimeout`
121124

122-
+ [x] Select
125+
+ [x] Select Records
123126
+ [x] SelectAll
124127
+ [x] Queries (`maxRecords`, `sort` & `view` )
125128
+ [ ] Support of `filterByFormula`
@@ -164,5 +167,3 @@ We use following libraries:
164167
# License
165168

166169
MIT License, see [LICENSE](LICENSE)
167-
168-

0 commit comments

Comments
 (0)