OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(json): updated API descriptions

Browse Source
This commit is contained in:
Sebastian Thiel
2016-01-30 14:05:22 +01:00
parent a2c6b58d5b
commit 8f01e8e918
145 changed files with 50073 additions and 3975 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
etc/api/cloudtrace/v1/cloudtrace-api.json
View File

@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
"etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/aRfd7FZnMyWmSYyC0t8ruQh7iCI\"",
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hv7wO9t243cZnlaNc4LDNLDlWOU\"",
"discoveryVersion": "v1",
"id": "cloudtrace:v1",
"name": "cloudtrace",
"version": "v1",
"revision": "20150825",
"revision": "20151207",
"title": "Google Cloud Trace API",
"description": "The Google Cloud Trace API provides services for reading and writing runtime trace data for Cloud applications.",
"description": "The Cloud Trace API allows you to send traces to and retrieve traces from Google Cloud Trace.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -17,10 +17,11 @@
"documentationLink": "https://cloud.google.com/tools/cloud-trace",
"protocol": "rest",
"baseUrl": "https://cloudtrace.googleapis.com/",
"basePath": "/",
"basePath": "",
"rootUrl": "https://cloudtrace.googleapis.com/",
"servicePath": "",
"batchPath": "batch",
"version_module": true,
"parameters": {
"access_token": {
"type": "string",
@@ -113,37 +114,37 @@
"ListTracesResponse": {
"id": "ListTracesResponse",
"type": "object",
"description": "The response message for the ListTraces method.",
"description": "The response message for the `ListTraces` method.",
"properties": {
"traces": {
"type": "array",
"description": "The list of trace records returned.",
"description": "List of trace records returned.",
"items": {
"$ref": "Trace"
}
},
"nextPageToken": {
"type": "string",
"description": "If defined, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue."
"description": "If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces."
}
}
},
"Trace": {
"id": "Trace",
"type": "object",
"description": "A Trace is a collection of spans describing the execution timings of a single operation.",
"description": "A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.",
"properties": {
"projectId": {
"type": "string",
"description": "The Project ID of the Google Cloud project."
"description": "Project ID of the Cloud project where the trace data is stored."
},
"traceId": {
"type": "string",
"description": "A 128-bit numeric value, formatted as a 32-byte hex string, that represents a trace. Each trace should have an identifier that is globally unique."
"description": "Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string."
},
"spans": {
"type": "array",
"description": "The collection of span records within this trace. Spans that appear in calls to PatchTraces may be incomplete or partial.",
"description": "Collection of spans in the trace.",
"items": {
"$ref": "TraceSpan"
}
@@ -153,16 +154,16 @@
"TraceSpan": {
"id": "TraceSpan",
"type": "object",
"description": "A span is the data recorded with a single span.",
"description": "A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.",
"properties": {
"spanId": {
"type": "string",
"description": "Identifier of the span within the trace. Each span should have an identifier that is unique per trace.",
"description": "Identifier for the span. This identifier must be unique within a trace.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "SpanKind distinguishes spans generated in a particular context. For example, two spans with the same name, one with the kind RPC_CLIENT, and the other with RPC_SERVER can indicate the queueing latency associated with the span.",
"description": "Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.",
"enum": [
"SPAN_KIND_UNSPECIFIED",
"RPC_SERVER",
@@ -171,24 +172,24 @@
},
"name": {
"type": "string",
"description": "The name of the trace. This is sanitized and displayed on the UI. This may be a method name or some other per-callsite name. For the same binary and the same call point, it is a good practice to choose a consistent name in order to correlate cross-trace spans."
"description": "Name of the trace. The trace name is sanitized and displayed in the Cloud Trace tool in the Google Developers Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans."
},
"startTime": {
"type": "string",
"description": "The start time of the span in nanoseconds from the UNIX epoch."
"description": "Start time of the span in nanoseconds from the UNIX epoch."
},
"endTime": {
"type": "string",
"description": "The end time of the span in nanoseconds from the UNIX epoch."
"description": "End time of the span in nanoseconds from the UNIX epoch."
},
"parentSpanId": {
"type": "string",
"description": "Identifies the parent of the current span. May be missing. Serialized bytes representation of SpanId.",
"description": "ID of the parent span, if any. Optional.",
"format": "uint64"
},
"labels": {
"type": "object",
"description": "Annotations via labels.",
"description": "Collection of labels associated with the span.",
"additionalProperties": {
"type": "string"
}
@@ -198,11 +199,11 @@
"Traces": {
"id": "Traces",
"type": "object",
"description": "A list of traces for the PatchTraces method.",
"description": "List of new or updated traces.",
"properties": {
"traces": {
"type": "array",
"description": "A list of traces.",
"description": "List of traces.",
"items": {
"$ref": "Trace"
}
@@ -222,11 +223,11 @@
"id": "cloudtrace.projects.patchTraces",
"path": "v1/projects/{projectId}/traces",
"httpMethod": "PATCH",
"description": "Updates the existing traces specified by PatchTracesRequest and inserts the new traces. Any existing trace or span fields included in an update are overwritten by the update, and any additional fields in an update are merged with the existing trace data.",
"description": "Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.",
"parameters": {
"projectId": {
"type": "string",
"description": "The project id of the trace to patch.",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"location": "path"
}
@@ -252,17 +253,17 @@
"id": "cloudtrace.projects.traces.list",
"path": "v1/projects/{projectId}/traces",
"httpMethod": "GET",
"description": "List traces matching the filter expression.",
"description": "Returns of a list of traces that match the specified filter conditions.",
"parameters": {
"projectId": {
"type": "string",
"description": "The stringified-version of the project id.",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"location": "path"
},
"view": {
"type": "string",
"description": "ViewType specifies the projection of the result.",
"description": "Type of data returned for traces in the list. Optional. Default is `MINIMAL`.",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"MINIMAL",
@@ -273,23 +274,23 @@
},
"pageSize": {
"type": "integer",
"description": "Maximum number of topics to return. If not specified or \u003c= 0, the implementation will select a reasonable value. The implemenation may always return fewer than the requested page_size.",
"description": "Maximum number of traces to return. If not specified or \u003c= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "The token identifying the page of results to return from the ListTraces method. If present, this value is should be taken from the next_page_token field of a previous ListTracesResponse.",
"description": "Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional.",
"location": "query"
},
"startTime": {
"type": "string",
"description": "End of the time interval (inclusive).",
"description": "End of the time interval (inclusive) during which the trace data was collected from the application.",
"location": "query"
},
"endTime": {
"type": "string",
"description": "Start of the time interval (exclusive).",
"description": "Start of the time interval (inclusive) during which the trace data was collected from the application.",
"location": "query"
},
"filter": {
@@ -299,7 +300,7 @@
},
"orderBy": {
"type": "string",
"description": "The trace field used to establish the order of traces returned by the ListTraces method. Possible options are: trace_id name (name field of root span) duration (different between end_time and start_time fields of root span) start (start_time field of root span) Descending order can be specified by appending \"desc\" to the sort field: name desc Only one sort field is permitted, though this may change in the future.",
"description": "Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted.",
"location": "query"
}
},
@@ -317,17 +318,17 @@
"id": "cloudtrace.projects.traces.get",
"path": "v1/projects/{projectId}/traces/{traceId}",
"httpMethod": "GET",
"description": "Gets one trace by id.",
"description": "Gets a single trace by its ID.",
"parameters": {
"projectId": {
"type": "string",
"description": "The project id of the trace to return.",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"location": "path"
},
"traceId": {
"type": "string",
"description": "The trace id of the trace to return.",
"description": "ID of the trace to return.",
"required": true,
"location": "path"
}
@@ -346,40 +347,6 @@
}
}
}
},
"v1": {
"methods": {
"getDiscovery": {
"id": "cloudtrace.getDiscovery",
"path": "v1/discovery",
"httpMethod": "GET",
"description": "Returns a discovery document in the specified `format`. The typeurl in the returned google.protobuf.Any value depends on the requested format.",
"parameters": {
"format": {
"type": "string",
"description": "The format requested for discovery.",
"location": "query"
},
"labels": {
"type": "string",
"description": "A list of labels (like visibility) influencing the scope of the requested doc.",
"repeated": true,
"location": "query"
},
"version": {
"type": "string",
"description": "The API version of the requested discovery doc.",
"location": "query"
},
"args": {
"type": "string",
"description": "Any additional arguments.",
"repeated": true,
"location": "query"
}
}
}
}
}
}
}