docs
docs
import "github.com/cloudfoundry/go-cf-api/internal/api/docs"
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
Index
Variables
SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "3.0.0",
Host: "localhost:8080",
BasePath: "/v3",
Schemes: []string{},
Title: "CF API",
Description: "CAPI V3 Compatible API with blazing fast backend.",
}
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/buildpacks": {
"post": {
"description": "Create a new buildpack",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Buildpacks"
],
"summary": "Create a buildpack",
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/buildpacks.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/v3.CfAPIError"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/v3.CfAPIError"
}
}
}
}
},
"/buildpacks/{guid}": {
"get": {
"description": "Retrieve all buildpacks the user has access to.",
"tags": [
"Buildpacks"
],
"summary": "Show a buildpack",
"parameters": [
{
"type": "string",
"description": "Buildpack GUID",
"name": "guid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/buildpacks.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/v3.CfAPIError"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/v3.CfAPIError"
}
}
}
}
},
"/healthz": {
"get": {
"description": "Health endpoint to check platform availability",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Health"
],
"summary": "Health get health",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/echo.HTTPError"
}
}
}
}
}
},
"definitions": {
"buildpacks.Response": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"enabled": {
"$ref": "#/definitions/null.Bool"
},
"filename": {
"$ref": "#/definitions/null.String"
},
"guid": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"$ref": "#/definitions/pagination.Link"
},
"upload": {
"$ref": "#/definitions/pagination.Link"
}
}
},
"locked": {
"$ref": "#/definitions/null.Bool"
},
"metadata": {
"$ref": "#/definitions/metadata.Metadata"
},
"name": {
"type": "string"
},
"position": {
"type": "integer"
},
"stack": {
"$ref": "#/definitions/null.String"
},
"state": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"echo.HTTPError": {
"type": "object",
"properties": {
"message": {}
}
},
"metadata.Map": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/null.String"
}
},
"metadata.Metadata": {
"type": "object",
"properties": {
"annotations": {
"$ref": "#/definitions/metadata.Map"
},
"labels": {
"$ref": "#/definitions/metadata.Map"
}
}
},
"null.Bool": {
"type": "object",
"properties": {
"bool": {
"type": "boolean"
},
"valid": {
"type": "boolean"
}
}
},
"null.String": {
"type": "object",
"properties": {
"string": {
"type": "string"
},
"valid": {
"type": "boolean"
}
}
},
"pagination.Link": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"method": {
"type": "string"
}
}
},
"v3.CfAPIError": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"detail": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"BasicAuth": {
"type": "basic"
}
},
"x-extension-openapi": {
"example": "value on a json format"
}
}`
func init
func init()
type s
type s struct{}
func (*s) ReadDoc
func (s *s) ReadDoc() string
type swaggerInfo
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
Generated by gomarkdoc