eclipsefdn / api.eclipse.org-docs Goto Github PK

• Result definition should be moved to response section: https://api.eclipse.org/#tag/Projects
• Fix typos such as spec_project_working_group="" in the query params section
• Missing description for response headers
• Project params: add in one or two very specific (i.e., full path) examples for how to fetch a specific project. It's not clear to users that they need to replace periods with underscore
• missing description for some query params

I am very pleased with the end result of the Eclipse Marketplace API Specs and now, I would like to migrate this documentation to the OpenAPI Specifications.

Eric has already started working on this. My recommendation is to convert our current API using apimatic or a similar tool: https://www.apimatic.io/transformer/

Once this is done, we should mimic the work that was done on the marketplace-specs by leveraging https://www.npmjs.com/package/swagger-repo

If this exercise is successful, I will consider moving marketplace specs to this repo.

Hi,
The description of files and releases downloads is not clear to me.

• What files can be downloaded?
• How does one knows about the file_id?

I believe this is a documentation issue only.

Thanks, have a great day!

When looking into docs to see what different responses are possible, only status 200 is documented. We should document failure and error states as well.

Example: https://api.eclipse.org/#operation/RetrieveUser