Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Commit

Permalink
fixed errors in swagger definition of shipyard controller (#3530)
Browse files Browse the repository at this point in the history
* fixed paths and typos

Signed-off-by: warber <bernd.warmuth@dynatrace.com>

* updated docs folder

Signed-off-by: warber <bernd.warmuth@dynatrace.com>
  • Loading branch information
warber committed Mar 16, 2021
1 parent b7a1983 commit c281042
Show file tree
Hide file tree
Showing 6 changed files with 78 additions and 206 deletions.
103 changes: 27 additions & 76 deletions shipyard-controller/docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -513,93 +513,32 @@ var doc = `{
}
}
},
"/project/{project}/service/{stage}": {
"/project/{project}/stage": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Gets all services of a stage in a project",
"description": "Get the list of stages of a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Services"
"Stage"
],
"summary": "Gets all services of a stage in a project",
"summary": "Get all stages of a project",
"parameters": [
{
"type": "string",
"description": "Project",
"description": "The name of the project",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Stage",
"name": "stage",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The number of items to return",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"description": "Pointer to the next set of items",
"name": "nextPageKey",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/models.ExpandedServices"
}
},
"400": {
"description": "Invalid payload",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Error"
}
}
}
}
},
"/project/{project}/stage": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Get the list of stages of a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Stage"
],
"summary": "Get all stages of a project",
"parameters": [
{
"type": "integer",
"description": "The number of items to return",
Expand Down Expand Up @@ -648,48 +587,60 @@ var doc = `{
"ApiKeyAuth": []
}
],
"description": "Get a stage of a project",
"description": "Gets all services of a stage in a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Projects"
"Services"
],
"summary": "Get a stage",
"summary": "Gets all services of a stage in a project",
"parameters": [
{
"type": "string",
"description": "The name of the project",
"description": "Project",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The name of the stage",
"description": "Stage",
"name": "stage",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The number of items to return",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"description": "Pointer to the next set of items",
"name": "nextPageKey",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/models.ExpandedStage"
"$ref": "#/definitions/models.ExpandedServices"
}
},
"404": {
"description": "Not found",
"400": {
"description": "Invalid payload",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal Error)",
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Error"
}
Expand Down Expand Up @@ -764,7 +715,7 @@ var doc = `{
"post": {
"security": [
{
"ApiKeyAutth": []
"ApiKeyAuth": []
}
],
"description": "Trigger a new evaluation for a service within a project",
Expand Down
103 changes: 27 additions & 76 deletions shipyard-controller/docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -498,93 +498,32 @@
}
}
},
"/project/{project}/service/{stage}": {
"/project/{project}/stage": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Gets all services of a stage in a project",
"description": "Get the list of stages of a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Services"
"Stage"
],
"summary": "Gets all services of a stage in a project",
"summary": "Get all stages of a project",
"parameters": [
{
"type": "string",
"description": "Project",
"description": "The name of the project",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Stage",
"name": "stage",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The number of items to return",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"description": "Pointer to the next set of items",
"name": "nextPageKey",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/models.ExpandedServices"
}
},
"400": {
"description": "Invalid payload",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Error"
}
}
}
}
},
"/project/{project}/stage": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Get the list of stages of a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Stage"
],
"summary": "Get all stages of a project",
"parameters": [
{
"type": "integer",
"description": "The number of items to return",
Expand Down Expand Up @@ -633,48 +572,60 @@
"ApiKeyAuth": []
}
],
"description": "Get a stage of a project",
"description": "Gets all services of a stage in a project",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Projects"
"Services"
],
"summary": "Get a stage",
"summary": "Gets all services of a stage in a project",
"parameters": [
{
"type": "string",
"description": "The name of the project",
"description": "Project",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The name of the stage",
"description": "Stage",
"name": "stage",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "The number of items to return",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"description": "Pointer to the next set of items",
"name": "nextPageKey",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/models.ExpandedStage"
"$ref": "#/definitions/models.ExpandedServices"
}
},
"404": {
"description": "Not found",
"400": {
"description": "Invalid payload",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal Error)",
"description": "Internal error",
"schema": {
"$ref": "#/definitions/models.Error"
}
Expand Down Expand Up @@ -749,7 +700,7 @@
"post": {
"security": [
{
"ApiKeyAutth": []
"ApiKeyAuth": []
}
],
"description": "Trigger a new evaluation for a service within a project",
Expand Down

0 comments on commit c281042

Please sign in to comment.