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.

Sign up for GitHub

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

Add feature "sort" #29

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add feature "sort" #29

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e752336
Add feature "sort"
avtobiff Nov 22, 2024
2a552c4
Remove "direction" query parameter from "sort" feature
avtobiff Feb 6, 2025
5a87ca8
Remove "direction" from "sort" feature description
avtobiff Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions draft-ietf-netconf-list-pagination.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@
<t>The sorting can furthermore be configured with a locale for
sorting. This is done by setting the "locale" parameter
(see <xref target="locale"/>).</t>
<t>The feature "sort" is used to indicate support for the query
parameters "locale", "sort-by", and "direction".</t>

<section title='The "where" Query Parameter' anchor="where" toc="exclude">
<dl newline="true">
Expand Down
12 changes: 12 additions & 0 deletions ietf-list-pagination.yang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@ module ietf-list-pagination {
"RFC XXXX: List Pagination for YANG-driven Protocols";
}

// Features

feature sort {
description
'This feature indicates that the parameters "locale", "sort-by",
and "direction" are supported.';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be updated too.

}

// Annotations

Expand Down Expand Up @@ -112,6 +119,7 @@ module ietf-list-pagination {
}

md:annotation locale {
if-feature "sort";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not specific to this line, my comment applies to other if-feature statements as well:

Should sort be in double-quotes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In RFC 7950 complex if-feature statements are double quoted
and simple (i.e. single word) are not.

In RFC 8639 simple if-feature statements are double quoted
FWIW.

Should the double quotes be removed?

I don't have a strong opinion.

type string;
description
"This annotation contains the locale used when sorting.
Expand Down Expand Up @@ -148,6 +156,7 @@ module ietf-list-pagination {
}

identity locale-unavailable {
if-feature "sort";
base list-pagination-error;
description
"The 'locale' query parameter input is not a valid
Expand Down Expand Up @@ -187,12 +196,14 @@ module ietf-list-pagination {
statement applied to it (see RFC XXXX).";
}
leaf locale {
if-feature "sort";
type string;
description
"The 'locale' parameter indicates the locale which the
entries in the working result-set should be collated.";
}
leaf sort-by {
if-feature "sort";
type union {
type string {
// An RFC 7950 'descendant-schema-nodeid'.
Expand All @@ -219,6 +230,7 @@ module ietf-list-pagination {
the end (e.g., after all nodes having values).";
}
leaf direction {
if-feature "sort";
type enumeration {
enum forwards {
description
Expand Down