Networking API v2.0 in neutron-lib: incorrect ''port_range_max" description for ICMP protocol

Bug #1793285 reported by Miguel Duarte Barroso
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Brian Haley

Bug Description

The current 'port_range_max' attribute description for security group rules is misaligned with the implementation, when the protocol is ICMP.

It currently states 'If the protocol is ICMP, this value must be an ICMP type', when the neutron implementation uses the 'port_range_max' security group rules attribute as ICMP code.

This claim can be verified below:

https://github.com/openstack/neutron/blob/master/neutron/agent/linux/openvswitch_firewall/rules.py#L275

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [x] I have a fix to the document that I can paste below including example: input and output.

Update from:
  'If the protocol is ICMP, this value must be an ICMP type'
To:
  'If the protocol is ICMP, this value must be an ICMP code'

-----------------------------------
Release: 1.18.1.dev58 on 2018-09-19 01:14
SHA: bede7826300884fba1a64aae3b807ccbb419b5ca
Source: https://git.openstack.org/cgit/openstack/neutron-lib/tree/api-ref/source/v2/index.rst
URL: https://developer.openstack.org/api-ref/network/v2/

Tags: api-ref
description: updated
Changed in neutron:
status: New → Confirmed
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron-lib (master)

Fix proposed to branch: master
Review: https://review.openstack.org/603775

Changed in neutron:
assignee: nobody → Brian Haley (brian-haley)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron-lib (master)

Reviewed: https://review.openstack.org/603775
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=157c507f70e244c990d0c087e6afea4531891c04
Submitter: Zuul
Branch: master

commit 157c507f70e244c990d0c087e6afea4531891c04
Author: Brian Haley <email address hidden>
Date: Wed Sep 19 09:22:35 2018 -0400

    Fix port_range_max attribute definition

    port_range_max in an ICMP security group rule defines the
    ICMP code value, fix a copy/paste typo.

    Change-Id: I4356610d106385c72afc9c3fb7b194c690c56cae
    Closes-bug: #1793285

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron-lib 1.19.0

This issue was fixed in the openstack/neutron-lib 1.19.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.