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

Jump to bottom

Add "relation" model type #209

Closed
duglin opened this issue Dec 17, 2024 · 5 comments · Fixed by #222
Closed

Add "relation" model type #209

duglin opened this issue Dec 17, 2024 · 5 comments · Fixed by #222
Labels
AddToSpec Done v1 Required to be resolved for v1

Comments

@duglin
Copy link
Contributor

duglin commented Dec 17, 2024 •
edited
Loading

Per 2024/12/16 meeting:

  • defined a new "relation" type in the model - similar to a URL
  • when used, a new target attribute is available that points to the type of registry entity being pointed to
  • e.g. `"target": "schemagroups/schema"
  • MUST be one of:
    • / (the registry itself)
    • /GROUPS
    • /GROUPS/RESOURCES
    • /GROUPS/RESOURCES/version
    • /GROUPS/RESOURCES/version? - runtime value can be a resource or a version
  • runtime value of this attribute MUST be the xid of the target
@duglin duglin mentioned this issue Dec 17, 2024
Closed
@duglin duglin added v1 Required to be resolved for v1 AddToSpec labels Dec 17, 2024
@duglin
Copy link
Contributor Author

duglin commented Dec 28, 2024 •
edited
Loading

Do we want to support a relation that points to any entity in the Registry? E.g. "target": "any", or "target": "*"

@duglin
Copy link
Contributor Author

duglin commented Dec 28, 2024

Should it be singular or plural names? e.g. /endpoints/messages vs /endpoint/message
Normally we use plural for everything, but since the entity attribute itself will point to a single instance of a message, it might read better if we used "singular" for the target value.

Is it ok that I added / to point to the registry itself? I added this just for completeness.

@duglin
Copy link
Contributor Author

duglin commented Dec 30, 2024 •
edited
Loading

Since an attribute of type relation isn't a full URL (it's just an xid), do we expect people to construct a real URL themselves? It would be kind of annoying to have to add a 2nd attribute just to give people the full URL.

Some options:
1 - leave it as is, yes they need to construct the URL themselves
2 - automatically create a 2nd (read-only) attribute (e.g. "foo-resolved": "URL" for each foo relation attribute)
3 - convert the xid into a full URL automatically during a GET. Would make the PUT and GET have different values for that attribute. Can't reuse GET response as PUT input. Yuck.
4 - add a "baseurl" to each entity
5 - add a "baseurl" to the root of whatever is returned (in the case of a map, all entities would get it)

@duglin duglin added the Done label Dec 31, 2024
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 1, 2025
@duglin
Week of Jan 6 changes
503d50a 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixed xregistry#187

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 1, 2025
@duglin
Week of Jan 6 changes
1eacfa8 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 4, 2025
@duglin
Week of Jan 6 changes
7ed1989 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
fixes xregistry#200

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 4, 2025
@duglin
Week of Jan 6 changes
feaef7a 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 5, 2025
@duglin
Week of Jan 6 changes
7caea4e 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 5, 2025
@duglin
Week of Jan 6 changes
f9b9752 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 5, 2025
@duglin
Week of Jan 6 changes
d24f484 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 5, 2025
@duglin
Week of Jan 6 changes
2acb838 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 6, 2025
@duglin
Week of Jan 6 changes
6e8e675 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 6, 2025
@duglin
Week of Jan 6 changes
a9913a3 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 7, 2025
@duglin
Week of Jan 6 changes
2e836b6 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204

Signed-off-by: Doug Davis <[email protected]>
@duglin duglin mentioned this issue Jan 7, 2025
Merged
@duglin
Copy link
Contributor Author

duglin commented Jan 8, 2025

stick with option 1 for now - leave it as is

duglin added a commit to duglin/xreg-spec that referenced this issue Jan 8, 2025
@duglin
Week of Jan 6 changes
ccaf793 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 8, 2025
@duglin
Week of Jan 6 changes
266ac9e 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default
- add support for "shortself"
- add "@" as a valid char for IDs

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206
Fixes xregistry#212

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 9, 2025
@duglin
Week of Jan 6 changes
47cfaad 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default
- add support for "shortself"
- add "@" as a valid char for IDs

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206
Fixes xregistry#212

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 9, 2025
@duglin
Week of Jan 6 changes
399eb38 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default
- add support for "shortself"
- add "@" as a valid char for IDs

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206
Fixes xregistry#212

Signed-off-by: Doug Davis <[email protected]>
duglin added a commit to duglin/xreg-spec that referenced this issue Jan 9, 2025
@duglin
Week of Jan 6 changes
4594072 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default
- add support for "shortself"
- add "@" as a valid char for IDs

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206
Fixes xregistry#212

Signed-off-by: Doug Davis <[email protected]>
@duglin duglin closed this as completed in 6a75351 Jan 9, 2025
@duglin
Copy link
Contributor Author

duglin commented Jan 9, 2025

we agreed to use the plural form

Fannon pushed a commit to Fannon/xregistry that referenced this issue Jan 23, 2025
@duglin @Fannon
Week of Jan 6 changes
e92d757 
- clarify errors for bad paths and methods
- Remove "origin"
- add `/capabilities` API and "capabilities" Registry attr
  - requires `?inline=capabilities` reads, just presence on writes(like model)
  - remove "schemas" from model, moved into "capabilities"
- add 'xid'. Change xref to start with /
- add "labels" to model schema : Registry, Groups and Resources
  - add a "compatiblewith" well-known label
- add support for `relation` type of URLs
- add text about how to deal with sending incomplete results
  - error unless you can be tricky via something like pagination spec
- allow ?export, ?inline, ?filter on all APIs to control responses
- explain that "generated" errors != must send back to client - e.g. security
- use highest alphabetical versionid (case insensitive) when all versions have
  the same "createdat" value. Remove requirement for ?setdefaultversionid
- `DELETE RESOURCES` must put `epoch` under `meta` if present
- Primer: explain why GROUPS and RESOURCES have attribute name restrictions
- Primer: encourage domain/company prefix/suffixed on Groups (and Resources)
- Add `capability.enforcecompatibility` so servers can indicate whether they'll
  enforce the `compatibility` attribute on the owning Resource
- Clarify rules for updating Resources when dealing with 'xref'.
  - presence of any attribute on a 'write' to an xref'd resource is an error
  - xref->normal:
    - epoch = max(oldEpoch, targetResourceEpoch)+1
	- createdat = oldCreatedAt
	- modifiedat = now
- Updating a Version's `createdat` CAN make it the latest/default
- add support for "shortself"
- add "@" as a valid char for IDs

Fixes xregistry#199
Fixes xregistry#216
Fixes xregistry#217
Fixes xregistry#213
Fixes xregistry#210
Fixes xregistry#211
Fixes xregistry#209
Fixes xregistry#187
Fixes xregistry#200
Fixes xregistry#202
Fixes xregistry#205
Fixes xregistry#207
Fixes xregistry#214
Fixes xregistry#203
Fixes xregistry#204
Fixes xregistry#206
Fixes xregistry#212

Signed-off-by: Doug Davis <[email protected]>
Signed-off-by: Simon Heimler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
AddToSpec Done v1 Required to be resolved for v1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Week of Jan 6 changes duglin/xreg-spec
1 participant
@duglin