diff --git a/README.md b/README.md index f64397b..ed2dd82 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,8 @@ particular order so as not to break production services. ### Automatic generation from openapi specification -- Sign into stoplight.io with an account that has access to the MIT Libraries organization -- copy the source of `openapi.json` file from this repository to the code tab in our [stoplight model](https://next.stoplight.io/mit-libraries/timdex/version%2F1.0/openapi.oas3.yml) -- In [Stoplight's Publish](https://next.stoplight.io/mit-libraries/timdex/version%2F1.0/timdex.hub.yml?view=/&show=publish&domain=mitlibraries-timdex.docs.stoplight.io) section, Uncheck "set live" and then click "Build" -- Once docs are built, check they are sane with the preview feature then click "set live" - +We are using Swagger UI to automatically generate documentation from the `openapi.json` file in GitHub Pages. The HTML +file is in `docs/index.html` and the `openapi.json` file always pulls from the `main` branch. ## Required Environment Variables (all ENVs) - `EMAIL_FROM`: email address to send message from, including the registration diff --git a/app/views/static/index.html.erb b/app/views/static/index.html.erb index 7355848..d289912 100644 --- a/app/views/static/index.html.erb +++ b/app/views/static/index.html.erb @@ -7,9 +7,9 @@

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

-

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

+

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

-

Interactive end user documentation is available for the REST API with selectable language code samples and live API calls against real production data.

+

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!.

diff --git a/docs/index.html b/docs/index.html index b4f6f09..db29e91 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,61 +1,22 @@ - - - TIMDEX API Documentationd - - - - - - + + + + MIT Libraries TIMDEX API Documentation + -
- + + window.onload = () => { + window.ui = SwaggerUIBundle({ + url: "https://raw.githubusercontent.com/MITLibraries/timdex/main/openapi.json", + dom_id: "#swagger-ui", + }); + }; + diff --git a/docs/rapidoc.html b/docs/rapidoc.html deleted file mode 100644 index 5b1ea7d..0000000 --- a/docs/rapidoc.html +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - diff --git a/docs/redoc.html b/docs/redoc.html deleted file mode 100644 index 84de608..0000000 --- a/docs/redoc.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - ReDoc - - - - - - - - - - - - - - - - - - -