feat: rename whitelist-headers to allow-headers

README.md

@@ -73,18 +73,17 @@ endpoint: http://localhost:8000/blog/{id} # we can use 'id' here
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Content-Type
-  - Accept
 ```
 
 > [Click here](/learn-more/request-configuration) for full explanation of all parameters that can be used.
 
 - The args parameter allows us to pass in command line arguments. Formatted like `id=2`
-- Method can be any HTTP method
-- Endpoint is the API URL
-- Headers must be used in list format
-- Whitelist headers keeps the output clean, but only showing the headers listed
+- `method` can be any HTTP method
+- `endpoint` is the API URL
+- `headers` must be used in list format
+- `allow-headers` keeps the output clean, but only showing the headers listed
 
 If you're just trying out Sendex, feel free to use a test API, such as [JSON Placeholder](https://jsonplaceholder.typicode.com). Replace the default endpoint with `https://jsonplaceholder.typicode.com/todos/{id}`.
 

config/templates.go

@@ -1,13 +1,13 @@
 package config
 
-var DefaultTemplate []byte = []byte("args:\n  - id: 1 # specify 1 as default\nmethod: GET\nendpoint: http://localhost:8000/blog/{id} # we can use 'id' here\nheaders:\n  - Content-Type: application/json\n  - Accept: application/json\nwhitelist-headers:\n  - Content-Type\n  - Accept\n")
-var PostTemplate []byte = []byte("args:\n  - id: 1 # specify 1 as default\nmethod: POST\nendpoint: http://localhost:8000/blog/{id} # we can use 'id' here\nheaders:\n  - Content-Type: application/json\n  - Accept: application/json\nwhitelist-headers:\n  - Content-Type\n  - Accept\n")
+var DefaultTemplate []byte = []byte("args:\n  - id: 1 # specify 1 as default\nmethod: GET\nendpoint: http://localhost:8000/blog/{id} # we can use 'id' here\nheaders:\n  - Content-Type: application/json\n  - Accept: application/json\nallow-headers:\n  - Content-Type\n")
+var PostTemplate []byte = []byte("args:\n  - id: 1 # specify 1 as default\nmethod: POST\nendpoint: http://localhost:8000/blog/{id} # we can use 'id' here\nheaders:\n  - Content-Type: application/json\n  - Accept: application/json\nallow-headers:\n  - Content-Type\n")
 
 type RequestSchema struct {
-	Args             []map[string]string `yaml:"args"`
-	Method           string              `yaml:"method"`
-	Endpoint         string              `yaml:"endpoint"`
-	Headers          []map[string]string `yaml:"headers"`
-	Body             string              `yaml:"body"`
-	WhitelistHeaders []string            `yaml:"whitelist-headers"`
+	Args         []map[string]string `yaml:"args"`
+	Method       string              `yaml:"method"`
+	Endpoint     string              `yaml:"endpoint"`
+	Headers      []map[string]string `yaml:"headers"`
+	Body         string              `yaml:"body"`
+	AllowHeaders []string            `yaml:"allow-headers"`
 }

examples/get-todo.yml

@@ -6,5 +6,5 @@ endpoint: http://jsonplaceholder.typicode.com/todos/{id} # we can use 'id' here
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Content-Type

examples/post-todo.yml

@@ -11,5 +11,5 @@ body: |
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Nil

internal/output/buffer.go

@@ -88,9 +88,9 @@ func (b *Buffer) Status(response *http.Response) {
 	}
 }
 
-func (b *Buffer) Head(response *http.Response, whitelistHeaders []string) error {
+func (b *Buffer) Head(response *http.Response, AllowHeaders []string) error {
 	for header, value := range response.Header {
-		if len(whitelistHeaders) == 0 || slices.Contains(whitelistHeaders, header) {
+		if len(AllowHeaders) == 0 || slices.Contains(AllowHeaders, header) {
 			b.HeaderItem(header, value)
 		}
 	}

internal/output/output.go

@@ -55,7 +55,7 @@ func GenerateOutput(response *http.Response, config *OutputConfig) (string, erro
 	}
 
 	if config.ShowHead {
-		err := buff.Head(response, config.Request.WhitelistHeaders)
+		err := buff.Head(response, config.Request.AllowHeaders)
 		if err != nil {
 			return "", err
 		}

internal/output/output_test.go

@@ -103,7 +103,7 @@ func TestResponseWithOnlyHeaders(t *testing.T) {
 	}
 }
 
-func TestResponseWithWhitelistedHeaders(t *testing.T) {
+func TestResponseWithAllowedHeaders(t *testing.T) {
 	expectedOutput := Cyan + "Content-Type" + Reset + ": application/json\n"
 
 	response := http.Response{
@@ -120,7 +120,7 @@ func TestResponseWithWhitelistedHeaders(t *testing.T) {
 	outputConfig.ShowBody = false
 	outputConfig.ShowStatus = false
 	outputConfig.Request = &config.RequestSchema{
-		WhitelistHeaders: []string{"Content-Type"},
+		AllowHeaders: []string{"Content-Type"},
 	}
 
 	output := captureStdout(func() {

tests/404-todo.yml

@@ -3,5 +3,5 @@ endpoint: http://jsonplaceholder.typicode.com/todos/sdf
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Content-Type

tests/get-todo.yml

@@ -6,5 +6,5 @@ endpoint: http://jsonplaceholder.typicode.com/todos/{id} # we can use 'id' here
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Content-Type

tests/post-todo.yml

@@ -3,7 +3,7 @@ endpoint: http://jsonplaceholder.typicode.com/todos # we can use 'id' here
 headers:
   - Content-Type: application/json
   - Accept: application/json
-whitelist-headers:
+allow-headers:
   - Content-Type
 body: |
   {