Skip to content

Commit 3bf29a8

Browse files
singramadriancole
authored andcommitted
Added span.parentId parameter. Added descriptions for span parameter… (openzipkin#17)
Adds descriptions for span parameters and link to published API. Fixes openzipkin#16 * Field descriptions ammeded inline with review feedback.
1 parent 801b053 commit 3bf29a8

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Zipkin API
22

3-
[![Build Status](https://travis-ci.org/openzipkin/zipkin-api.svg?branch=master)](https://travis-ci.org/openzipkin/zipkin-api)
3+
[![Build Status](https://travis-ci.org/openzipkin/zipkin-api.svg?branch=master)](https://travis-ci.org/openzipkin/zipkin-api)
44

55
This repo only includes the [OpenAPI Spec](./zipkin-api.yaml) of the API for now.
6+
7+
* /api/v1 - Published [here](http://zipkin.io/zipkin-api/#/)

zipkin-api.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -248,17 +248,33 @@ definitions:
248248
properties:
249249
traceId:
250250
type: string
251+
maxLength: 16
252+
minLength: 16
253+
description: 'Randomly generated, unique for a trace, set on all spans within it. 8-byte identifier encoded as 16 lowercase hex characters'
251254
name:
252255
type: string
256+
description: 'Span name in lowercase (e.g. rpc method)'
257+
parentId:
258+
type: string
259+
maxLength: 16
260+
minLength: 16
261+
description: 'Parent span id. 8-byte identifier encoded as 16 lowercase hex characters. Can be ommitted or set to nil if span is the root span of a trace.'
253262
id:
254263
type: string
264+
maxLength: 16
265+
minLength: 16
266+
description: 'Id of current span, unique in context of traceId. 8-byte identifier encoded as 16 lowercase hex characters.'
255267
timestamp:
256268
type: integer
257269
format: int64
270+
description: 'Epoch **microseconds** of the start of this span, possibly absent if this an incomplete span.'
258271
duration:
259272
type: integer
273+
format: int64
274+
description: 'Duration in **microseconds** of the critical path, if known.'
260275
debug:
261276
type: boolean
277+
description: 'Indicator whether this trace was sampled from standard traffic or forced. Usually coupled to the X-B3-Flags header, which when set to true is a request to store this span even if it overrides sampling policy.'
262278
annotations:
263279
title: ListOfAnnotations
264280
type: array

0 commit comments

Comments
 (0)