diff --git a/app/views/static/index.html.erb b/app/views/static/index.html.erb index d289912..cce9c97 100644 --- a/app/views/static/index.html.erb +++ b/app/views/static/index.html.erb @@ -7,31 +7,34 @@

TIMDEX is a free discovery API into collections at MIT Libraries.

-

This release provides discovery of records in MIT Libraries catalog and ArchivesSpace. We intend to expand the scope of collections discoverable via this API.

+

We currently provide searching of records in MIT Libraries catalog, DSpace@MIT, and MIT ArchivesSpace.

-

Interactive end user documentation is available for the REST API with Curl examples and live API calls against real production data.

- -

There is also a GraphQL endpoint by posting to <%= link_to(graphql_url) %> as well as an interactive GraphQL playground. It's neat, check it out!.

+

Access is via a GraphQL endpoint by posting to <%= link_to(graphql_url) %>. We recommend starting by exploring our interactive GraphQL playground. It's neat, check it out!.

Example query to use in the playground or your own app:

 {
-  search(searchterm: "spaceflight") {
+  search(searchterm: "learn graphql") {
     records {
-      sourceLink
       title
-      links {
-        text
-        url
-      }
+      sourceLink
+      summary
     }
   }
 }
+ +

Jumpstart this example query in the Playground

+

Additional examples and a tutorial on how to use this GraphQL API will be available soon.

+ +

REST API deprecated

+ +

Our deprecated REST API documentation is still available, but the REST endpoint will be going away entirely very soon (early 2023) and we highly recommend moving to GraphQL. If you need help migrating from REST to GraphQL please let us know

+

Feedback is welcome via timdex@mit.edu. Bug reports via the Github repository would be great.