Failed to register new API due to 504 error

[yuanzhou]

I've tried a few times and the backend service seems to be having problems adding a new API.

[yuanzhou]

@newgene @NikkiBytes @kevinxin90 @susrinivasan can any of you please take a look at this issue? Our HuBMAP APIs are relying on the Smart API services.

[susrinivasan]

Can you please provide more context? 504 seems to be a timeout error. May be the connection timed out due to server taking too long to respond is my guess.

[yuanzhou]

@susrinivasan thanks for getting back to me. Happy New Year!

I noticed this issue back in December before the holidays. Both the Dry Run and actual registration of a new API failed at https://smart-api.info/add-api.

As you can tell from the screenshot, the POST call to https://smart-api.info/api/metadata returned 504 from your server side.

[newgene]

@yuanzhou can you provide the metadata URL you are trying to register?

adding @marcodarko to this issue as well.

[susrinivasan]

Can you please help me by specifying which API it was? We have registered three APIs for MetGENE. Thanks for your help.

[yuanzhou]

@susrinivasan here is the github raw source: https://raw.githubusercontent.com/x-atlas-consortia/user-key-value-api/refs/heads/main/user-key-value-api-spec.yaml We created this new API and wanted to add the documentation to Smart API.

[susrinivasan]

Ok. Which API on our server is timing out? I can debug our script on our server if I know which API is timing out. I looked at your yaml file but it does not reference any script from our server bdcw.org. Am I missing something?

[yuanzhou]

@susrinivasan can you go to https://smart-api.info/add-api and Dry Run with the github raw URL I shared above? Wondering if you can reproduce the same 504 error from https://smart-api.info/api/metadata response. Our yaml contains the necessary API-specific documentation and it doesn't reference any script . All I was trying to do is adding this new API to Smart API registry.

[susrinivasan]

I got response when I https://smart-api.info/api/metadata

[yuanzhou]

I can get that too via a GET call in the browser. But when adding a new API at https://smart-api.info/add-api , your UI makes a POST call to https://smart-api.info/api/metadata which is causing 504.

[susrinivasan]

WHich of our APIs is making a POST? Which UI is it? Can you share the URL for our UI?Can you please specify it? That way I can debug it.

[yuanzhou]

@susrinivasan please reread all my previous messages, I've explained clearly. If you are not the right person to resolve this issue, please reach out to the development team.

[susrinivasan]

Sure. Perhaps I am not the right person. Some of our staff are on vacation. I will get back to you when we understand this issue. Thanks for your patience and wishing you a happy new year.

[everaldorodrigo]

Hi yuanzhou,

In the smartapi API logs, the following error is being reported:

yaml.scanner.ScannerError: while scanning for the next token
found character '\t' that cannot start any token
  in "<unicode string>", line 104, column 187:
     ...  value stored for the user's key

It seems that the application is not handling the error properly. We are actively working on a fix.

In the meantime, could you remove the \t character at the end of the line in the YAML file and try again?