Files
ziti/specs/source/management/summary.yml
T
Andrew Martinez b562fb5c07 splits API specs into composible modules
- splits Open API 2.0 (swagger) into client/management APIs
- uses go-swaggers flatten capabilities
- uses newer version of go-swagger (v0.27.0)
- introduces /edge/client/v1, /edge/management/v1
- non-prefixed URLs default to /edge/client/v1
- splits some shared management/client API handlers
- renames some REST models to "client" instead of "limited"
- passes all apitests, fails dataflow upd test (main fails this as well)
- updates generate rest script for powershell
- todo: test generate rest script for bash
- todo: use xweb (different branch)
2021-05-04 11:30:32 -04:00

38 lines
985 B
YAML

---
paths:
summary:
get:
summary: Returns a list of accessible resource counts
description: This endpoint is usefull for UIs that wish to display UI elements with counts.
security:
- ztSession: [ ]
tags:
- Informational
operationId: listSummary
responses:
'200':
$ref: '#/responses/listSummaryCounts'
'401':
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
responses:
listSummaryCounts:
description: Entity counts scopped to the current identitie's access
schema:
$ref: '#/definitions/listSummaryCountsEnvelope'
definitions:
listSummaryCountsEnvelope:
type: object
required:
- meta
- data
properties:
meta:
$ref: '../shared/standard-responses.yml#/definitions/meta'
data:
$ref: '#/definitions/listSummaryCounts'
listSummaryCounts:
type: object
additionalProperties:
type: integer