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

Do not validate extension endpoints #793

Closed
ml-evs opened this issue May 7, 2021 · 2 comments · Fixed by #794
Closed

Do not validate extension endpoints #793

ml-evs opened this issue May 7, 2021 · 2 comments · Fixed by #794
Labels
validator Related to the OPTIMADE validator

Comments

@ml-evs
Copy link
Member

ml-evs commented May 7, 2021

With the registration of MPDS, we now have our first (?) provider that serves custom endpoints through OPTIMADE, e.g. https://api.mpds.io/v1/extensions/phase_diagrams. All bets are off as to what these endpoints should serve, so we should not check them with the validator.

@ml-evs ml-evs added the validator Related to the OPTIMADE validator label May 7, 2021
@ml-evs
Copy link
Member Author

ml-evs commented May 7, 2021

Potential open question: is the below correct, or should the entry types by format be provided without the extensions/ prefix? I think this is ambiguous in the specification...

 "data": {
    "type": "info",
    "attributes": {
      "api_version": "1.0.0",
      "available_api_versions": [
        {
          "url": "https://api.mpds.io/v1",
          "version": "1.0.0"
        }
      ],
      "available_endpoints": [
        "info",
        "structures",
        "extensions/properties",
        "extensions/phase_diagrams",
        "extensions/phases"
      ],
      "formats": [
        "json"
      ],
      "entry_types_by_format": {
        "json": [
          "structures",
          "extensions/properties",
          "extensions/phase_diagrams",
          "extensions/phases"
        ]
      }
    }
  }

@CasperWA
Copy link
Member

CasperWA commented May 11, 2021

I'd say the extensions/ should be part of the entry_types_by_format, but maybe you're right in asking this, as the resource entry types definitely do not include the extensions/ part.
Indeed, the more I think about it, it doesn't make sense, I guess. It only makes sense for the available_endpoints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validator Related to the OPTIMADE validator
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants