Week of Sep 1 by duglin · Pull Request #405 · xregistry/spec

duglin · 2025-09-04T15:44:51Z

New text and moving more stuff around
add definition of "capabilities" attribute to Registry entity's list of attributes
add text about "views"

jskeet

I've only skimmed, and there are a few comments, but broadly speaking this looks fine to me.

jskeet · 2025-09-11T12:49:14Z

-Registry, while Groups, as the name implies, is a mechanism by which related
-Resources are arranged together under a single collection.
+Resources typically represent the main data of interest in the Registry, while
+Groups, as the name implies, is a mechanism by which related Resources are


While I can see that it's a singular feature being described, the "Groups is a mechanism" jars a bit.

Would "while Groups, as the name implies, allow related Resources to be arranged together under a single collection" work?

works for me

jskeet · 2025-09-11T12:50:35Z

+
+#### Group
+
+Groups, as the name implies, is a mechanism by which related Resources are


Ooh, another example of the same.

jskeet · 2025-09-11T12:56:09Z

 ```

-## Notations and Terminology
+### Registry Views


Wow, GitHub is choosing a really odd diff here...

yep, I guess that's what happens when you move too many large chunks of text around.

Wait for next week's PR... it'll be a doozy too

lailabougria · 2025-09-11T14:42:34Z

+  In this view clients are retrieving all (or part) of the Registry hierarchy
+  as a single document. In this case nested (or child) entities are "inlined"
+  into the retrieved document such that the need for secondary interactions
+  with the server is reduced.


Suggested change

In this view clients are retrieving all (or part) of the Registry hierarchy

as a single document. In this case nested (or child) entities are "inlined"

into the retrieved document such that the need for secondary interactions

with the server is reduced.

In this view, clients are retrieving all (or part) of the Registry hierarchy

as a single document. In this case, nested (or child) entities are "inlined"

into the retrieved document such that the need for secondary interactions

with the server is reduced.

lailabougria · 2025-09-11T14:42:50Z

-Resources, while possible, might be cumbersome, so moving it up to the Group
-could be a more manageable, and user-friendly, implementation choice.
+  This is often used for cases where the documents are to be stored in some
+  document storage system (e.g. github), or as input into local tooling that


Suggested change

document storage system (e.g. github), or as input into local tooling that

document storage system (e.g. GitHub), or as input into local tooling that

lailabougria · 2025-09-11T14:43:11Z

-Additionally, Resources (unlike Groups) MAY be versioned.
-
-#### Version
+  In this view it is assumed that the client is interested in an interactive


Suggested change

In this view it is assumed that the client is interested in an interactive

In this view, it is assumed that the client is interested in an interactive

lailabougria · 2025-09-11T14:43:54Z

+- Multiple Document View

-## Registry Design
+  This is a variant of the "api view". In situations where the data within the


Suggested change

This is a variant of the "api view". In situations where the data within the

This is a variant of the "API view". In situations where the data within the

lailabougria · 2025-09-11T14:44:15Z


-## Registry Design
+  This is a variant of the "api view". In situations where the data within the
+  xRegistry is to be stored as independent files either on disk or in some


should this be Registry?

done but it's a question I've been meaning to ask.... when do we use xRegistry vs Registry ?

I don't know, I would prefer xRegistry, but above that, I prefer consistency (I'm a good student 😉)

lailabougria · 2025-09-11T14:45:20Z

-This entity is meant to serve a few key purposes:
+  Documents generated in this view are often stored locally such that they can
+  be managed independently for use in tooling or stored in some source-code
+  control system (e.g. github) to minimize the number of conflicting edits


Suggested change

control system (e.g. github) to minimize the number of conflicting edits

control system (e.g. GitHub) to minimize the number of conflicting edits

lailabougria · 2025-09-11T14:51:23Z

+### Registry Views

-This specification defines the following terms:
+This specification is designed such that clients can choose how they want the


Could it be useful to mention the hasdoc aspect in this section as well, because it's mentioned through the ?doc, but it's not entirely clear at this point what that means.

Actually, it is mentioned just above, so maybe it's fine.

Let's see how the major "core vs http" split looks and see if we need to do it after that.

- New text and moving more stuff around - add definition of "capabilities" attribute to Registry entity's list of attributes - info about the different 'views' Signed-off-by: Doug Davis <duglin@gmail.com>

duglin · 2025-09-11T16:17:14Z

Approved on the 9/11 call

duglin force-pushed the Sep1 branch 15 times, most recently from ce65f71 to 1008861 Compare September 11, 2025 11:50

jskeet approved these changes Sep 11, 2025

View reviewed changes

duglin force-pushed the Sep1 branch from 1008861 to 2a25b64 Compare September 11, 2025 14:23

lailabougria reviewed Sep 11, 2025

View reviewed changes

lailabougria approved these changes Sep 11, 2025

View reviewed changes

Week of Sep 1

8cdfffb

- New text and moving more stuff around - add definition of "capabilities" attribute to Registry entity's list of attributes - info about the different 'views' Signed-off-by: Doug Davis <duglin@gmail.com>

duglin force-pushed the Sep1 branch from 2a25b64 to 8cdfffb Compare September 11, 2025 15:05

duglin merged commit 67d63e1 into xregistry:main Sep 11, 2025
2 checks passed

duglin deleted the Sep1 branch September 11, 2025 16:18


		#### Group

		Groups, as the name implies, is a mechanism by which related Resources are

	document storage system (e.g. github), or as input into local tooling that
	document storage system (e.g. GitHub), or as input into local tooling that

	In this view it is assumed that the client is interested in an interactive
	In this view, it is assumed that the client is interested in an interactive

	This is a variant of the "api view". In situations where the data within the
	This is a variant of the "API view". In situations where the data within the

	control system (e.g. github) to minimize the number of conflicting edits
	control system (e.g. GitHub) to minimize the number of conflicting edits

Uh oh!

Conversation

duglin commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jskeet left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

duglin commented Sep 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

duglin commented Sep 4, 2025 •

edited

Loading