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

Discrepancy between website and API representation #5526

Open
trangvu9 opened this issue Jul 25, 2024 · 6 comments
Open

Discrepancy between website and API representation #5526

trangvu9 opened this issue Jul 25, 2024 · 6 comments

Comments

@trangvu9
Copy link

Hi, I was looking at Istio, on the website (https://endoflife.date/istio) it shows security support column:

image

But the API doesn't have this info:

image

How do I get this security column using the API?

Thanks

Copy link

welcome bot commented Jul 25, 2024

Thank you for opening your first issue here 👍. Be sure to follow the issue template if you chose one.

@captn3m0
Copy link
Member

The security column is same as the EoL field for Istio.

@trangvu9
Copy link
Author

The security column is same as the EoL field for Istio.

how do I know this? Make a guess?

@captn3m0
Copy link
Member

The schema is documented at https://endoflife.date/docs/api. If you're looking specifically for the label that we're using - that isn't a part of the API, since the API should be product neutral.

Instead, we offer two fields for support, eol, discontinued, lts. Assuming you're using the data somewhere programmatically, that should work, since these are somewhat cleanly defined.

Do you have a usecase where you need the labels as well?

If you really need this information, this is all part of our frontmatter, so is picked up by other sources, such as DataTig, which provides it over an API: https://hub.datatig.com/gh/endoflife-date/endoflife.date/tree/master/type/products/record/istio/api1.json (browse at https://hub.datatig.com/gh/endoflife-date/endoflife.date/tree/master/type/products/record/istio). In the case of Istio, the eolColumnLabel field is coming from our defaults defined at https://github.com/endoflife-date/endoflife.date/blob/master/_config.yml#L72-L101. So you could do a JSON merge of our defaults + frontmatter and read the Labels.

Finally, our upcoming v1 API (#2080) has a labels key: https://deploy-preview-2080--endoflife-date.netlify.app/docs/api/v1/. See sample at https://deploy-preview-2080--endoflife-date.netlify.app/api/v1/products/almalinux/. Feedback is welcome

@trangvu9
Copy link
Author

The schema is documented at https://endoflife.date/docs/api. If you're looking specifically for the label that we're using - that isn't a part of the API, since the API should be product neutral.

Instead, we offer two fields for support, eol, discontinued, lts. Assuming you're using the data somewhere programmatically, that should work, since these are somewhat cleanly defined.

Do you have a usecase where you need the labels as well?

If you really need this information, this is all part of our frontmatter, so is picked up by other sources, such as DataTig, which provides it over an API: https://hub.datatig.com/gh/endoflife-date/endoflife.date/tree/master/type/products/record/istio/api1.json (browse at https://hub.datatig.com/gh/endoflife-date/endoflife.date/tree/master/type/products/record/istio). In the case of Istio, the eolColumnLabel field is coming from our defaults defined at https://github.com/endoflife-date/endoflife.date/blob/master/_config.yml#L72-L101. So you could do a JSON merge of our defaults + frontmatter and read the Labels.

Finally, our upcoming v1 API (#2080) has a labels key: https://deploy-preview-2080--endoflife-date.netlify.app/docs/api/v1/. See sample at https://deploy-preview-2080--endoflife-date.netlify.app/api/v1/products/almalinux/. Feedback is welcome

Thanks for the explanation. It serves me well. I just wanted to somewhat replicate what you have on the website and the API is the only thing that I looked at, so it seems not possible if using just the API alone. This indeed turns out to be true.

Regarding my use case, I'm looking for an API that has security support label.

@captn3m0
Copy link
Member

I just wanted to somewhat replicate what you have on the website

Can you help us understand this usecase further? Is this a private version of the website? Or a specialized version? We have a page documenting Known Users and would love add your usecase to the list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants