Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix minor swagger inconsistencies #520

Merged
merged 4 commits into from
Nov 29, 2022
Merged

Fix minor swagger inconsistencies #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe734ae
fix minor swagger inconsistencies
gmelodie Nov 11, 2022
be99d1b
make /admin/peering consistent with other subgroups
gmelodie Nov 11, 2022
3ffdf66
remove tags that cause endpoints to show up twice on swagger
gmelodie Nov 11, 2022
d7306b7
docs: update swagger docs
gmelodie Nov 11, 2022
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
69 changes: 14 additions & 55 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "List all Peering peers",
"responses": {
Expand Down Expand Up @@ -143,9 +141,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Add peers on Peering Service",
"responses": {
Expand Down Expand Up @@ -175,9 +171,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Remove peers on Peering Service",
"parameters": [
Expand Down Expand Up @@ -223,9 +217,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Start Peering",
"responses": {
Expand Down Expand Up @@ -257,9 +249,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Check Peering Status",
"responses": {
Expand Down Expand Up @@ -291,9 +281,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Stop Peering",
"responses": {
Expand Down Expand Up @@ -765,13 +753,6 @@ const docTemplate = `{
"in": "path",
"required": true
},
{
"type": "string",
"description": "Content ID",
"name": "contentid",
"in": "path",
"required": true
},
{
"description": "Variable to use when filtering for files (must be either 'path' or 'content_id')",
"name": "body",
Expand Down Expand Up @@ -2184,42 +2165,18 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "Pin ID",
"description": "Pin ID to be replaced",
"name": "pinid",
"in": "path",
"required": true
},
{
"description": "CID of new pin",
"name": "cid",
"description": "New pin",
"name": "pin",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Name (filename) of new pin",
"name": "name",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Origins of new pin",
"name": "origins",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Meta information of new pin",
"name": "meta",
"in": "body",
"schema": {
"type": "string"
"$ref": "#/definitions/types.IpfsPin"
}
}
],
Expand Down Expand Up @@ -2510,7 +2467,8 @@ const docTemplate = `{
"type": "string",
"description": "Filter by miner",
"name": "miner",
"in": "path"
"in": "path",
"required": true
}
],
"responses": {
Expand Down Expand Up @@ -2551,7 +2509,8 @@ const docTemplate = `{
"type": "string",
"description": "Filter by miner",
"name": "miner",
"in": "path"
"in": "path",
"required": true
}
],
"responses": {
Expand Down
69 changes: 14 additions & 55 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "List all Peering peers",
"responses": {
Expand Down Expand Up @@ -136,9 +134,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Add peers on Peering Service",
"responses": {
Expand Down Expand Up @@ -168,9 +164,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Remove peers on Peering Service",
"parameters": [
Expand Down Expand Up @@ -216,9 +210,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Start Peering",
"responses": {
Expand Down Expand Up @@ -250,9 +242,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Check Peering Status",
"responses": {
Expand Down Expand Up @@ -284,9 +274,7 @@
"application/json"
],
"tags": [
"admin",
"peering",
"peers"
"admin"
],
"summary": "Stop Peering",
"responses": {
Expand Down Expand Up @@ -758,13 +746,6 @@
"in": "path",
"required": true
},
{
"type": "string",
"description": "Content ID",
"name": "contentid",
"in": "path",
"required": true
},
{
"description": "Variable to use when filtering for files (must be either 'path' or 'content_id')",
"name": "body",
Expand Down Expand Up @@ -2177,42 +2158,18 @@
"parameters": [
{
"type": "string",
"description": "Pin ID",
"description": "Pin ID to be replaced",
"name": "pinid",
"in": "path",
"required": true
},
{
"description": "CID of new pin",
"name": "cid",
"description": "New pin",
"name": "pin",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Name (filename) of new pin",
"name": "name",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Origins of new pin",
"name": "origins",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Meta information of new pin",
"name": "meta",
"in": "body",
"schema": {
"type": "string"
"$ref": "#/definitions/types.IpfsPin"
}
}
],
Expand Down Expand Up @@ -2503,7 +2460,8 @@
"type": "string",
"description": "Filter by miner",
"name": "miner",
"in": "path"
"in": "path",
"required": true
}
],
"responses": {
Expand Down Expand Up @@ -2544,7 +2502,8 @@
"type": "string",
"description": "Filter by miner",
"name": "miner",
"in": "path"
"in": "path",
"required": true
}
],
"responses": {
Expand Down
Loading