Skip to content

Add requirement for not using . in object roles#66

Closed
cristian-recoseanu wants to merge 1 commit intov1.0.xfrom
publish-object-role-requirements
Closed

Add requirement for not using . in object roles#66
cristian-recoseanu wants to merge 1 commit intov1.0.xfrom
publish-object-role-requirements

Conversation

@cristian-recoseanu
Copy link
Contributor

This is due to how IS-14 url role paths are created and how BCP-003-02 IS-12 access tokens must work.

This is due to how IS-14 url role paths are created and how BCP-003-02 IS-12 access tokens must work.
@garethsb
Copy link
Contributor

There are no restrictions on the characters in a role at all until now, right? So the trouble is there's no way to encode a sequence of role strings as a single string for IS-14, without introducing either an illegal character or an escape character? Is dot the right choice? In which part of a URL do these role paths appear - path or query string?

The problem of . having dual meaning appeared in IS-04, since it was adopted as a separator in the Query API filter syntax, but can also be found in keys, e.g. BCP-002-02 tag names which include versions... The situation is worked around there by a syntax which makes judicious use of URI reserved characters (which includes (, ,, and ) but NOT .) and percent-encoding of values.

  • /x-nmos/query/v1.3/nodes?tags.urn:x-nmos:tag:asset:manufacturer/v1.0=Vendor-A seems like it ought to do something useful but doesn't work because of the confusing . in the tag name
  • /x-nmos/query/v1.3/nodes?query.rql=eq(tags.urn%3Ax-nmos%3Atag%3Aasset%3Amanufacturer/v1.0,Vendor-A) still doesn't work for the same reason
  • luckily /x-nmos/query/v1.3/nodes?query.rql=eq((tags,urn%3Ax-nmos%3Atag%3Aasset%3Amanufacturer/v1.0),Vendor-A) does if the implementation follows that part of the RQL spec

@cristian-recoseanu
Copy link
Contributor Author

Closed as we want to keep MS-05-02 generic.
Further guidance will instead be in BCP-003-02/IS-10 and IS-12/IS-14.

@cristian-recoseanu cristian-recoseanu deleted the publish-object-role-requirements branch June 6, 2025 10:57
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