From fd18064c113b40688116a0e2044eaac1920a7873 Mon Sep 17 00:00:00 2001 From: songwenping Date: Fri, 4 Sep 2020 18:28:15 +0800 Subject: [PATCH] Add releasenote for add project_id for arq patch api This is follow up https://review.opendev.org/#/c/738427/6/cyborg/api/rest_api_version_history.rst@18, and add releasenote for adding `project_id` field to accelerator request PATCH api. Change-Id: I4df6a7e91c0a2a06fbf260c6c6790d6160345acd --- cyborg/api/rest_api_version_history.rst | 20 ++++++++++--------- ..._id-to-arq-patch-api-8270cbb26c68af46.yaml | 8 ++++++++ 2 files changed, 19 insertions(+), 9 deletions(-) create mode 100644 releasenotes/notes/add-project_id-to-arq-patch-api-8270cbb26c68af46.yaml diff --git a/cyborg/api/rest_api_version_history.rst b/cyborg/api/rest_api_version_history.rst index 7b56abd0..89b99d78 100644 --- a/cyborg/api/rest_api_version_history.rst +++ b/cyborg/api/rest_api_version_history.rst @@ -6,6 +6,15 @@ microversion change. The description for each version should be a verbose one which has enough information to be suitable for use in user documentation. +A user can specify a header in the API request:: + + OpenStack-API-Version: accelerator + +where ```` is any valid api microversion for this API. + +If no version is specified then the API will behave as if a version +request of v2.0 was requested. + 2.0 --- @@ -15,13 +24,6 @@ microversions. 2.1 --- -Add ``project_id`` for arq. +Add ``project_id`` for Accelerator Requests PATCH API. ``project_id`` is +used to control the operation of arq with different roles. -A user can specify a header in the API request:: - - OpenStack-API-Version: accelerator - -where ```` is any valid api microversion for this API. - -If no version is specified then the API will behave as if a version -request of v2.0 was requested. diff --git a/releasenotes/notes/add-project_id-to-arq-patch-api-8270cbb26c68af46.yaml b/releasenotes/notes/add-project_id-to-arq-patch-api-8270cbb26c68af46.yaml new file mode 100644 index 00000000..f7baf094 --- /dev/null +++ b/releasenotes/notes/add-project_id-to-arq-patch-api-8270cbb26c68af46.yaml @@ -0,0 +1,8 @@ +--- +features: + - | + Add ``project_id`` for Accelerator Requests (arq) `PATCH API`_ from + microversion 2.1 in order to control operations of accelerator requests + with different roles. + + .. _`PATCH API`: https://docs.openstack.org/api-ref/accelerator/v2/index.html#update-accelerator-requests