mirror of
https://github.com/paralus/paralus.git
synced 2026-08-24 15:47:19 +00:00
1353 lines
39 KiB
JSON
1353 lines
39 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Location Service",
|
|
"version": "3.0",
|
|
"contact": {
|
|
"name": "Paralus Dev"
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "LocationService"
|
|
}
|
|
],
|
|
"schemes": [
|
|
"https"
|
|
],
|
|
"consumes": [
|
|
"application/json",
|
|
"application/yaml"
|
|
],
|
|
"produces": [
|
|
"application/json",
|
|
"application/yaml"
|
|
],
|
|
"paths": {
|
|
"/infra/v3/partner/{metadata.partner}/location": {
|
|
"get": {
|
|
"operationId": "LocationService_GetLocations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/v3LocationList"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Returned when the user does not have permission to access the resource.",
|
|
"schema": {}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "metadata.partner",
|
|
"description": "Partner to which the resource belongs",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apiVersion",
|
|
"description": "API Version\n\nAPI Version of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3"
|
|
},
|
|
{
|
|
"name": "kind",
|
|
"description": "Kind\n\nKind of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "Location"
|
|
},
|
|
{
|
|
"name": "metadata.name",
|
|
"description": "Name\n\nname of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.displayName",
|
|
"description": "Display Name\n\ndisplay name of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.description",
|
|
"description": "Description\n\ndescription of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.project",
|
|
"description": "Project\n\nProject of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.organization",
|
|
"description": "Organization\n\nOrganization to which the resource belongs",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.urlScope",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.createdAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "metadata.modifiedAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "spec.id",
|
|
"description": "ID of Location\n\nID Location of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.name",
|
|
"description": "Location\n\nLocation of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.city",
|
|
"description": "City\n\nCity of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.state",
|
|
"description": "State\n\nState of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.country",
|
|
"description": "Country\n\ncountry of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.locale",
|
|
"description": "Locale\n\nlocale of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.latitude",
|
|
"description": "Latitude\n\nLatitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.longitude",
|
|
"description": "Longitude\n\nLongitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.countryCode",
|
|
"description": "CountryCode\n\nCountryCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.stateCode",
|
|
"description": "StateCode\n\nStateCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionType",
|
|
"description": "Condition Type\n\ntype of the status condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionStatus",
|
|
"description": "Condition Status\n\nstatus of the condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"enum": [
|
|
"StatusNotSet",
|
|
"StatusSubmitted",
|
|
"StatusOK",
|
|
"StatusFailed"
|
|
],
|
|
"default": "StatusNotSet"
|
|
},
|
|
{
|
|
"name": "status.lastUpdated",
|
|
"description": "Last Updated\n\nwhen the condition status is last updated",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "status.reason",
|
|
"description": "Reason\n\nreason of the last condition status",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"LocationService"
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "LocationService_CreateLocation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/infrav3Location"
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Returned when location is created successfully.",
|
|
"schema": {}
|
|
},
|
|
"403": {
|
|
"description": "Returned when the user does not have permission to access the resource.",
|
|
"schema": {}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "metadata.partner",
|
|
"description": "Partner to which the resource belongs",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3",
|
|
"description": "API Version of the resource",
|
|
"title": "API Version",
|
|
"readOnly": true
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "Location",
|
|
"description": "Kind of the resource",
|
|
"title": "Kind",
|
|
"readOnly": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"example": {
|
|
"name": "some-name",
|
|
"project": "defaultproject"
|
|
},
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "name of the resource",
|
|
"title": "Name"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"description": "display name of the resource",
|
|
"title": "Display Name"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "description of the resource",
|
|
"title": "Description"
|
|
},
|
|
"labels": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "labels of the resource",
|
|
"title": "Labels"
|
|
},
|
|
"annotations": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "annotations of the resource",
|
|
"title": "Annotations"
|
|
},
|
|
"project": {
|
|
"type": "string",
|
|
"description": "Project of the resource",
|
|
"title": "Project"
|
|
},
|
|
"organization": {
|
|
"type": "string",
|
|
"description": "Organization to which the resource belongs",
|
|
"title": "Organization"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"urlScope": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "metadata of the resource",
|
|
"title": "Metadata"
|
|
},
|
|
"spec": {
|
|
"$ref": "#/definitions/v3Metro",
|
|
"description": "Spec of the resource",
|
|
"title": "Spec"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/commonv3Status",
|
|
"description": "Status of the resource",
|
|
"title": "Status",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "Location",
|
|
"title": "Location",
|
|
"required": [
|
|
"apiVersion",
|
|
"kind",
|
|
"metadata",
|
|
"spec",
|
|
"name",
|
|
"project"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"LocationService"
|
|
]
|
|
}
|
|
},
|
|
"/infra/v3/partner/{metadata.partner}/location/{metadata.name}": {
|
|
"get": {
|
|
"operationId": "LocationService_GetLocation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/infrav3Location"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Returned when the user does not have permission to access the resource.",
|
|
"schema": {}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "metadata.partner",
|
|
"description": "Partner to which the resource belongs",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.name",
|
|
"description": "name of the resource",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apiVersion",
|
|
"description": "API Version\n\nAPI Version of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3"
|
|
},
|
|
{
|
|
"name": "kind",
|
|
"description": "Kind\n\nKind of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "Location"
|
|
},
|
|
{
|
|
"name": "metadata.displayName",
|
|
"description": "Display Name\n\ndisplay name of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.description",
|
|
"description": "Description\n\ndescription of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.project",
|
|
"description": "Project\n\nProject of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.organization",
|
|
"description": "Organization\n\nOrganization to which the resource belongs",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.urlScope",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.createdAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "metadata.modifiedAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "spec.id",
|
|
"description": "ID of Location\n\nID Location of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.name",
|
|
"description": "Location\n\nLocation of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.city",
|
|
"description": "City\n\nCity of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.state",
|
|
"description": "State\n\nState of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.country",
|
|
"description": "Country\n\ncountry of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.locale",
|
|
"description": "Locale\n\nlocale of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.latitude",
|
|
"description": "Latitude\n\nLatitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.longitude",
|
|
"description": "Longitude\n\nLongitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.countryCode",
|
|
"description": "CountryCode\n\nCountryCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.stateCode",
|
|
"description": "StateCode\n\nStateCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionType",
|
|
"description": "Condition Type\n\ntype of the status condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionStatus",
|
|
"description": "Condition Status\n\nstatus of the condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"enum": [
|
|
"StatusNotSet",
|
|
"StatusSubmitted",
|
|
"StatusOK",
|
|
"StatusFailed"
|
|
],
|
|
"default": "StatusNotSet"
|
|
},
|
|
{
|
|
"name": "status.lastUpdated",
|
|
"description": "Last Updated\n\nwhen the condition status is last updated",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "status.reason",
|
|
"description": "Reason\n\nreason of the last condition status",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"LocationService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "LocationService_DeleteLocation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/infrav3Location"
|
|
}
|
|
},
|
|
"204": {
|
|
"description": "Returned when organization is deleted successfully.",
|
|
"schema": {}
|
|
},
|
|
"403": {
|
|
"description": "Returned when the user does not have permission to access the resource.",
|
|
"schema": {}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "metadata.partner",
|
|
"description": "Partner to which the resource belongs",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.name",
|
|
"description": "name of the resource",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apiVersion",
|
|
"description": "API Version\n\nAPI Version of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3"
|
|
},
|
|
{
|
|
"name": "kind",
|
|
"description": "Kind\n\nKind of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string",
|
|
"default": "Location"
|
|
},
|
|
{
|
|
"name": "metadata.displayName",
|
|
"description": "Display Name\n\ndisplay name of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.description",
|
|
"description": "Description\n\ndescription of the resource",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.project",
|
|
"description": "Project\n\nProject of the resource",
|
|
"in": "query",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.organization",
|
|
"description": "Organization\n\nOrganization to which the resource belongs",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.urlScope",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.createdAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "metadata.modifiedAt",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "spec.id",
|
|
"description": "ID of Location\n\nID Location of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.name",
|
|
"description": "Location\n\nLocation of the cluster",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.city",
|
|
"description": "City\n\nCity of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.state",
|
|
"description": "State\n\nState of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.country",
|
|
"description": "Country\n\ncountry of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.locale",
|
|
"description": "Locale\n\nlocale of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.latitude",
|
|
"description": "Latitude\n\nLatitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.longitude",
|
|
"description": "Longitude\n\nLongitude of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.countryCode",
|
|
"description": "CountryCode\n\nCountryCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "spec.stateCode",
|
|
"description": "StateCode\n\nStateCode of the location",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionType",
|
|
"description": "Condition Type\n\ntype of the status condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "status.conditionStatus",
|
|
"description": "Condition Status\n\nstatus of the condition",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"enum": [
|
|
"StatusNotSet",
|
|
"StatusSubmitted",
|
|
"StatusOK",
|
|
"StatusFailed"
|
|
],
|
|
"default": "StatusNotSet"
|
|
},
|
|
{
|
|
"name": "status.lastUpdated",
|
|
"description": "Last Updated\n\nwhen the condition status is last updated",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "status.reason",
|
|
"description": "Reason\n\nreason of the last condition status",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"LocationService"
|
|
]
|
|
},
|
|
"put": {
|
|
"operationId": "LocationService_UpdateLocation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/infrav3Location"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Returned when the user does not have permission to access the resource.",
|
|
"schema": {}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "metadata.partner",
|
|
"description": "Partner to which the resource belongs",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "metadata.name",
|
|
"description": "name of the resource",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3",
|
|
"description": "API Version of the resource",
|
|
"title": "API Version",
|
|
"readOnly": true
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "Location",
|
|
"description": "Kind of the resource",
|
|
"title": "Kind",
|
|
"readOnly": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"example": {
|
|
"name": "some-name",
|
|
"project": "defaultproject"
|
|
},
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string",
|
|
"description": "display name of the resource",
|
|
"title": "Display Name"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "description of the resource",
|
|
"title": "Description"
|
|
},
|
|
"labels": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "labels of the resource",
|
|
"title": "Labels"
|
|
},
|
|
"annotations": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "annotations of the resource",
|
|
"title": "Annotations"
|
|
},
|
|
"project": {
|
|
"type": "string",
|
|
"description": "Project of the resource",
|
|
"title": "Project"
|
|
},
|
|
"organization": {
|
|
"type": "string",
|
|
"description": "Organization to which the resource belongs",
|
|
"title": "Organization"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"urlScope": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "metadata of the resource",
|
|
"title": "Metadata"
|
|
},
|
|
"spec": {
|
|
"$ref": "#/definitions/v3Metro",
|
|
"description": "Spec of the resource",
|
|
"title": "Spec"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/commonv3Status",
|
|
"description": "Status of the resource",
|
|
"title": "Status",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "Location",
|
|
"title": "Location",
|
|
"required": [
|
|
"apiVersion",
|
|
"kind",
|
|
"metadata",
|
|
"spec",
|
|
"project"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"LocationService"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"commonv3Status": {
|
|
"type": "object",
|
|
"properties": {
|
|
"conditionType": {
|
|
"type": "string",
|
|
"description": "type of the status condition",
|
|
"title": "Condition Type",
|
|
"readOnly": true
|
|
},
|
|
"conditionStatus": {
|
|
"$ref": "#/definitions/v3ConditionStatus",
|
|
"enum": [
|
|
"StatusNotSet",
|
|
"StatusSubmitted",
|
|
"StatusOK",
|
|
"StatusFailed"
|
|
],
|
|
"description": "status of the condition",
|
|
"title": "Condition Status",
|
|
"readOnly": true
|
|
},
|
|
"lastUpdated": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "when the condition status is last updated",
|
|
"title": "Last Updated",
|
|
"readOnly": true
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "reason of the last condition status",
|
|
"title": "Reason",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "status of a resource",
|
|
"title": "Status",
|
|
"readOnly": true
|
|
},
|
|
"googlerpcStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"infrav3Location": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3",
|
|
"description": "API Version of the resource",
|
|
"title": "API Version",
|
|
"readOnly": true
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "Location",
|
|
"description": "Kind of the resource",
|
|
"title": "Kind",
|
|
"readOnly": true
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/definitions/v3Metadata",
|
|
"description": "Metadata of the resource",
|
|
"title": "Metadata"
|
|
},
|
|
"spec": {
|
|
"$ref": "#/definitions/v3Metro",
|
|
"description": "Spec of the resource",
|
|
"title": "Spec"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/commonv3Status",
|
|
"description": "Status of the resource",
|
|
"title": "Status",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "Location",
|
|
"title": "Location",
|
|
"required": [
|
|
"apiVersion",
|
|
"kind",
|
|
"metadata",
|
|
"spec"
|
|
]
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": {}
|
|
},
|
|
"v3ConditionStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"StatusNotSet",
|
|
"StatusSubmitted",
|
|
"StatusOK",
|
|
"StatusFailed"
|
|
],
|
|
"default": "StatusNotSet",
|
|
"title": "$title: ConditionStatus\n$description: status of a condition for a resource"
|
|
},
|
|
"v3ListMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"count": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
},
|
|
"offset": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
},
|
|
"limit": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled"
|
|
},
|
|
"v3LocationList": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string",
|
|
"default": "infra.k8smgmt.io/v3",
|
|
"description": "API Version of the list resource",
|
|
"title": "API Version",
|
|
"readOnly": true
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "LocationList",
|
|
"description": "Kind of the list resource",
|
|
"title": "Kind",
|
|
"readOnly": true
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/definitions/v3ListMetadata",
|
|
"description": "Metadata of the list resource",
|
|
"title": "ListMetadata",
|
|
"readOnly": true
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/v3Metro",
|
|
"readOnly": true
|
|
},
|
|
"description": "List of the resources",
|
|
"title": "Items"
|
|
}
|
|
}
|
|
},
|
|
"v3Metadata": {
|
|
"type": "object",
|
|
"example": {
|
|
"name": "some-name",
|
|
"project": "defaultproject"
|
|
},
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "name of the resource",
|
|
"title": "Name"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"description": "display name of the resource",
|
|
"title": "Display Name"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "description of the resource",
|
|
"title": "Description"
|
|
},
|
|
"labels": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "labels of the resource",
|
|
"title": "Labels"
|
|
},
|
|
"annotations": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "annotations of the resource",
|
|
"title": "Annotations"
|
|
},
|
|
"project": {
|
|
"type": "string",
|
|
"description": "Project of the resource",
|
|
"title": "Project"
|
|
},
|
|
"organization": {
|
|
"type": "string",
|
|
"description": "Organization to which the resource belongs",
|
|
"title": "Organization"
|
|
},
|
|
"partner": {
|
|
"type": "string",
|
|
"description": "Partner to which the resource belongs",
|
|
"title": "Partner"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"urlScope": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "metadata of the resource",
|
|
"title": "Metadata",
|
|
"required": [
|
|
"name",
|
|
"project"
|
|
]
|
|
},
|
|
"v3Metro": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "ID Location of the cluster",
|
|
"title": "ID of Location"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Location of the cluster",
|
|
"title": "Location"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"description": "City of the location",
|
|
"title": "City",
|
|
"readOnly": true
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"description": "State of the location",
|
|
"title": "State",
|
|
"readOnly": true
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"description": "country of the location",
|
|
"title": "Country",
|
|
"readOnly": true
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"description": "locale of the location",
|
|
"title": "Locale",
|
|
"readOnly": true
|
|
},
|
|
"latitude": {
|
|
"type": "string",
|
|
"description": "Latitude of the location",
|
|
"title": "Latitude",
|
|
"readOnly": true
|
|
},
|
|
"longitude": {
|
|
"type": "string",
|
|
"description": "Longitude of the location",
|
|
"title": "Longitude",
|
|
"readOnly": true
|
|
},
|
|
"countryCode": {
|
|
"type": "string",
|
|
"description": "CountryCode of the location",
|
|
"title": "CountryCode",
|
|
"readOnly": true
|
|
},
|
|
"stateCode": {
|
|
"type": "string",
|
|
"description": "StateCode of the location",
|
|
"title": "StateCode",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"ApiKeyAuth": {
|
|
"type": "apiKey",
|
|
"name": "X-PARALUS-API-KEYID",
|
|
"in": "header"
|
|
},
|
|
"BasicAuth": {
|
|
"type": "basic"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"ApiKeyAuth": [],
|
|
"BasicAuth": []
|
|
}
|
|
]
|
|
}
|