storj/private/apigen/example/apidocs.gen.md
Ivan Fraixedes 926076bffd private/apigen/example: Add description to endpoint
Add the description field to the endpoint to show where it ends up when
generating code.

Change-Id: I415f088dbf795656ed1ef042ed41ebf39a517692
2023-09-19 18:31:20 +00:00

994 B

API Docs

Description:

Version: v0

List of Endpoints

Update Content (go to full list)

Update the content of the document with the specified path and ID if the last update is before the indicated date

POST /api/v0/docs/{path}

Query Params:

name type elaboration
id string UUID formatted as 00000000-0000-0000-0000-000000000000
date string Date timestamp formatted as 2006-01-02T15:00:00Z

Path Params:

name type elaboration
path string

Request body:

{
	content: string
}

Response body:

{
	id: string // UUID formatted as `00000000-0000-0000-0000-000000000000`
	date: string // Date timestamp formatted as `2006-01-02T15:00:00Z`
	pathParam: string
	body: string
}