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.

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

Changes for week of Jan13 #235

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Changes for week of Jan13 #235

merged 1 commit into from
Jan 16, 2025

Conversation

duglin
Copy link
Contributor

@duglin duglin commented Jan 13, 2025

  • typo and wording clarifications in main spec
  • remove duplicate "compatibility" in schema, it's part of core attributes now
  • replaced ?export with ?compact and just removes the dup info. Any
    inlining would need to be requested by the client
  • defined /export to be /?compact&inline=*,model,capabilities
  • remove ?nested
  • tweaks valid chars for ID: [a-zA-Z0-9_][a-zA-Z0-9_.\-~@]{0,127}
  • IDs must be no longer than 128 chars
  • s/$structure/$details/g

Fixes: #234
Fixes: #233
Fixes: #232
Fixes: #220
Fixes: #229
Fixes: #224
Fixes: #237

@duglin duglin force-pushed the Jan13 branch 3 times, most recently from b80df6a to 40a6612 Compare January 15, 2025 17:02
Copy link

@jskeet jskeet left a comment

Choose a reason for hiding this comment

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

A couple of tiny nits, but generally fine.

core/spec.md Outdated
The `?nested` semantics MUST be applied to all nested `COLLECTIONS` attributes
within the request regardless of the level in the hierarchy in which they
appear.
If `COLLECTIONS` attribute is present, the server MUST process each entity in
Copy link

Choose a reason for hiding this comment

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

I'd have either

If COLLECTIONS attributes are present

or

If the COLLECTIONS attribute is present

The singular with no article feels a bit odd.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

core/spec.md Outdated
Resource when exported will adhere to the following:
#### Compact

The "compact" query parameter (flag) MAY be used to indicate that the response
Copy link

Choose a reason for hiding this comment

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

Suggested change
The "compact" query parameter (flag) MAY be used to indicate that the response
The `?compact` query parameter (flag) MAY be used to indicate that the response

(Just for consistency with filter.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch

- typo and wording clarifications in main spec
- remove duplicate "compatibility" in schema, it's part of core attributes now
- replaced `?export` with `?compact` and just removes the dup info. Any
  inlining would need to be requested by the client
- defined `/export` to be `/?compact&inline=*,model,capabilities`
- remove ?nested
- tweaks valid chars for ID: `[a-zA-Z0-9_][a-zA-Z0-9_.\-~@]{0,127}`
- IDs must be no longer than 128 chars
- s/$structure/$details/g

Fixes: xregistry#234
Fixes: xregistry#233
Fixes: xregistry#232
Fixes: xregistry#220
Fixes: xregistry#229
Fixes: xregistry#224
Fixes: xregistry#237

Signed-off-by: Doug Davis <duglin@gmail.com>
@duglin
Copy link
Contributor Author

duglin commented Jan 16, 2025

Approved on the 1/16 call - thanks @jskeet for the review

@duglin duglin merged commit e4772ba into xregistry:main Jan 16, 2025
2 checks passed
@duglin duglin deleted the Jan13 branch January 16, 2025 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment