Project

General

Profile

Bug #34859

don't expose "label" param in PUT /organizations/:id API

Added by Evgeni Golov 2 months ago. Updated about 2 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
API
Target version:
Difficulty:
trivial
Triaged:
Yes
Bugzilla link:
Fixed in Releases:
Found in Releases:
Red Hat JIRA:

Description

Ohai,

we don't allow changing the label of the API, yet it is present in the APIdoc for PUT /organizations/:id:

…
                        "doc_url": "../apidoc/v2/organizations/update",
                        "name": "update",
                        "apis": [
                            {
                                "api_url": "/katello/api/organizations/:id",
                                "http_method": "PUT",
                                "short_description": "Update organization",
                                "deprecated": null
                            }
                        ],
                        "formats": null,
                        "full_description": "",
                        "errors": [],
                        "params": [
                            {
…
                            {
                                "name": "organization",
                                "full_name": "organization",
                                "description": "",
                                "required": true,
                                "allow_nil": false,
                                "allow_blank": false,
                                "validator": "Hash",
                                "expected_type": "hash",
                                "metadata": null,
                                "show": true,
                                "validations": [],
                                "params": [
                                    {
…
                                    {
                                        "name": "label",
                                        "full_name": "organization[label]",
                                        "description": "",
                                        "required": false,
                                        "allow_nil": true,
                                        "allow_blank": false,
                                        "validator": "String",
                                        "expected_type": "string",
                                        "metadata": null,
                                        "show": true,
                                        "validations": []
                                    },
…

Associated revisions

Revision 56e5b386 (diff)
Added by Evgeni Golov about 2 months ago

Fixes #34859 - only allow label when creating an organization

We forbid updating the label of an org, so we also should not expose it
in the apidoc.

History

#1 Updated by The Foreman Bot 2 months ago

  • Assignee set to Evgeni Golov
  • Status changed from New to Ready For Testing
  • Pull request https://github.com/Katello/katello/pull/10084 added

#2 Updated by Chris Roberts about 2 months ago

  • Triaged changed from No to Yes
  • Difficulty set to trivial
  • Target version set to Katello 4.5.0
  • Category set to API

#3 Updated by The Foreman Bot about 2 months ago

  • Fixed in Releases Katello 4.5.0 added

#4 Updated by Evgeni Golov about 2 months ago

  • Status changed from Ready For Testing to Closed

Also available in: Atom PDF