The wells endpoint currently has 11,000 results.

The navigation and the resource usage could be improved with pagination.

In addition, the page treats plates as unique by "name" when that is not true. We need to use a unique identifier to refer to each plate instead of the name.

This update would:

• Add an "all samples" view
• Upgrade all "well detail" views to show sample names instead of sample ID's

Pages to create:

• /collections/{uuid}/edit
• /parts/{uuid}/edit
• /authors/{uuid}/edit
• /plates/{uuid}/edit
• /wells/{uuid}/edit

Buttons to add to item pages:

• /collections/{uuid}
• /parts/{uuid}
• /authors/{uuid}
• /plates/{uuid}
• /wells/{uuid}

Buttons to add to list item rows:

• /collections
• /parts
• /authors
• /plates
• /wells

Add tests for:

• Home Page
• Authors
• Collections
• Bioparts
• Plates
• Wells

The FreeGenes project could be communicated more effectively through a more deliberately drafted about page.

This feature would involve spending some time crafting a high quality about page that will more clearly communicate what FreeGenes is all about.

Pages to create:

• /collections/{uuid}/delete
• /parts/{uuid}/delete
• /authors/{uuid}/delete
• /plates/{uuid}/delete
• /wells/{uuid}/delete

Buttons to add to item pages:

• /collections/{uuid}
• /parts/{uuid}
• /authors/{uuid}
• /plates/{uuid}
• /wells/{uuid}

Buttons to add to list item rows:

• /collections
• /parts
• /authors
• /plates
• /wells

Hey Keoni! Below you'll find some questions with regards to the API as well as recommendations / requests for changes.

Thanks for considering!

Endpoint Questions and Change Requests

Auth Test

/auth_test/
I'm a bit confused by this endpoint because it has me wondering whether it is even necessary.

Couldn't one just use one of the existing available endpoints to test whether auth was successful? Like a GET on /collections?

Seems like this would simplify the API.

Parts

First, with this collection, I'd like to request consolidating the available endpoints:

/parts/collection/
This seems to be a violation of the hierarchy.
Shouldn't the /collections/full/{uuid} endpoint really just list the parts available?

/parts/get/{key}/{value}
It's unclear what this does

/parts/next_gene_id
What does this do?

/parts/query_transfers (POST)
What does this do?

Second, /full/ seems redundant
Getting full results should be the default, no?
Perhaps there could be a query parameter that specifies that you only want part of the data
It could look something like this:
/parts?full=false
Then you could make the query parameter a generally available parameter
And it would make the API easier to learn
If this was removed, that would remove two more endpoints

Third, is the /part_modification/ endpoint redundant? Maybe I'm misunderstanding. If that is the case, though, then I'd recommend it'd be removed.

Collections

The same suggestions apply here as with parts

/collections/recurse/{uuid}
Seems like this should use the standard /collections/{uuid} endpoint with a query parameter that indicates that recursion should be executed

/collections/part_status/{uuid}/{key}
What does this do?

/collections/part_status/search/{uuid}/{key}/{status}
What does this do?

/collections/parts_with_confirmed_samples/{uuid} (GET, POST)
What does this do? And why is there a separate POST endpoint for it?

Orders

Pluralize: change the /order/ endpoint to /orders/

Plates

/plates/packet/{uuid}
What does this do?

Wells

/wells/plate_recurse/{uuid}
Isn't this redundant with the /plate/ endpoint?

Files

/files/download/{uuid}
Could this be changed so it's simply /files/{uuid} to fit in with the REST conventions?

/files/upload
Could this be changed so it's simply /files (POST) to fit in with the REST conventions?

Plateset

Pluralize: change the /plateset/ endpoint to /platesets/

Distribution

Pluralize: change the /distribution/ endpoint to /distributions/

Institution

Pluralize: change the /institution/ endpoint to /institutions/

Material Transfer Agreement

Could this be shortened to just /agreements/?

Also is there a reason this needs to have its own endpoint instead of being an item in the file collection? This file could be specially surfaced in some way using the UI.

Shipment

Pluralize: change the /shipment/ endpoint to /shipments/

Address

Pluralize: change the /address/ endpoint to /addresses/

Parcel

Pluralize: change the /parcel/ endpoint to /parcels/

Containers

/containers/str/{uuid}
I imagine it returns the results in a different way?

/containers/down_tree/{uuid}
What does this do?

/containers/temperature/{uuid}
Is this asking for only the temperature?

/containers/tree_view/
Is this necessary because the response is not JSON?

/containers/up_tree/{uuid}
What does this do?

The plates view currently assumes each plate has a unique name but this is an invalid assumption.

In reality, the name is only unique for the type of plate. And each plate in the plates list is a particular instantiation of a plate type.

So we need unique identifiers that are relatively short and readable to refer to each plate.

Home Page

Collections

One of the things we should probably have on the home page is a list of all of the collections available.

This is the first view that one can have into the FreeGenes library.

If you're going to discover bioparts, you're probably going to start by looking through the collections.

Having these collections on the home page will be nice because it will help people get intrigued and will "show not tell" what the FreeGenes project really is.

Once someone clicks through to a collection, they'll be able to browse through the bioparts within it.

It'll probably also be useful to surface the total number of bioparts within the collection.

Top Bioparts

Maybe there should be another section that lists out the top bioparts that people are interested in.

This way, people can use the top bioparts as an interesting entry point for discovery.

Users

We could also include a list of organizations currently using FreeGenes.

This could include logos and potentially even testimonials.

Pages to add:

• /collections/create
• /parts/create
• /authors/create
• /plates/create
• /wells/create

Create buttons to add to collection pages:

• /collections
• /parts
• /authors
• /plates
• /wells

We need support for:

• creates
• updates
• deletes

For the following collections:

• Collections
• Parts
• Authors
• Plates
• Wells