Skip to content
This repository was archived by the owner on Oct 15, 2021. It is now read-only.

Documentation feedback - Updates required #18

Open
chrisguindon opened this issue Feb 12, 2020 · 1 comment
Open

Documentation feedback - Updates required #18

chrisguindon opened this issue Feb 12, 2020 · 1 comment
Assignees

Comments

@chrisguindon
Copy link
Member

  • 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

Screen Shot 2020-02-12 at 4 56 00 PM

@chrisguindon
Copy link
Member Author

Was this done?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants