Skip to content

Commit

Permalink
Update apidocs according to ms-89
Browse files Browse the repository at this point in the history
  • Loading branch information
Przemysław Hejman committed Apr 5, 2023
1 parent bfd8ba4 commit a40646d
Show file tree
Hide file tree
Showing 4 changed files with 555 additions and 167 deletions.
4 changes: 2 additions & 2 deletions Makefile
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
SHELL := /bin/bash
export GO111MODULE ?= on
export VERSION ?= v1.13.0
export VERSION ?= v1.19.0
export ECE_VERSION ?= $(shell cat ECE_VERSION)
export ECE_BRANCH ?= ms-81
export ECE_BRANCH ?= ms-89
ECE_DEF_FILE ?= api/version/$(ECE_VERSION).md
export GOBIN = $(shell pwd)/bin
BINARY := cloud-sdk-go
Expand Down
240 changes: 236 additions & 4 deletions api/apidocs-user.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1599,6 +1599,151 @@
}
}
},
"/deployments/traffic-filter/link-ids" : {
"get" : {
"tags" : [ "DeploymentsTrafficFilter" ],
"summary" : "List traffic filter claimed link id",
"description" : "List all of the traffic filter claimed link id.",
"operationId" : "get-traffic-filter-claimed-link-ids",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "region",
"in" : "query",
"description" : "If provided limits the claimed id to that region only.",
"required" : false,
"type" : "string"
}, {
"name" : "organization_id",
"in" : "query",
"description" : "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The collection of traffic filter claimed link id",
"schema" : {
"$ref" : "#/definitions/TrafficFilterClaimedLinkIds"
}
},
"500" : {
"description" : "Error fetching traffic filter claimed link ids. (code: `traffic_filter_claimed_link_id.request_execution_failed`)",
"headers" : {
"x-cloud-error-codes" : {
"type" : "string",
"description" : "The error codes associated with the response",
"enum" : [ "traffic_filter_claimed_link_id.request_execution_failed" ]
}
},
"schema" : {
"$ref" : "#/definitions/BasicFailedReply"
}
}
},
"x-doc" : {
"tag" : "Deployments - Traffic Filter Claimed Link Id"
}
}
},
"/deployments/traffic-filter/link-ids/_claim" : {
"post" : {
"tags" : [ "DeploymentsTrafficFilter" ],
"summary" : "Claim a link id",
"description" : "Claim the ownership of a link id.",
"operationId" : "claim-traffic-filter-link-id",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The specification for traffic filter claimed link id.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TrafficFilterClaimedLinkIdRequest"
}
} ],
"responses" : {
"201" : {
"description" : "The ruleset definition is valid and the creation has started.",
"schema" : {
"$ref" : "#/definitions/TrafficFilterClaimedLinkIdInfo"
}
},
"500" : {
"description" : "Error creating the traffic filter ruleset. (code: `traffic_filter_claimed_link_id.request_execution_failed`)",
"headers" : {
"x-cloud-error-codes" : {
"type" : "string",
"description" : "The error codes associated with the response",
"enum" : [ "traffic_filter_claimed_link_id.request_execution_failed" ]
}
},
"schema" : {
"$ref" : "#/definitions/BasicFailedReply"
}
}
},
"x-doc" : {
"tag" : "Deployments - Traffic Filter Claimed Link Id"
}
}
},
"/deployments/traffic-filter/link-ids/_unclaim" : {
"post" : {
"tags" : [ "DeploymentsTrafficFilter" ],
"summary" : "Unclaims a link id",
"description" : "Unclaims the ownership of a link id.",
"operationId" : "unclaim-traffic-filter-link-id",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The specification for traffic filter claimed link id.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TrafficFilterClaimedLinkIdRequest"
}
} ],
"responses" : {
"200" : {
"description" : "The claimed link id was successfully deleted.",
"schema" : {
"$ref" : "#/definitions/EmptyResponse"
}
},
"400" : {
"description" : "Error validating the request. (code: `traffic_filter_claimed_link_id.invalid_input`)",
"headers" : {
"x-cloud-error-codes" : {
"type" : "string",
"description" : "The error codes associated with the response",
"enum" : [ "traffic_filter_claimed_link_id.invalid_input" ]
}
},
"schema" : {
"$ref" : "#/definitions/BasicFailedReply"
}
},
"500" : {
"description" : "Error deleting the traffic filter claimed link id. (code: `traffic_filter_claimed_link_id.request_execution_failed`)",
"headers" : {
"x-cloud-error-codes" : {
"type" : "string",
"description" : "The error codes associated with the response",
"enum" : [ "traffic_filter_claimed_link_id.request_execution_failed" ]
}
},
"schema" : {
"$ref" : "#/definitions/BasicFailedReply"
}
}
},
"x-doc" : {
"tag" : "Deployments - Traffic Filter Claimed Link Id"
}
}
},
"/deployments/traffic-filter/rulesets" : {
"get" : {
"tags" : [ "DeploymentsTrafficFilter" ],
Expand Down Expand Up @@ -7708,15 +7853,15 @@
"memory_pressure" : {
"type" : "integer",
"format" : "int32",
"description" : "The % memory pressure of the service if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)"
"description" : "The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)"
},
"native_memory_pressure" : {
"type" : "integer",
"format" : "int32",
"description" : "The % native memory pressure of the service if available"
"description" : "The % memory pressure of the instance Docker container (if available)"
}
},
"description" : "Information about the memory capacity and use of the Kibana instance or APM Server."
"description" : "Information about the specific instances memory capacity and its usage"
},
"ClusterMetadataInfo" : {
"type" : "object",
Expand Down Expand Up @@ -11893,6 +12038,20 @@
"items" : {
"type" : "string"
}
},
"billing_contacts" : {
"type" : "array",
"description" : "The list of contacts for billing notifications, if specified",
"items" : {
"type" : "string"
}
},
"operational_contacts" : {
"type" : "array",
"description" : "The list of contacts for operational notifications, if specified",
"items" : {
"type" : "string"
}
}
},
"description" : "An organization"
Expand Down Expand Up @@ -12044,6 +12203,20 @@
"items" : {
"type" : "string"
}
},
"billing_contacts" : {
"type" : "array",
"description" : "The list of contacts for billing notifications",
"items" : {
"type" : "string"
}
},
"operational_contacts" : {
"type" : "array",
"description" : "The list of contacts for operational notifications",
"items" : {
"type" : "string"
}
}
},
"description" : "A request to create or update an organization"
Expand Down Expand Up @@ -13038,6 +13211,65 @@
},
"description" : "Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration."
},
"TrafficFilterClaimedLinkIdInfo" : {
"type" : "object",
"required" : [ "region" ],
"properties" : {
"link_id" : {
"type" : "string",
"description" : "Link id. A GCP private service connect ID or AWS VPC endpoint ID"
},
"azure_endpoint_name" : {
"type" : "string",
"description" : "Name of the Azure Private Endpoint to allow connections from"
},
"azure_endpoint_guid" : {
"type" : "string",
"description" : "Resource GUID of the Azure Private Endpoint to allow connections from"
},
"region" : {
"type" : "string",
"description" : "The claimed link id can be used only for traffic filter in the specific region"
}
}
},
"TrafficFilterClaimedLinkIdRequest" : {
"type" : "object",
"required" : [ "region" ],
"properties" : {
"link_id" : {
"type" : "string",
"description" : "Link id. A GCP private service connect ID or AWS VPC endpoint ID"
},
"azure_endpoint_name" : {
"type" : "string",
"description" : "Name of the Azure Private Endpoint to allow connections from"
},
"azure_endpoint_guid" : {
"type" : "string",
"description" : "Resource GUID of the Azure Private Endpoint to allow connections from"
},
"region" : {
"type" : "string",
"description" : "The claimed link id can be used only for traffic filter in the specific region"
}
},
"description" : "The specification for traffic filter claimed link id."
},
"TrafficFilterClaimedLinkIds" : {
"type" : "object",
"required" : [ "claimed_link_ids" ],
"properties" : {
"claimed_link_ids" : {
"type" : "array",
"description" : "List of traffic filter claimed link id",
"items" : {
"$ref" : "#/definitions/TrafficFilterClaimedLinkIdInfo"
}
}
},
"description" : "The container for a set of traffic filter claimed link id."
},
"TrafficFilterEgressRule" : {
"type" : "object",
"required" : [ "protocol", "target" ],
Expand Down Expand Up @@ -13257,7 +13489,7 @@
},
"cluster_settings_json" : {
"type" : "object",
"description" : "If specified, contains transient settings to be applied to an Elasticsearch cluster during changes, default values shown below applied.\nThese can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied.\nNOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).\n- indices.store.throttle.max_bytes_per_sec: 150Mb\n- indices.recovery.max_bytes_per_sec: 150Mb\n- cluster.routing.allocation.cluster_concurrent_rebalance: 10\n- cluster.routing.allocation.node_initial_primaries_recoveries: 8\n- cluster.routing.allocation.node_concurrent_incoming_recoveries: 8\n"
"description" : "If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied.\nThese can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied.\nNOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).\n- indices.store.throttle.max_bytes_per_sec: 120Mb\n- indices.recovery.max_bytes_per_sec: 120Mb\n- cluster.routing.allocation.cluster_concurrent_rebalance: 5\n- cluster.routing.allocation.node_initial_primaries_recoveries: 5\n- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5\nFor version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance."
}
},
"description" : "Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings."
Expand Down
Loading

0 comments on commit a40646d

Please sign in to comment.