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

Add endpoint information to /api/ endpoint help doc #62

Open
ccheetham opened this issue Nov 12, 2020 · 0 comments
Open

Add endpoint information to /api/ endpoint help doc #62

ccheetham opened this issue Nov 12, 2020 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@ccheetham
Copy link
Contributor

It would be helpful if the help doc contained something like the following:

+------------------------------+---------+------------------------------------------------+
| Endpoint                     | Methods | Description                                    +
+------------------------------+---------+------------------------------------------------+
| /api/                        | GET     | This document                                  |
| /api/project                 | GET     | Generated project                              |
|                              | POST    |                                                |
| /api/config                  | GET     | Configuration (project metadata and templates) |
| /api/config/projectMetadata  | GET     | Project metadata for smart clients             |
| /api/config/projectTemplates | GET     | Project template configuration                 |
| /api/config/steeltoeVersions | GET     | Steeltoe versions                              |
...

@ccheetham ccheetham added the enhancement New feature or request label Nov 12, 2020
@ccheetham ccheetham added this to the 1.0.0 GA milestone Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant