search

SteeltoeOSS / InitializrService

Reference implementation of a Steeltoe Initializr Server project generator
Apache License 2.0
5 stars 2 forks source link

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

Open ccheetham opened 3 years ago

ccheetham commented 3 years ago

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