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

Task Deprecation API #63

Closed
2 tasks done
mkhorton opened this issue Sep 7, 2020 · 11 comments
Closed
2 tasks done

Task Deprecation API #63

mkhorton opened this issue Sep 7, 2020 · 11 comments
Assignees

Comments

@mkhorton
Copy link
Member

mkhorton commented Sep 7, 2020

This doesn't come directly from the tasks doc iirc so should probably be a separate endpoint.

Ideally, this would return a simple {deprecated: true/false, deprecation_reason: str}

(Under the current build process, deprecation reason will have to be empty)

  • Endpoint added
  • Add ability to query with a list of task_ids
@munrojm munrojm self-assigned this Oct 5, 2020
@mkhorton
Copy link
Member Author

Actually, having this be part of the materials endpoint probably makes sense, since this is where the other deprecated task information is held.

@munrojm
Copy link
Member

munrojm commented Oct 26, 2020

deprecated is currently a field that can be request when querying the materials endpoint. Did you want to have a separate endpoint specifically for obtaining deprecation data?

@mkhorton
Copy link
Member Author

This is not the global deprecated true/false but the list of deprecated task_ids, I'm fine with it being part of the materials endpoint though, that seems sensible since it's already in the materials doc.

@mkhorton
Copy link
Member Author

The ideal place for this would be part of the tasks endpoint, but this isn't contained in the task doc itself (it's built information), so it's a little tricky.

@munrojm
Copy link
Member

munrojm commented Oct 26, 2020

Oh gotcha, you mean the data in deprecated_tasks. I should be able to make a separate endpoint under tasks even if it comes from the materials doc.

@mkhorton
Copy link
Member Author

I'll defer to your judgement on that. It's tricky because I think the API should reflect the underlying document model as much as possible (to make it more obvious to someone examining the builders etc where that information came from), but this is semantically closer to tasks than it is to materials, so ???

@munrojm
Copy link
Member

munrojm commented Oct 26, 2020

Yeah, I generally agree with you. I will start with it under the tasks endpoint, and we can always move it later.

@munrojm
Copy link
Member

munrojm commented Oct 26, 2020

Endpoint is added, but deprecated_tasks is not currently populated in the materials.core collection docs on atlas.

@munrojm munrojm closed this as completed Mar 25, 2022
@mkhorton
Copy link
Member Author

Is deprecation_reason populated yet btw?

@munrojm
Copy link
Member

munrojm commented Mar 25, 2022

No, it isn't but I closed this issue here and opened a new one in the emmet repo since it is a builder problem.

@mkhorton
Copy link
Member Author

Perfect, just going to cross-link the issue here for reference: materialsproject/emmet#383

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