Add configs/id/services API. Add posture check role attributes list A…

…PI. Fixes #120. Fixes #121
openziti · Jul 19, 2024 · 6daf28a · 6daf28a
1 parent 359038c
commit 6daf28a
Show file tree

Hide file tree

Showing 21 changed files with 3,061 additions and 0 deletions.
diff --git a/management.yml b/management.yml
@@ -3698,6 +3698,92 @@ paths:
       name: id
       in: path
       required: true
+  /configs/{id}/services:
+    get:
+      security:
+      - ztSession: []
+      description: |
+        Retrieves a list of service resources that reference a given config; supports filtering, sorting, and pagination. Requires admin access.
+      tags:
+      - Config
+      summary: List services referenced by a config
+      operationId: listConfigServices
+      parameters:
+      - type: integer
+        name: limit
+        in: query
+      - type: integer
+        name: offset
+        in: query
+      - type: string
+        name: filter
+        in: query
+      responses:
+        "200":
+          description: A list of services
+          schema:
+            $ref: '#/definitions/listServicesEnvelope'
+        "400":
+          description: The requested resource does not exist
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars:
+                    id: 71a3000f-7dda-491a-9b90-a19f4ee6c406
+                cause: null
+                causeMessage: ""
+                code: NOT_FOUND
+                message: The resource requested was not found or is no longer available
+                requestId: 270908d6-f2ef-4577-b973-67bec18ae376
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
+        "401":
+          description: The supplied session does not have the correct access rights
+            to request this resource
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars: {}
+                cause: ""
+                causeMessage: ""
+                code: UNAUTHORIZED
+                message: The request could not be completed. The session is not authorized
+                  or the credentials are invalid
+                requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
+        "429":
+          description: The resource requested is rate limited and the rate limit has
+            been exceeded
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars: {}
+                causeMessage: you have hit a rate limit in the requested operation
+                code: RATE_LIMITED
+                message: The resource is rate limited and the rate limit has been
+                  exceeded. Please try again later
+                requestId: 270908d6-f2ef-4577-b973-67bec18ae376
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
+    parameters:
+    - type: string
+      description: The id of the requested resource
+      name: id
+      in: path
+      required: true
   /controllers:
     get:
       security:
@@ -9965,6 +10051,99 @@ paths:
       name: id
       in: path
       required: true
+  /posture-check-role-attributes:
+    get:
+      security:
+      - ztSession: []
+      - oauth2:
+        - openid
+      description: |
+        Retrieves a list of role attributes in use by posture checks; supports filtering, sorting, and pagination. Requires admin access.
+      tags:
+      - Role Attributes
+      summary: List role attributes in use by posture checks
+      operationId: listPostureCheckRoleAttributes
+      parameters:
+      - type: integer
+        name: limit
+        in: query
+      - type: integer
+        name: offset
+        in: query
+      - type: string
+        name: filter
+        in: query
+      responses:
+        "200":
+          description: A list of role attributes
+          schema:
+            $ref: '#/definitions/listRoleAttributesEnvelope'
+        "400":
+          description: The supplied request contains invalid fields or could not be
+            parsed (json and non-json bodies). The error's code, message, and cause
+            fields can be inspected for further information
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars: {}
+                cause:
+                  details:
+                    context: (root)
+                    field: (root)
+                    property: fooField3
+                  field: (root)
+                  message: '(root): fooField3 is required'
+                  type: required
+                  value:
+                    fooField: abc
+                    fooField2: def
+                causeMessage: schema validation failed
+                code: COULD_NOT_VALIDATE
+                message: The supplied request contains an invalid document
+                requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
+        "401":
+          description: The supplied session does not have the correct access rights
+            to request this resource
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars: {}
+                cause: ""
+                causeMessage: ""
+                code: UNAUTHORIZED
+                message: The request could not be completed. The session is not authorized
+                  or the credentials are invalid
+                requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
+        "429":
+          description: The resource requested is rate limited and the rate limit has
+            been exceeded
+          schema:
+            $ref: '#/definitions/apiErrorEnvelope'
+          examples:
+            application/json:
+              error:
+                args:
+                  urlVars: {}
+                causeMessage: you have hit a rate limit in the requested operation
+                code: RATE_LIMITED
+                message: The resource is rate limited and the rate limit has been
+                  exceeded. Please try again later
+                requestId: 270908d6-f2ef-4577-b973-67bec18ae376
+              meta:
+                apiEnrollmentVersion: 0.0.1
+                apiVersion: 0.0.1
   /posture-check-types:
     get:
       security:

diff --git a/rest_management_api_client/config/config_client.go b/rest_management_api_client/config/config_client.go