Skip to content

API documentation limitations #183

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

Closed
alien-mcl wants to merge 1 commit into from
Closed

API documentation limitations #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions spec/latest/core/core.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
"mapping": "hydra:mapping",
"IriTemplateMapping": "hydra:IriTemplateMapping",
"variable": "hydra:variable",
"CollectionSpecification": "hydra:CollectionSpecification",
"target": { "@id": "hydra:target", "@type": "@id" },
"defines": { "@reverse": "rdfs:isDefinedBy" },
"comment": "rdfs:comment",
"label": "rdfs:label",
Expand Down Expand Up @@ -505,6 +507,23 @@
"domain": "hydra:IriTemplateMapping",
"range": "xsd:string",
"vs:term_status": "testing"
},
{
"@id": "hydra:target",
"@type": "rdf:Property",
"label": "invocation target",
"comment": "Explicit target of the invocation of the operation.",

@tpluscode tpluscode Feb 12, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How is the explicit target related to the collection description?

@alien-mcl alien-mcl Feb 13, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Issue #167 mentions two major problems:

  • strongly typed collections
  • connecting operations with supported classes and IRI templates - target should resolve this one.

"domain": "hydra:Operation",
"rangeIncludes": ["hydra:IriTemplate", "hydra:Resource"],
"vs:term_status": "testing"
},
{
"@id": "hydra:CollectionSpecification",
"@type": "rdfs:Class",
"subClassOf": "hydra:Collection",

@tpluscode tpluscode Feb 12, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Agreed with @angelo-v. I don't understand this

@alien-mcl alien-mcl Feb 13, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It is for hydra:manages, which has hydra:Collection as it's domain. I didn't think of any better solution. Any ideas?

"label": "Collection specification",
"comment": "Describes a collection returned by the operation.",
"vs:term_status": "testing"
}
]
}