Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom API Data Tag #38

Open
mitchwadair opened this issue Aug 3, 2020 · 0 comments
Open

Custom API Data Tag #38

mitchwadair opened this issue Aug 3, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@mitchwadair
Copy link
Owner

mitchwadair commented Aug 3, 2020

It would be nice for a user to be able to provide an API endpoint to fetch data from if it is not included in the product by default. This would be a feature reserved for the more advanced users of the app, but should still be accessible enough that it is easy enough to understand for less-experienced people.

The usage could look something like this:

{{customapi|https://someurl|returned.data.path}}

We have two parameters to the data tag:

  • Endpoint URL
    • This would have to be an open API, not needing an API key
  • Path to the desired data value
    • The API would be required to return data in JSON format or plaintext
    • If the response data is plaintext, this parameter should be blank
    • For JSON responses, the path should look like a normal JSON data accessor path (keys separated by dots) and should lead to a primitive data type that can be printed as a string
@mitchwadair mitchwadair added the enhancement New feature or request label Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant