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

Prefixes not directly connected to databases #328

Closed
rartino opened this issue Oct 28, 2020 · 8 comments · Fixed by #473
Closed

Prefixes not directly connected to databases #328

rartino opened this issue Oct 28, 2020 · 8 comments · Fixed by #473
Assignees
Labels
PR/waiting-for-update This PR has been reviewed and is waiting for the author to response or update the PR status/delay There is a consensus on this, but shouldn't be included at this point (possibly deferred beyond 1.0) type/proposal Proposal for addition/removal of features. May need broad discussion to reach consensus.

Comments

@rartino
Copy link
Contributor

rartino commented Oct 28, 2020

During the OPTIMADE call came up the question that we already have two types of prefixes in https://providers.optimade.org/providers.json

Those that are specifically tied to databases, and those that are more "general", i.e., tied to a tool, or, we discussed things like _cif_ that refers to a definitions out of a different standard.

We seemingly agreed that it is in our interest to keep allowing both these types, and that requires at least a bit of clarification in the specification as it is presently written. But also the consensus seemed to be that we still want to keep them in the same register since they occupy the same namespace (i.e., https://providers.optimade.org/providers.json ). There was also the point that a prefix not tied to a database provider still should have a maintainer pointed out (so, presumably we point out that entity in the prefix database).

This issue is for doing the necessary update to the text.

There may be a good idea to also separately discuss the idea of a _cif_ prefix. (Actually lifted the first time in #143 but rejected there.)

@merkys merkys mentioned this issue Oct 29, 2020
@ml-evs ml-evs self-assigned this Jun 12, 2023
@ml-evs
Copy link
Member

ml-evs commented Jun 12, 2023

Just to pick this up, this was often posed as a solution at the workshop to many problems/enhancements (#468, #466, #455, etc.). I'm happy to write something up this week on the specification side and try to make the first example namespace. Now we have the advanced property definitions basically in, I think this is the time to pull the trigger on this.

@ml-evs ml-evs added type/proposal Proposal for addition/removal of features. May need broad discussion to reach consensus. status/delay There is a consensus on this, but shouldn't be included at this point (possibly deferred beyond 1.0) PR/waiting-for-update This PR has been reviewed and is waiting for the author to response or update the PR labels Jun 12, 2023
@ml-evs
Copy link
Member

ml-evs commented Jun 14, 2023

I've started writing this (and will make a draft PR shortly) -- there are lots of changes to the spec where we talk about database-specific providers, but I am still toying with how to name this new "thing".

My options so far are:

  • Definition-provider-specific prefixes, where we simply extend the concept of database provider to a definition provider, and the mechanism for registering them remains identical (perhaps with one additional metadata field in the providers list that makes it clear who is a database and who is not --- this would mean that each definition provider has a base URL that could also potentially serve a static info endpoint.
  • Namespace-specific prefixes
  • Community-specific prefix

@merkys
Copy link
Member

merkys commented Jun 14, 2023

I like "Namespace-specific prefixes". This nicely encompasses both the meanings of database-specific and field-specific prefixes.

@vaitkus
Copy link
Contributor

vaitkus commented Jun 14, 2023

The IUCr uses the term "reserved prefixes" in their dictionaries [1], but it might be a bit too generic for OPTIMADE.
"Namespace-specific prefixes" does sound good.

[1] https://www.iucr.org/resources/cif/spec/ancillary/reserved-prefixes

@rartino
Copy link
Contributor Author

rartino commented Jun 14, 2023

Is "specific" needed? Does "namespace prefixes" say the same thing?

@ml-evs
Copy link
Member

ml-evs commented Jun 14, 2023

Sorry, typed up my suggestions in a bit of a hurry. In #473 I refer to "namespace prefixes" as encompassing both database-specific and "new collaborative thing"-specific prefixes.

The name I currently have for "new collaborative thing" is a definition provider, but I'm not entirely set on it. My call for suggestions that mixed these concepts probably confused things :P

@merkys
Copy link
Member

merkys commented Mar 21, 2024

Can we close this as #473 has just been merged?

@ml-evs
Copy link
Member

ml-evs commented Mar 21, 2024

Gladly! Closed by #473

@ml-evs ml-evs closed this as completed Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR/waiting-for-update This PR has been reviewed and is waiting for the author to response or update the PR status/delay There is a consensus on this, but shouldn't be included at this point (possibly deferred beyond 1.0) type/proposal Proposal for addition/removal of features. May need broad discussion to reach consensus.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants