Selaa lähdekoodia

REST API: remove status from ApiResponse

it duplicates the header HTTP status
Nicola Murino 4 vuotta sitten
vanhempi
commit
01850c7399
5 muutettua tiedostoa jossa 117 lisäystä ja 743 poistoa
  1. 3 3
      .github/workflows/development.yml
  2. 1 1
      docs/service.md
  3. 2 3
      httpd/api_utils.go
  4. 2 3
      httpd/httpd.go
  5. 109 733
      httpd/schema/openapi.yaml

+ 3 - 3
.github/workflows/development.yml

@@ -15,9 +15,6 @@ jobs:
         os: [ubuntu-latest, macos-latest]
         upload-coverage: [true]
         include:
-          - go: 1.13
-            os: ubuntu-latest
-            upload-coverage: false
           - go: 1.14
             os: ubuntu-latest
             upload-coverage: false
@@ -80,10 +77,13 @@ jobs:
         if: startsWith(matrix.os, 'windows-') != true
         run: |
           mkdir -p output/{bash_completion,zsh_completion}
+          mkdir -p output/examples/rest-api-cli
           cp sftpgo output/
           cp sftpgo.json output/
           cp -r templates output/
           cp -r static output/
+          cp -r init output/
+          cp examples/rest-api-cli/sftpgo_api_cli.py output/examples/rest-api-cli/
           ./sftpgo gen completion bash > output/bash_completion/sftpgo-completion.bash
           ./sftpgo gen completion zsh > output/zsh_completion/_sftpgo
           ./sftpgo gen man -d output/man/man1

+ 1 - 1
docs/service.md

@@ -39,7 +39,7 @@ sudo systemctl enable sftpgo
 # optional, install the REST API CLI. It requires python-requests to run
 sudo install -Dm755 examples/rest-api-cli/sftpgo_api_cli.py /usr/bin/sftpgo_api_cli
 # optional, create shell completion script, for example for bash
-sudo /usr/bin/sftpgo gen completion bash > /etc/bash_completion.d/sftpgo-completion.bash
+sudo sh -c '/usr/bin/sftpgo gen completion bash > /etc/bash_completion.d/sftpgo-completion.bash'
 # optional, create man pages
 sudo /usr/bin/sftpgo gen man -d /usr/share/man/man1
 ```

+ 2 - 3
httpd/api_utils.go

@@ -67,9 +67,8 @@ func sendAPIResponse(w http.ResponseWriter, r *http.Request, err error, message
 		errorString = err.Error()
 	}
 	resp := apiResponse{
-		Error:      errorString,
-		Message:    message,
-		HTTPStatus: code,
+		Error:   errorString,
+		Message: message,
 	}
 	ctx := context.WithValue(r.Context(), render.StatusCtxKey, code)
 	render.JSON(w, r.WithContext(ctx), resp)

+ 2 - 3
httpd/httpd.go

@@ -82,9 +82,8 @@ type Conf struct {
 }
 
 type apiResponse struct {
-	Error      string `json:"error"`
-	Message    string `json:"message"`
-	HTTPStatus int    `json:"status"`
+	Error   string `json:"error,omitempty"`
+	Message string `json:"message"`
 }
 
 // Initialize configures and starts the HTTP server

Tiedoston diff-näkymää rajattu, sillä se on liian suuri
+ 109 - 733
httpd/schema/openapi.yaml


Kaikkia tiedostoja ei voida näyttää, sillä liian monta tiedostoa muuttui tässä diffissä