Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading typo in the description of routing-policy/.../conditions/match-protocol-instance/config/protocol-name #1184

Open
qm2k opened this issue Sep 18, 2024 · 0 comments · May be fixed by #1185

Comments

@qm2k
Copy link

qm2k commented Sep 18, 2024

Description of leaf /routing-policy/policy-definitions/policy-definition/statements/statement/conditions/match-protocol-instance/config/protocol-name currently states (emphasis mine):

The string must match one of /network-instances/network-instance/protocols/protocol/identifier in the local network instance.

However, leaf protocol-identifier in the same container already matches /network-instances/network-instance/protocols/protocol/identifier, which is one part of the key of the enclosing collection, the other being name:

container protocols {
  description
    "The routing protocols that are enabled for this
    network-instance.";

  list protocol {
    key "identifier name";
    // ...
  }
}

Everything points to idea that authors wanted protocol-name under match-protocol-instance to point to the name, not identifier. We also have type mismatch otherwise, names being strings and identifiers being equivalent identityrefs. Therefore, the description needs to be corrected by changing the word identifier to the word name.

qm2k added a commit to qm2k/openconfig-public that referenced this issue Sep 18, 2024
Description stated that this leaf should match identifier of a protocol, but it should actually match name of a protocol.

Fixes: openconfig#1184
@qm2k qm2k linked a pull request Sep 18, 2024 that will close this issue
qm2k added a commit to qm2k/openconfig-public that referenced this issue Sep 19, 2024
Description stated that this leaf should match identifier of a protocol, but it should actually match name of a protocol.

Fixes: openconfig#1184
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

1 participant