Mercurial > hg > thermostat-ng > web-gateway
changeset 192:17a5b2833107
Add metadata documentation to the JVM GC and Memory swagger files.
Reviewed-by: jkang
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-July/024049.html
| author | Chris Lessard <clessard@redhat.com> |
|---|---|
| date | Tue, 11 Jul 2017 16:14:42 -0400 |
| parents | fb8a7d310fbc |
| children | 0461635570a0 |
| files | services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml |
| diffstat | 2 files changed, 78 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml Mon Jul 10 14:19:43 2017 -0400 +++ b/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml Tue Jul 11 16:14:42 2017 -0400 @@ -21,6 +21,7 @@ - $ref: '#/parameters/sort' - $ref: '#/parameters/projection' - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' responses: '200': description: OK @@ -31,29 +32,40 @@ parameters: - $ref: '#/parameters/put-body' - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' post: description: Add jvm gc information parameters: - $ref: '#/parameters/jvm-gc-stats' + - $ref: '#/parameters/metadata' responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' delete: description: Delete jvm gc information. parameters: - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' definitions: jvm-gc-stats-response: type: object properties: response: $ref: '#/definitions/jvm-gc-stats' + metadata: + $ref: '#/definitions/metadata' jvm-gc-stats: type: array items: @@ -73,7 +85,6 @@ $ref: '#/definitions/metric' wallTime: $ref: '#/definitions/metric' - metric: type: object properties: @@ -85,7 +96,28 @@ properties: $numberLong: type: string - + metadata: + type: object + properties: + payloadCount: + type: integer + count: + type: integer + prev: + type: string + next: + type: string + first: + type: string + last: + type: string + insertCount: + type: integer + matchCount: + type: integer + elapsed: + type: integer + format: int64 put-body: type: object properties: @@ -130,4 +162,9 @@ name: p in: query description: Projection string. Comma separated list of fields to include in the response. Example '?p=a,b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. - type: string \ No newline at end of file + type: string + metadata: + name: m + type: boolean + in: query + description: "Metadata flag. If set to 'true', the subsequent request response will return metadata information. If set to 'false', such metadata information will be omitted." \ No newline at end of file
--- a/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml Mon Jul 10 14:19:43 2017 -0400 +++ b/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml Tue Jul 11 16:14:42 2017 -0400 @@ -21,6 +21,7 @@ - $ref: '#/parameters/sort' - $ref: '#/parameters/projection' - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' responses: '200': description: OK @@ -31,9 +32,12 @@ parameters: - $ref: '#/parameters/put-body' - $ref: '#/parameters/query' + - $ref: '#/parameters/metadata' responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' post: description: Add jvm memory information parameters: @@ -41,6 +45,8 @@ responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' delete: description: Delete jvm memory information. parameters: @@ -48,12 +54,16 @@ responses: '200': description: OK + schema: + $ref: '#/definitions/metadata' definitions: jvm-memory-stats-response: type: object properties: response: $ref: '#/definitions/jvm-memory-stats' + metadata: + $ref: '#/definitions/metadata' jvm-memory-stats: type: array items: @@ -107,7 +117,28 @@ type: string used: $ref: '#/definitions/metric' - + metadata: + type: object + properties: + payloadCount: + type: integer + count: + type: integer + prev: + type: string + next: + type: string + first: + type: string + last: + type: string + insertCount: + type: integer + matchCount: + type: integer + elapsed: + type: integer + format: int64 metric: type: object properties: @@ -164,4 +195,9 @@ name: p in: query description: Projection string. Comma separated list of fields to include in the response. Example '?p=a,b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. - type: string \ No newline at end of file + type: string + metadata: + name: m + type: boolean + in: query + description: "Metadata flag. If set to 'true', the subsequent request response will return metadata information. If set to 'false', such metadata information will be omitted." \ No newline at end of file