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

Update api_gui.md for Berkeley schema and deploy to documentation website #65

Open
aclum opened this issue Jul 16, 2024 · 12 comments
Open
Assignees

Comments

@aclum
Copy link
Contributor

aclum commented Jul 16, 2024

In particular the mentions to Activity should be removed in favor of WorkflowExecution. Depends on updates to the activity endpoints. It would be good to start a branch for berkeley so we can have the nmdc-runtime's berkeley branch point to a branch in NMDC_documentation that contains the updated text.

@brynnz22
Copy link
Contributor

Sounds good. I'll work on this. Thanks!

@eecavanna eecavanna changed the title Update api_gui.md for berkeley schema Update api_gui.md for Berkeley schema Jul 23, 2024
@mslarae13
Copy link
Contributor

@brynnz22 can you add why this is blocked & what needs to happen or decisions that need made to unblock?

@brynnz22
Copy link
Contributor

brynnz22 commented Aug 1, 2024

@mslarae13 I don't think this is blocked. It depends on that other PR Alicia linked, but I can start updating the documentation.

@aclum
Copy link
Contributor Author

aclum commented Aug 5, 2024

The endpoints that reference 'Activity' need to have finalized new names, see hyperlinked ticket in the description.

@brynnz22
Copy link
Contributor

Linking this new issue: microbiomedata/nmdc-runtime#653. While updating the docs, realized the old activity endpoints allowed a user to search both WorkflowExecution and PlannedProcess which allowed searching OmicsProcessing(now DataGeneration and MaterialProcessing collections). Will wait to update API docs based on this issue.

@mslarae13
Copy link
Contributor

mslarae13 commented Aug 27, 2024

@brynnz22
Copy link
Contributor

Just your second bullet point is the criteria for unblock. The first bullet point should come after I complete this issue.

@eecavanna
Copy link
Contributor

Related: #70

@mslarae13
Copy link
Contributor

is this post refactor rollout eligible? (AKA, not MVP?)

@eecavanna
Copy link
Contributor

eecavanna commented Sep 20, 2024

Hi @mslarae13, I don't think so. The content updates are done (in PR #70) — they just haven't been deployed yet. We're deliberately waiting until "switchover" day before deploying them.

@eecavanna eecavanna changed the title Update api_gui.md for Berkeley schema Update api_gui.md for Berkeley schema and deploy to documentation website Sep 20, 2024
@ssarrafan
Copy link

@mslarae13 @brynnz22 since #653 is closed can this issue be closed too?

@brynnz22
Copy link
Contributor

No its not done until its merged, and it can't be merged in until after the Berkeley stuff. I put it in the post roll out bin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Post Berk Roll Out
Development

No branches or pull requests

5 participants