saferwall / webapis Goto Github PK

Example :

1. https://api.saferwall.com/v1/files/51caae41376b1b031ff6e35c9180eae57d702a44538942e01a33b86afdcd985d

{
  "status": 404,
  "message": "The requested resource was not found."
}

2. https://api.saferwall.com/v1/files/51caae41376b1b031ff6e35c9180eae57d702a44538942e01a33b86afdcd985d/summary

{
  "status": 500,
  "message": "We encountered an error while processing your request."
}

Expected:

(2) response should be same as (1) response

{
  "status": 404,
  "message": "The requested resource was not found."
}

Authorization using header authorization is very important in any REST API

• Capitalize error messages.
• Better error translation, not:

"There is some problem with the data you submitted."
"Key: 'CreateUserRequest.Username' Error:Field validation for 'Username' failed on the 'alphanum' tag"

• Downloading samples using pre-signed URLs.
• Downloading artifacts like memory dumps, dropped files, etc using pre-signed URLs.

• Get/files/sha256?fields=x always includes comments_count, we should omit that field.
• Get /files/sha256?fields=not_exist return internal error, we should return bad request or something like that.
• When there is no activity, the log shows some internal server error.
• Following a non existing user returns ok

• find all user's document that follow that user and update them
• find all user activities and delete them.

I got an array of one object in the element fields. (items[0])

{
  "items" : [{
    "asci" : ["abc","efg"],
    "xyz":[]
  }]
}

It should be one of those:

{
  "items" : {
    "asci" : ["abc","efg"],
    "xyz":[]
  }
}

or

{
  "items" : [
    { "encoding":"asci", "value":"abc"}, 
    { "encoding":"asci", "value":"efg"}
  ]
}

or

{
  "items" : [
    ["asci", "abc"], 
    [ "asci", "efg"]
  ]
}

for me I think it is better to choose the 1st one to avoid duplicating the strings, but just to make it object instead of array.

I just noticed that we can only log in using username.

Is there a reason we don't allow logins using the email address?

https://github.com/saferwall/saferwall-api/blob/ae4f7c08de4c706c840f559b53502be0ced6ab87/internal/auth/service.go#L84

When a user register an account and log in for the first time, no activity is being displayed which is a bit confusing for the user, as with an anonymous account, we display all activities.

We should display a message to the user to start following some users.

Maybe we should always have a view to recommend some active users to registered accounts.

1805291

• Delete has-avatar from the user entity.
• GET/ https://robohash.org/usernamehere?set=set1&bgset=bg1&size=200x200

https://github.com/cbrand/go-filterparams

I tried to increase the max upload file size but it didn't work. Looks like it was hardcoded in the api.go . file

• Code first: https://github.com/swaggo/swag :)
• API doc generation:
  • https://github.com/rohit-gohri/redocusaurus
  • https://github.com/cloud-annotations/docusaurus-openapi

DELETE /auth/logout/

Can we avoid using new? because it is a reserved term in most languages.

In the case of a password changing
internal/user/service.go

I think it is better to use new_password instead of new.

https://stackoverflow.com/questions/39466716/how-do-i-get-the-aws-s3-website-endpoint-url-through-the-api

Issue 1

POST with a valid body and Authorization header on /v1/comments/ responds with 500 Internal Server Error with a the body:

{
    "status": 500,
    "message": "We encountered an error while processing your request."
}

instead of 201 Created, a subsequent get request to the comments resource shows that the comment did go through.

Issue 2

Go comments endpoint doesn't have the // @Security Bearer guard, although it's required and would fail with 401 Unauthorized without it, I generate the typescript API file from the swagger OpenAPI output in docs/swagger.json using openapi-generator-cli from npm.
This issue might affect the other comment endpoints with the other methods (DELETE, UPDATE, etc)