search

microbiomedata / NMDC_documentation

Document workflows, schemas, and portal
https://nmdc-documentation.readthedocs.io
2 stars 3 forks source link

Update `api_gui.md` for Berkeley schema #65

Open aclum opened 1 month ago

aclum commented 1 month ago

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 commented 1 month ago

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

mslarae13 commented 1 month ago

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

brynnz22 commented 1 month ago

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

aclum commented 1 month ago

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

brynnz22 commented 1 week ago

Linking this new issue: https://github.com/microbiomedata/nmdc-runtime/issues/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 commented 1 week ago

Thanks @brynnz22 so Criteria for unblock,

brynnz22 commented 1 week ago

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