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

Parse Results should contain a profile to API Elements #39

Open
kylef opened this issue Dec 11, 2018 · 0 comments
Open

Parse Results should contain a profile to API Elements #39

kylef opened this issue Dec 11, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@kylef
Copy link
Member

kylef commented Dec 11, 2018

Parse Results should contain a profile link to API Elements, the specific version that the parser emitted. This will allow consumers to discover if a parse result contains new semantics it may not understand.

{
  "element": "parseResult",
  "meta": {
    "links": [
      {
        "element": "link",
        "attributes": {
          "relation":  {
            "element": "string",
            "content": "profile"
          },
          "href":  {
            "element": "string",
            "content": "https://apielements.org/1.0.0/"
          }
        }
      }
    ]
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant