From fd11036d11f3edb43d1fdb77223959e763f021ec Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Wed, 9 Jul 2025 16:52:00 +0200 Subject: [PATCH] Update API documentation --- docs/docs.go | 90 +++++++++++++++++++++++++++++++++++------------ docs/swagger.json | 90 +++++++++++++++++++++++++++++++++++------------ docs/swagger.yaml | 70 +++++++++++++++++++++++++----------- 3 files changed, 183 insertions(+), 67 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index cc0db1a3..28254da1 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -547,6 +547,14 @@ const docTemplate = `{ ], "summary": "List of policies in IAM", "operationId": "cluster-3-iam-list-policies", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -608,6 +616,14 @@ const docTemplate = `{ ], "summary": "List of identities in IAM", "operationId": "cluster-3-iam-list-identities", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -647,6 +663,12 @@ const docTemplate = `{ "schema": { "$ref": "#/definitions/api.IAMUser" } + }, + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" } ], "responses": { @@ -687,6 +709,14 @@ const docTemplate = `{ ], "summary": "Identity in IAM", "operationId": "cluster-3-iam-list-identity", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -805,6 +835,12 @@ const docTemplate = `{ "name": "name", "in": "path", "required": true + }, + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" } ], "responses": { @@ -1375,12 +1411,6 @@ const docTemplate = `{ "in": "path", "required": true }, - { - "type": "string", - "description": "Domain to act on", - "name": "domain", - "in": "query" - }, { "type": "string", "description": "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output.", @@ -1804,7 +1834,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -1864,7 +1894,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -1927,6 +1957,12 @@ const docTemplate = `{ "name": "id", "in": "path", "required": true + }, + { + "type": "string", + "description": "Process domain", + "name": "domain", + "in": "query" } ], "responses": { @@ -1980,7 +2016,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -2055,7 +2091,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -2117,7 +2153,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -2181,7 +2217,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -2855,6 +2891,14 @@ const docTemplate = `{ ], "summary": "List of identities in IAM", "operationId": "iam-3-list-identities", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -3698,7 +3742,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3770,7 +3814,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3842,7 +3886,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -3910,7 +3954,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3984,7 +4028,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4056,7 +4100,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4124,7 +4168,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -4564,7 +4608,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4629,7 +4673,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4695,7 +4739,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -4769,7 +4813,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } diff --git a/docs/swagger.json b/docs/swagger.json index b3f4b5f9..c25ffd46 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -540,6 +540,14 @@ ], "summary": "List of policies in IAM", "operationId": "cluster-3-iam-list-policies", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -601,6 +609,14 @@ ], "summary": "List of identities in IAM", "operationId": "cluster-3-iam-list-identities", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -640,6 +656,12 @@ "schema": { "$ref": "#/definitions/api.IAMUser" } + }, + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" } ], "responses": { @@ -680,6 +702,14 @@ ], "summary": "Identity in IAM", "operationId": "cluster-3-iam-list-identity", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -798,6 +828,12 @@ "name": "name", "in": "path", "required": true + }, + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" } ], "responses": { @@ -1368,12 +1404,6 @@ "in": "path", "required": true }, - { - "type": "string", - "description": "Domain to act on", - "name": "domain", - "in": "query" - }, { "type": "string", "description": "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output.", @@ -1797,7 +1827,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -1857,7 +1887,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -1920,6 +1950,12 @@ "name": "id", "in": "path", "required": true + }, + { + "type": "string", + "description": "Process domain", + "name": "domain", + "in": "query" } ], "responses": { @@ -1973,7 +2009,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -2048,7 +2084,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -2110,7 +2146,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -2174,7 +2210,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -2848,6 +2884,14 @@ ], "summary": "List of identities in IAM", "operationId": "iam-3-list-identities", + "parameters": [ + { + "type": "string", + "description": "Domain of the acting user", + "name": "domain", + "in": "query" + } + ], "responses": { "200": { "description": "OK", @@ -3691,7 +3735,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3763,7 +3807,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3835,7 +3879,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -3903,7 +3947,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -3977,7 +4021,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4049,7 +4093,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4117,7 +4161,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -4557,7 +4601,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4622,7 +4666,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } @@ -4688,7 +4732,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" }, @@ -4762,7 +4806,7 @@ }, { "type": "string", - "description": "Domain to act on", + "description": "Process domain", "name": "domain", "in": "query" } diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 3b16105c..12b5a4f9 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -3207,6 +3207,11 @@ paths: get: description: List of policies IAM operationId: cluster-3-iam-list-policies + parameters: + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -3245,6 +3250,11 @@ paths: get: description: List of identities in IAM operationId: cluster-3-iam-list-identities + parameters: + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -3271,6 +3281,10 @@ paths: required: true schema: $ref: '#/definitions/api.IAMUser' + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -3301,6 +3315,10 @@ paths: name: name required: true type: string + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -3324,6 +3342,11 @@ paths: get: description: Identity in IAM operationId: cluster-3-iam-list-identity + parameters: + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -3742,10 +3765,6 @@ paths: name: id required: true type: string - - description: Domain to act on - in: query - name: domain - type: string - description: Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output. @@ -3992,6 +4011,10 @@ paths: name: id required: true type: string + - description: Process domain + in: query + name: domain + type: string produces: - application/json responses: @@ -4022,7 +4045,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4062,7 +4085,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4108,7 +4131,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4158,7 +4181,7 @@ paths: name: key required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4201,7 +4224,7 @@ paths: name: key required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4245,7 +4268,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -4722,6 +4745,11 @@ paths: get: description: List of identities in IAM operationId: iam-3-list-identities + parameters: + - description: Domain of the acting user + in: query + name: domain + type: string produces: - application/json responses: @@ -5210,7 +5238,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5252,7 +5280,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5300,7 +5328,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5350,7 +5378,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5399,7 +5427,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5447,7 +5475,7 @@ paths: name: key required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5494,7 +5522,7 @@ paths: name: key required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5788,7 +5816,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5834,7 +5862,7 @@ paths: in: query name: exited_at type: integer - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5877,7 +5905,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string @@ -5925,7 +5953,7 @@ paths: name: id required: true type: string - - description: Domain to act on + - description: Process domain in: query name: domain type: string