Skip to content

Commit

Permalink
swagger gen
Browse files Browse the repository at this point in the history
  • Loading branch information
@KevinJoiner
KevinJoiner committed Oct 30, 2024
1 parent 6a48387 commit 5c013f7
Show file tree
Hide file tree
Showing 4 changed files with 336 additions and 388 deletions.
260 changes: 124 additions & 136 deletions docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ const docTemplate = `{
}
}
},
"/filenames": {
"post": {
"/v1/vehicle/{tokenId}/filenames": {
"get": {
"description": "Retrieves a list of filenames that match the provided search options",
"consumes": [
"application/json"
Expand All @@ -54,13 +54,34 @@ const docTemplate = `{
"summary": "Get multiple filenames based on search criteria",
"parameters": [
{
"description": "Search criteria and limit for finding files",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/internal_fetch_httphandler.SearchOptionsWithLimit"
}
"type": "string",
"name": "after",
"in": "query"
},
{
"type": "string",
"name": "before",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"name": "producer",
"in": "query"
},
{
"type": "string",
"name": "source",
"in": "query"
},
{
"type": "string",
"name": "type",
"in": "query"
}
],
"responses": {
Expand All @@ -77,7 +98,7 @@ const docTemplate = `{
}
},
"400": {
"description": "Invalid request body",
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
Expand All @@ -97,8 +118,8 @@ const docTemplate = `{
}
}
},
"/files": {
"post": {
"/v1/vehicle/{tokenId}/files": {
"get": {
"description": "Retrieves the content of multiple files that match the provided search options",
"consumes": [
"application/json"
Expand All @@ -112,13 +133,34 @@ const docTemplate = `{
"summary": "Get multiple files based on search criteria",
"parameters": [
{
"description": "Search criteria and limit for finding files",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/internal_fetch_httphandler.SearchOptionsWithLimit"
}
"type": "string",
"name": "after",
"in": "query"
},
{
"type": "string",
"name": "before",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"name": "producer",
"in": "query"
},
{
"type": "string",
"name": "source",
"in": "query"
},
{
"type": "string",
"name": "type",
"in": "query"
}
],
"responses": {
Expand All @@ -135,7 +177,7 @@ const docTemplate = `{
}
},
"400": {
"description": "Invalid request body",
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
Expand All @@ -155,8 +197,8 @@ const docTemplate = `{
}
}
},
"/latest-file": {
"post": {
"/v1/vehicle/{tokenId}/latest-file": {
"get": {
"description": "Retrieves the content of the most recent file that matches the provided search options",
"consumes": [
"application/json"
Expand All @@ -170,13 +212,34 @@ const docTemplate = `{
"summary": "Get the latest file based on search criteria",
"parameters": [
{
"description": "Search criteria for finding the latest file",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/indexrepo.SearchOptions"
}
"type": "string",
"name": "after",
"in": "query"
},
{
"type": "string",
"name": "before",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"name": "producer",
"in": "query"
},
{
"type": "string",
"name": "source",
"in": "query"
},
{
"type": "string",
"name": "type",
"in": "query"
}
],
"responses": {
Expand All @@ -193,7 +256,7 @@ const docTemplate = `{
}
},
"400": {
"description": "Invalid request body",
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
Expand All @@ -213,8 +276,8 @@ const docTemplate = `{
}
}
},
"/latest-filename": {
"post": {
"/v1/vehicle/{tokenId}/latest-filename": {
"get": {
"description": "Retrieves the most recent filename that matches the provided search options",
"consumes": [
"application/json"
Expand All @@ -228,13 +291,34 @@ const docTemplate = `{
"summary": "Get the latest filename based on search criteria",
"parameters": [
{
"description": "Search criteria for finding the latest file",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/indexrepo.SearchOptions"
}
"type": "string",
"name": "after",
"in": "query"
},
{
"type": "string",
"name": "before",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"name": "producer",
"in": "query"
},
{
"type": "string",
"name": "source",
"in": "query"
},
{
"type": "string",
"name": "type",
"in": "query"
}
],
"responses": {
Expand All @@ -248,7 +332,7 @@ const docTemplate = `{
}
},
"400": {
"description": "Invalid request body",
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
Expand All @@ -269,102 +353,6 @@ const docTemplate = `{
}
}
},
"definitions": {
"indexrepo.SearchOptions": {
"type": "object",
"properties": {
"after": {
"description": "After if set only files after this time are returned.",
"type": "string"
},
"before": {
"description": "Before if set only files before this time are returned.",
"type": "string"
},
"dataType": {
"description": "DataType if set only files for this data type are returned.",
"type": "string"
},
"optional": {
"description": "Optional is the optional data for additional metadata.",
"type": "string"
},
"primaryFiller": {
"description": "PrimaryFiller if set only files for this primary filler are returned.",
"type": "string"
},
"producer": {
"description": "Producer is the specific source entity that created the data.",
"type": "string"
},
"secondaryFiller": {
"description": "SecondaryFiller if set only files for this secondary filler are returned.",
"type": "string"
},
"source": {
"description": "Source is the party responsible for creating the data.",
"type": "string"
},
"subject": {
"description": "Subject if set only files for this subject are returned.",
"type": "string"
},
"timestampAsc": {
"description": "TimestampAsc if set files are queried and returned in ascending order by timestamp.\nThis option is not applied for the latest file query.",
"type": "boolean"
}
}
},
"internal_fetch_httphandler.SearchOptionsWithLimit": {
"type": "object",
"properties": {
"after": {
"description": "After if set only files after this time are returned.",
"type": "string"
},
"before": {
"description": "Before if set only files before this time are returned.",
"type": "string"
},
"dataType": {
"description": "DataType if set only files for this data type are returned.",
"type": "string"
},
"limit": {
"type": "integer",
"example": 10
},
"optional": {
"description": "Optional is the optional data for additional metadata.",
"type": "string"
},
"primaryFiller": {
"description": "PrimaryFiller if set only files for this primary filler are returned.",
"type": "string"
},
"producer": {
"description": "Producer is the specific source entity that created the data.",
"type": "string"
},
"secondaryFiller": {
"description": "SecondaryFiller if set only files for this secondary filler are returned.",
"type": "string"
},
"source": {
"description": "Source is the party responsible for creating the data.",
"type": "string"
},
"subject": {
"description": "Subject if set only files for this subject are returned.",
"type": "string"
},
"timestampAsc": {
"description": "TimestampAsc if set files are queried and returned in ascending order by timestamp.\nThis option is not applied for the latest file query.",
"type": "boolean"
}
}
}
},
"securityDefinitions": {
"BearerAuth": {
"type": "apiKey",
Expand Down
Loading

0 comments on commit 5c013f7

Please sign in to comment.