storj/private/apigen
Moby von Briesen 8acb1ee5bf private/apigen: Support basic doc generation
Add some code to generate a basic markdown file documenting a generated
API. Generate this document for the API in
satellite/console/consoleweb/consoleapi/gen.

The documentation is not completely correct, as it may include some
values in the request body that are not actually usable by the
requester. This can be fixed by making sure all types used within the
generated API are properly annotated with `json` tags.

Issue: https://github.com/storj/storj-private/issues/244

Change-Id: I57b259967fb0db8f548b6598a10c825da15ba723
2023-06-13 08:48:06 +00:00
..
example private/apigen: Change order of operations in api generation 2023-01-11 16:54:53 +00:00
common.go private/apigen: isolate TypeScript class generation 2023-03-10 21:52:30 +00:00
docgen.go private/apigen: Support basic doc generation 2023-06-13 08:48:06 +00:00
endpoint.go {private,satellite}: add Typescript generation to REST API generation 2022-08-18 16:37:48 +00:00
gogen_test.go all: fix deprecated ioutil commands 2022-10-11 15:27:29 +00:00
gogen.go private/apigen: isolate TypeScript class generation 2023-03-10 21:52:30 +00:00
tsgen.go private/apigen: isolate TypeScript class generation 2023-03-10 21:52:30 +00:00
tstypes.go private/apigen: isolate TypeScript class generation 2023-03-10 21:52:30 +00:00