Skip to content

replace ... by ** to clarifiy any depth capability of the endpoint - #9

Merged
m-mohr merged 4 commits into
stac-api-extensions:mainfrom
crim-ca:clarify-children-depth
Aug 5, 2026
Merged

replace ... by ** to clarifiy any depth capability of the endpoint#9
m-mohr merged 4 commits into
stac-api-extensions:mainfrom
crim-ca:clarify-children-depth

Conversation

@fmigneault

Copy link
Copy Markdown
Contributor

The original text can be ambiguous depending on how one reads .... For example, it could be misinterpreted as "two levels up" and did not communicate the variability of its position. I propose using ** which is a well established glob pattern communicating any nested path natively while avoiding the . character literally employed by API relative URIs.

Proposed Changes:

  1. replace ... by ** to clarify any depth capability of the endpoint
  2. minor wording change of the initial description that could cause confusing regarding "where" the child links are found

PR Checklist:

  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

Comment thread README.md Outdated
Comment thread README.md Outdated
@m-mohr

m-mohr commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

I don't necessarily find ** easier to understand than ... - ** is a grep thing, I believe? But the textual clarifications make a lot of sense. Left two comments, I find the "parent" usage confusing.

@m-mohr m-mohr added this to the 1.0.0 milestone Aug 3, 2026
@m-mohr

m-mohr commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

#13 might also be of interest to you, @fmigneault

Co-authored-by: Matthias Mohr <m.mohr@moregeo.it>
@fmigneault

Copy link
Copy Markdown
Contributor Author

I don't necessarily find ** easier to understand than ... - ** is a grep thing, I believe? But the textual clarifications make a lot of sense. Left two comments, I find the "parent" usage confusing.

It is mostly to make a clearer distinction from ../ that are valid relative references.
When reading fast, it is easy to miss counting a dot, and the difference between 2 or 3 means entirely different things (relative vs anywhere). Using **/ makes that even more explicit for users that it means more than a relative link, that it is not a valid link in itself, but a concept.

Co-authored-by: Matthias Mohr <m.mohr@moregeo.it>
@m-mohr

m-mohr commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Fair enough... :-)

@m-mohr

m-mohr commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

@fmigneault Can you fix the CI? Then I'm happy to merge.

@fmigneault

Copy link
Copy Markdown
Contributor Author

@m-mohr Should be fixed now based on the warning.

@m-mohr
m-mohr merged commit 1c6003a into stac-api-extensions:main Aug 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants