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

Please publish API docs in current UI #127

Open
justinedelson opened this issue May 15, 2020 · 3 comments
Open

Please publish API docs in current UI #127

justinedelson opened this issue May 15, 2020 · 3 comments

Comments

@justinedelson
Copy link

Thanks for creating an issue! Please fill out this form so we can be
sure to have all the information we need, and to minimize back and forth.

  • What are you trying to do?

Use the search.maven.org API but documentation links are only in the old UI (https://search.maven.org/classic/#api). This implies that the API isn't available anymore.

  • What feature or behavior is this required for?

API client access (Specifically I have an integration test that compares the current artifact to the previously released artifact, although I'm sure there are lots of other use cases)

  • How could we solve this issue? (Not knowing is okay!)

Add a "API Docs" link from https://search.maven.org/ :)

  • Anything else?
@SirMaster
Copy link
Contributor

@justinedelson neither the Bookmarkable URLs or the REST API parts have changed and are accessible for you to use. If there is a specific REST API request not working please let us know.

I do think we could add an page on our new UI with a Bookmarkable URLs section using the urls for the current UI, is that what you were meaning as well?

@justinedelson
Copy link
Author

@SirMaster This is not really about the APIs (or Bookmarkable URLs) per se. It is really about how that information is discovered. At present, to get to the API documents...

  1. Start on https://search.maven.org/
  2. Click on "Classic Search"
  3. Click on "API Guide"

This navigation path was, at least for me, non-intuitive. It also suggests (incorrectly I hope) that the API is somehow related to the "Classic" UI.

To be clear, everything is working and nothing is broken. There's just an opportunity to improve discoverability.

@SirMaster
Copy link
Contributor

@justinedelson ah ok, clear to me now. Yeah I think that is a very valid point, and I think we missed that totally. I hope we can do something for that in the near future. Thx again for submitting this.

This was referenced Oct 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants