From aed221fb9985bc79891c0cc95492845f27a8d36a Mon Sep 17 00:00:00 2001 From: Luka Peschke Date: Fri, 19 Jul 2019 09:58:15 +0200 Subject: [PATCH] Update PUT /v2/scope API reference This updates some parameters in the API reference of the PUT /v2/scope endpoint: Some parameters were marked as being expected in the query, but were actually expected in the body. Change-Id: Id42c4c26d68fb391be38a9cb7b9ae9a1dba3c254 --- doc/source/api-reference/v2/scope/scope.inc | 8 ++++---- .../api-reference/v2/scope/scope_parameters.yml | 16 ++++++++++++++++ 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/source/api-reference/v2/scope/scope.inc b/doc/source/api-reference/v2/scope/scope.inc index d3159ff6..276d1a5c 100644 --- a/doc/source/api-reference/v2/scope/scope.inc +++ b/doc/source/api-reference/v2/scope/scope.inc @@ -60,10 +60,10 @@ Reset the status of several scopes. .. rest_parameters:: scope/scope_parameters.yml - state: state - - collector: collector - - fetcher: fetcher - - scope_id: scope_id - - scope_key: scope_key + - collector: collector_body + - fetcher: fetcher_body + - scope_id: scope_id_body + - scope_key: scope_key_body - all_scopes: all_scopes Status codes diff --git a/doc/source/api-reference/v2/scope/scope_parameters.yml b/doc/source/api-reference/v2/scope/scope_parameters.yml index 7db62d8a..90b47cf1 100644 --- a/doc/source/api-reference/v2/scope/scope_parameters.yml +++ b/doc/source/api-reference/v2/scope/scope_parameters.yml @@ -76,3 +76,19 @@ scope_key_resp: required: true description: Scope key for the given scope in: body + +collector_body: + <<: *collector + in: body + +fetcher_body: + <<: *fetcher + in: body + +scope_id_body: + <<: *scope_id + in: body + +scope_key_body: + <<: *scope_key + in: body