Skip to content
This repository has been archived by the owner on May 11, 2024. It is now read-only.

feat(docs): update swag and swagger docs #482

Merged
merged 1 commit into from
Dec 26, 2023
Merged

feat(docs): update swag and swagger docs #482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,29 +60,6 @@ const docTemplate = `{
}
}
},
"/signedBlocks": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get signed blocks",
"operationId": "get-signed-blocks",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/prover_server.SignedBlock"
}
}
}
}
}
},
"/status": {
"get": {
"consumes": [
Expand Down Expand Up @@ -162,35 +139,9 @@ const docTemplate = `{
}
}
},
"prover_server.SignedBlock": {
"type": "object",
"properties": {
"blockHash": {
"type": "string"
},
"blockID": {
"type": "integer"
},
"proverAddress": {
"type": "string"
},
"signature": {
"type": "string"
}
}
},
"prover_server.Status": {
"type": "object",
"properties": {
"currentCapacity": {
"type": "integer"
},
"heartBeatSignature": {
"type": "array",
"items": {
"type": "integer"
}
},
"maxExpiry": {
"type": "integer"
},
Expand Down
49 changes: 0 additions & 49 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,6 @@
}
}
},
"/signedBlocks": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get signed blocks",
"operationId": "get-signed-blocks",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/prover_server.SignedBlock"
}
}
}
}
}
},
"/status": {
"get": {
"consumes": [
Expand Down Expand Up @@ -153,35 +130,9 @@
}
}
},
"prover_server.SignedBlock": {
"type": "object",
"properties": {
"blockHash": {
"type": "string"
},
"blockID": {
"type": "integer"
},
"proverAddress": {
"type": "string"
},
"signature": {
"type": "string"
}
}
},
"prover_server.Status": {
"type": "object",
"properties": {
"currentCapacity": {
"type": "integer"
},
"heartBeatSignature": {
"type": "array",
"items": {
"type": "integer"
}
},
"maxExpiry": {
"type": "integer"
},
Expand Down
32 changes: 0 additions & 32 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,8 @@ definitions:
type: integer
type: array
type: object
prover_server.SignedBlock:
properties:
blockHash:
type: string
blockID:
type: integer
proverAddress:
type: string
signature:
type: string
type: object
prover_server.Status:
properties:
currentCapacity:
type: integer
heartBeatSignature:
items:
type: integer
type: array
maxExpiry:
type: integer
minOptimisticTierFee:
Expand Down Expand Up @@ -101,21 +84,6 @@ paths:
schema:
type: string
summary: Try to accept a block proof assignment
/signedBlocks:
get:
consumes:
- application/json
operationId: get-signed-blocks
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/prover_server.SignedBlock'
type: array
summary: Get signed blocks
/status:
get:
consumes:
Expand Down