You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 75 Next »

Fedora's alignment with each category of the Fedora API Specification needs to be verified for completeness and correctness. Below is a listing of the specification categories, the person/people taking the lead on ensuring alignment, and the current status of alignment.

Legend

(question) - Untested
(tick) - Tested, working
(error) - Tested, not working

(minus) - Tested, not applicable
(warning)- Needs review

Environment


3 Resource Management

Lead

3.1 General (Jared Whiklo)

  • Empty section

3.1.1 LDP Containers

  • (tick) MUST be able to create LDP Containers: Tested in 3.3
  • (tick)  MUST distinguish between triple types OR MUST return 409 with constrainedBy Link in headers for ldp:contains membership predicate if server cannot distinguish between triple types
    • We return a 409 because we can't distinguish and therefore the next 2 tests are not applicable.
  • (minus) MAY permit ldp:contains membership predicate if server can distinguish between triple types
  • (minus) SHOULD allow Prefer header in request to distinguish triple types if server can distinguish triple types

3.1.2 LDP-NR creation

  • (tick) SHOULD create an LDP-NR if creation request includes NonRDFSource type Link in headers, regardless of Content-Type headers

3.2 HTTP GET

  • (tick) MUST return describes Link to LDP-NR if request is to associated LDP-RS

3.2.1 Additional values for the Prefer header

3.2.2 LDP-RSs

  • (tick) MUST return Preference-Applied header if request's Prefer header is honored (Always applied)

3.2.3 LDP-NRs

  • (tick) MUST return Digest header as directed by request's Want-Digest header

3.3 HTTP HEAD

  • (tick) MUST NOT return a body
  • (/) SHOULD return same headers as if the request was a GET
    • Almost perfect: Binary resources have duplicate headers that are not seen on HEAD Unable to locate Jira server for this macro. It may be due to Application Link configuration.
  • (tick) MUST return a Digest header if the same request as a GET would have
  • (minus) MAY omit payload headers from response

3.4 HTTP OPTIONS (Yinlin Chen)

  • (tick) Any LDPR must support OPTIONS per [LDP] 4.2.8. 4.2. LDP servers must support the HTTP OPTIONS method. 

  • (tick) Any LDPR must support OPTIONS per [LDP] 4.2.8. LD servers must indicate their support for HTTP Methods by responding to a HTTP OPTIONS request on the LDPR’s URL with the HTTP Method tokens in the HTTP respons header Allow. 

3.5 HTTP POST

  • (tick) MUST be supported on LDP Collections
  • (tick) MUST include default interaction model in constrainedBy Link header
    • Correct for both LDP-RS and LDP-NR
  • (tick) MUST support creation of LDP-NRs
  • (tick) MUST create and associate an LDP-RS when an LDP-NR is created

3.5.1 LDP-NRs

  • (tick) MUST return 409 if request Digest header does not match calculated value for content of new LDP-NR
  • (tick) SHOULD return 400 if request Digest header's type is not supported (Should 'type' be 'algorithm', like the RFC?)

3.6 HTTP PUT

  • (tick) MAY include type Link header in request
  • (tick) MUST return 409 if request's type Link is not resource's current type or subtype thereof, or not in LDP namespace
  • (minus) MUST change resource's type if request's type Link is a subtype of resource's current type
  • (minus)  MUST change resource's interaction model if request's type Link has an LDP interaction model

3.6.1 LDP-RSs

  • (question) MUST be supported on LDP-RSs for non-server-managed triples
  • (tick)  MUST return 4xx (409), with more info in body and constrainedBy Link in headers if request modifies server-managed triples (Are triples different than resource statements?) on a LDP-RS
    • (warning) Currently we allow the use of the -Dfcrepo.properties.management=relaxed option to allow updating server managed triples. Is that something that we will continue to support and if so is the current impl in conflict with the spec?

3.6.2 LDP-NRs (Danny Bernstein)

  • (tick) MUST be supported on LDP-NRs to replace binary content
  • (tick) MUST return 409 if request Digest header does not match calculated value for new content of target LDP-NR
  • (tick) SHOULD return 400 if request Digest header's type is not supported (Should 'type' be 'algorithm', like the RFC?)

3.6.3 Creating resources with HTTP PUT

  • Non-normative section

3.7 HTTP PATCH (Jared Whiklo)

  • (tick) MUST be supported on LDP-RSs
  • (tick) MUST support sparqlupdate
  • (question) MAY support other update types
  • (question) MUST return 4xx (409), with more info in body and constrainedBy Link in headers when modifying protected resource statements
  • (tick) MUST return 2xx if successful

3.7.1 Interaction models

  • (tick) MUST return 409 when modifying the interaction model to a type that is not a subtype of the current type (LDP-NR to LDP-RS or opposite?)

3.8 HTTP DELETE (Yinlin Chen)

  • (warning) MAY be supported
  • (tick) An implementation that cannot recurse should not adverti DELETE in response to OPTIONS requests for container with contained resources. 
  • (tick) An implementation must not return a 200 (OK) or 204 (N Content) response unless the entire operation successfully completed. 
  • (tick) An implementation must not emit a message that implies successful DELETE of a resource until the resource has b successfully removed. 
  • (question) Compliance with LDP 5.2.5.1 When a contained LDPR is deleted, the LDPC server must also remove the corresponding containment triple, which has the effect of removing the deleted LDPR from the containing LDPC.
    (question) Compliance with LDP 5.2.5.2 When a contained LDPR is deleted, and the LDPC server created an associated LDP-RS (see the LDPC POST section), the LDPC server must also delete the associated LDP-RS it created.

3.8.1 Depth header ( Danny Bernstein: This section is no longer in the spec.)

  • (tick) MUST support a Depth header in the request, if DELETE is implemented
  • (question) MAY support only certain Depth header values: (How to query?)
  • (question) MUST return 400 if request includes Depth header and unsupported Depth header value: (How to query?)
  • (question) MUST use LDP containment relations for recursive deletion, if recursive deletion is supported: (How to query?)


3.9 External Binary Content

  • (tick) MUST return message/external-body in Accept-Post header (for each supported access-type param of supported Content-Types) if external binary content is supported
    • (In response to what?)
    • Danny Bernstein: a GET on the resource to be POSTed to I believe.
  • (minus) MUST return 415 for LDP-NR create or update if request has message/external-body and an unsupported access-type, or if external binary content is not supported
  • (minus) MUST NOT accept request (return 4xx???) for LDP-NR create or update if request has message/external-body and the server cannot return all the required response headers
  • (question) SHOULD return a Content-Location header for LDP-NR GET or HEAD (read? to match create or update above) with a URI to the content if the server is proxying: (How to query for proxying?)
  • (question)  MAY support an expiration parameter (for LDP-NR create or update?) if the request has a message/external-body Content-Type header
    • (warning) Expiration parameter is possibly up in the air now ? possibly replace with "Prefer" header syntax.
  • (question) SHOULD copy content (for LDP-NR create or update?) if the request has a message/external-body Content-Type header and the expiration parameter is set
  • (question) MUST return 4xx or 5xx (for LDP-NR create or update?) if the request has a message/external-body Content-Type header and the expiration parameter cannot be accommodated
  • (tick) MUST return a contrainedBy Link header (for LDP-NR create or update?) if the response status is 4xx: Tested in 3.2 and 3.3

3.9.1 Referenced RDF content in mandataory LDP serializations

  • Non-normative section

3.8.2 Proxied content vs. redirected content

  • Non-normative section


4 Versioning

Leads

4.1 Versioned Resources

4.1.1 HTTP GET  (LDPRv)

4.1.2 HTTP PUT (Danny Bernstein)

  • (tick) An implementation must support PUT, as is the case for any LDPR.

4.2 Version Resources (LDPRm)

  • (tick) An LDPRm may be deleted;
  • (tick) however, it must not be modified once created.


4.2.1 HTTP GET §

  • (tick) An implementation must support GET, as is the case for any LDPR (LDP-RS memento)
  • (tick) An implementation must support GET, as is the case for any LDPR (LDP-NR memento)
  • (tick) The headers for GET requests and responses on this resource must conform to [RFC7089section 2.1. Particularly it should be noted that the relevant TimeGate for an LDPRm is the original versioned LDPRv.
  • (tick) In addition, any response to a GET request must include a <http://mementoweb.org/ns#Memento>; rel="type" link in the Link header.

4.2.2 HTTP OPTIONS §

  • (tick) An implementation must support OPTIONS.
  • (tick) A response to an OPTIONS request must include Allow: GET, HEAD, OPTIONS as per [LDP].
  • (tick) An implementation may include Allow: DELETE if clients can remove a version from the version history, as noted in 3.8 HTTP DELETE.

4.2.3 HTTP POST 

  • (tick) An implementation must not support POST for LDPRms.

4.2.4 HTTP PUT 

  • (tick) An implementation must not support PUT for LDPRms.

4.2.5 HTTP PATCH 

  • (tick) An implementation must not support PATCH for LDPRms.

4.2.6 HTTP DELETE 

  • (tick) An implementation may support DELETE for LDPRms. If DELETE is supported, the server is responsible for all behaviors implied by the LDP-containment of the LDPRm.

4.3 Version Containers (LDPCv) (Jared Whiklo)

4.3.1 HTTP GET (Jared Whiklo)

  • (tick) An implementation must support GET, as is the case for any LDPR. Any response to a GET request must include a <http://mementoweb.org/ns#TimeMap>; rel="type" link in the Link header.
    • Uses the URI in above 4.3 point 1, needs updating
  • (tick) An LDPCv must respond to GET Accept: application/link-format as indicated in [RFC7089section 5 and specified in [RFC6690section 7.3.
  • (tick) An implementation must include the Allow header as outlined in 4.3.2 HTTP OPTIONS.
  • (warning) If an LDPCv supports POST, then it must include the Accept-Post header described in 4.3.3 HTTP POST.
    • 4.3.3 does not reference an Accept-Post header.

  • (minus) If an LDPCv supports PATCH, then it must include the Accept-Patch header.
    • Accept-Patch it is not mentioned in the spec.

4.3.2 HTTP OPTIONS (Jared Whiklo)

  • (tick) An implementation must Allow: GET, HEAD, OPTIONS as per [LDP].
  • (tick) An implementation may Allow: DELETE if the versioning behavior is removable by deleting the LDPCv. See 4.3.4HTTP DELETE for requirements on DELETE if supported.
  • (tick) An implementation may Allow: PATCH if the LDPCv has mutable properties. See 3.7.1 Containment Triples for requirements on PATCH if supported.
    • NB: it does not allow PATCH
  • (tick) An implementation may Allow: POST if versions can be explicitly minted by a client. See 4.3.3 HTTP POST for requirements on POST if supported.
  • (tick) Currently PUT is allowed. The spec doesn't explicitly ban it, but perhaps it should?
    • Esmé Cowles : an update to the spec should specify that LDPCv may disallow PATCH and PUT. Esme will do that.
    • We will need a JIRA to disallow PATCH and PUT and remove from OPTIONS.
  • (error) PUTting on binaries and their description mementos not quite done.

4.3.3 HTTP POST 

  • (minus) Although an LDPCv is both a TimeMap and an LDPC, it may disallow POST requests.
  • (tick) If an LDPCv supports POST, a POST that does not contain a Memento-Datetime header should be understood to create a new LDPRm contained by the LDPCv, reflecting the state of the LDPRv at the time of the POST. Any request body must be ignored.
  • (tick) If an LDPCv supports POST, a POST with a Memento-Datetime header should be understood to create a new LDPRm contained by the LDPCv, with the state given in the request body and the datetime given in the Memento-Datetime request header.
  • (minus) If an implementation does not support one or both of POST cases above, it must respond to such requests with a 4xx range status code and a link to an appropriate constraints document (see [LDP4.2.1.6).


4.3.4 HTTP DELETE 

  • (tick) An implementation may support DELETE.
  • (tick) An implementation that does support DELETE should do so by both removing the LDPCv and removing the versioning interaction model from the original LDPRv.

4.4 Vary 

(error) Non-normative note: When a POST to an LDPCv, or a PUT or PATCH to an LDPRv creates a new LDPRm, the response indicates this by using a Vary header as appropriate. When an LDPCv supports POST, and allows clients to specify a datetime for created URI-Ms, Vary-Post/Vary-Put: Memento-Datetime.
(warning) Verify whether this is done and if not create JIRA.e

4.5 Implementation Patterns 

Non-normative note: This section describes the way the normative specification might be applied to implement discoverable versioning patterns. If an implementation of an LDPCv does not support POST to mint versions, that must be advertised via OPTIONS as described in 4.3.2 HTTP OPTIONS. This allows a client to perform an OPTIONS request on an LDPCv to determine if it can explicitly mint versions. If the LDPCv does not support POST, the client should assume some other mechanism is used to mint versions, for example, the implementation may automatically mint versions instead, but that is outside the requirements of this specification. This document specifies normatively only how LDPCvs and LDPRms can be discovered, and how they should act.

4.5.1 Server-Managed Version Creation §

(warning) Non-normative note: Upon PUT or PATCH to an LDPRv, a new LDPRm is created in an appropriate LDPCv. This LDPRm is the version of the original LDPRv that was just created.

4.5.2 Client-Managed Version Creation §

(warning) Non-normative note: An LDPRm for a particular LDPRv is created on POST to any LDPCv associated with that LDPRv. The new LDPRm is contained in the LDPCv to which the POST was made and features in that LDPCv-as-a-TimeMap. This pattern is very flexible and might be useful for migration from other systems into Fedora implementations. Responses from requests to the LDPRv include a rel="timemap" link in the Linkheader that references the same LDPCv as per [RFC7089section 5.

4.5.3 Replacing Contents from Mementos §

Non-normative note: Using the ingest-by-reference mechanism, one can replace the contents of an LDPRvwith that of an LDPRm by providing it's URL as the URL parameter in a Content-Type: message/external-body header. For example, given an LDPRm with URL http://example.org/some/memento, the full header would be 
Content-Type: message/external-body; access-type=URL; expiration=1;
    URL="http://example.org/some/memento"

5 Resource Authorization

Leads

5. Resource Authorization §

  • (error) To configure access control restrictions, implementations MUST follow the recommendations of Web Access Control [SOLIDWEBAC] with the following additional requirements:
    • (tick) acl:agentGroup appears to be implemented but it wasn't working for me (Danny Bernstein)
    • (error) acl:default is not supported - currently behaves as "acl:default" exists without the acl:default defined.
    • (error) Unable to locate Jira server for this macro. It may be due to Application Link configuration.
    • (error) Unable to locate Jira server for this macro. It may be due to Application Link configuration.
    • (error) Unable to locate Jira server for this macro. It may be due to Application Link configuration.

5.1 ACLs are LDP RDF Sources §

  • (tick) An ACL for a controlled resource on a conforming server MUST itself be an LDP-RS.

5.2 ACL Representation and Interpretation § (Danny Bernstein)

  • (tick) Implementations MUST inspect the ACL RDF for authorizations.
  • (tick) Implementations MUST use only statements associated with an authorization in the ACL RDF to determine access,
    • (error) except in the case of acl:agentGroup statements where the group listing document is dereferenced.
  • (tick) The authorizations MUST be examined to see whether they grant the requested access to the controlled resource.
  • (tick) If none of the authorizations grant the requested access then the request MUST be denied.

5.3 ACLs are discoverable via Link Headers §

  • (tick) A conforming server MUST advertise the individual resource ACL for every controlled resource in HTTP responses with a rel="acl" link in the Link header, whether or not the ACL exists.
  • (tick) The ACL resource SHOULD be located in the same server as the controlled resource.

5.4 ACL linking on resource creation §

  • (tick) A client HTTP POST or PUT request to create a new LDPR MAY include a rel="acl" link in the Link header referencing an existing LDP-RS to use as the ACL for the new LDPR.
  • (minus) The server MUST reject the request and respond with a 4xx or 5xx range status code, such as 409 (Conflict) if it isn't able to create the LDPR with the specified LDP-RS as the ACL.
    • Assuming we will support the rel="acl" header on creation, this may be a non-issue.
  • (minus) In that response, the restrictions causing the request to fail MUST be described in a resource indicated by a rel="http://www.w3.org/ns/ldp#constrainedBy" link in the Link response header, following the pattern of [LDP] 4.2.1.6.
    • same as previous
  • Some consensus on the notion that we will try to implement but if not enough time, we will fall back to rejection mode.
  • (warning) This feature has been implemented but we may want to consider removing it based on SOLID requirements list in Section 5 (above)

5.5 Cross-Domain ACLs §

  • (tick) Implementations MAY restrict support for ACLs to local resources.
    • Currently we allow users to insert remote acl URIs, but on retrieval, 500 error.
  • (tick) If an implementation chooses to reject requests concerning remote ACLs,

5.6 Cross-Domain Group Listings §

  • (tick) Implementations MAY restrict support for [SOLIDWEBAC] groups of agents to local Group Listing documents.
  • (tick) If an implementation chooses to reject requests concerning remote Group Listings,
    • (tick) it MUST respond with a 4xx range status code
    • (tick)  and MUST advertise the restriction with a rel="http://www.w3.org/ns/ldp#constrainedBy" link in the Link response header.
    • (tick) Consensus seems to be: agent groups must be internal to the repository.
    • (warning) Do we need to perform any validation on the -Dfcrepo.auth.webac.userAgent.baseUri and fcrepo.auth.webac.groupAgent.baseUri to ensure these values do not cross domains?
      • NB: Those values are used in the bodies of notifications. Are they used anywhere else? Or do fcrepo.auth.webac.groupAgent.baseUri values

5.7 Append Mode §

  • (error) In the context of a Fedora implementation, acl:Append should be understood as operations that only append, such as POSTing to a container, or performing a PATCH that only adds triples.
  • The Append mode is currently unimplemented.

5.7.1 LDP-RS §

  • (error) When a client is allowed to perform acl:Append operations on an LDP-RS:
    • (error) A DELETE request MUST be denied
    • (error) A PATCH request that deletes triples MUST be denied
    • (error) A PATCH request that only adds triples SHOULD be allowed
    • (error) A PUT request on an existing resource MUST be denied
    • (error) A PUT request to create a new resource MUST be allowed if the implementation supports creating resources using PUT (see: 3.6.3 Creating resources with HTTP PUT)

5.7.2 LDPC §

  • (error) In addition to requirements in 5.7.1 LDP-RS, when a client is allowed to perform acl:Append operations on an LDPC, a POST request MUST be allowed.

5.7.3 LDP-NR §

  • (error) When a client is allowed to perform acl:Append operations on an LDP-NR:
    • (error) All DELETE, POST, and PUT requests MUST be denied
    • (error) A PATCH request that deletes or modifies existing content MUST be denied
    • (error) A PATCH request that only adds content SHOULD be allowed
      • (warning) This one seems potentially complicated. How would we determine? If File A's bytes match first bytes of File A' ?

5.8 Access To Class §

  • (tick) Notwithstanding [SOLIDWEBAC]'s lack of support for it, the acl:accessToClass predicate MUST be supported.
  • (tick) When an ACL includes an acl:accessToClass statement, it gives access to all resources with the specified type, whether that type is client-managed or server-managed.
  • (minus) An implementation MAY use inference to infer types not present in a resource's triples or rel="type" links in the Link header.
    • Danny Bernstein: This functionality appears to be implemented but I could not get it to work. No errors just got a 403 when I was expecting a 200.
    • (tick) Retested and it appears to be working as specified.

5.9 Inheritance and Default ACLs §

  • (tick) Inheritance of ACLs in Fedora implementations is defined by the [SOLIDWEBAC] ACL Inheritance Algorithm and MUST be reckoned along the [LDP] containment relationships linking controlled resources, with the following modification:
    • (error) In the case that the controlled resource is uncontained and has no ACL, or that there is no ACL at any point in the containment hierarchy of the controlled resource, then the server MUST supply a default ACL.
      • NB: acl:default rather than outdated acl:defaultForNew should be used.
    • (error) The default ACL resource SHOULD be located in the same server as the controlled resource.
      • we will need to enforce this once acl:default is supported.

6 Notifications

Lead

6.2 Notification Events §

  • (tick) For every resource whose state is changed as a result of an HTTP operation, there must be a corresponding notification made available describing that change.

6.3 Notification Serialization §

Each event described by a notification must contain:

  • The IRI of the resource that was created, modified or deleted (
  • (tick) The event type(s) corresponding to the HTTP operation

Each event described by a notification should contain:

  • (tick) The agent(s) that caused the change to occur
  • (tick) The RDF type(s) of the resource that was changed
  • (minus) The location of the ldp:inbox for the resource that was changed, if such an inbox link exists
    • We are not planning to support the ldp:inbox in the reference implementation.
  • (tick) Notifications should not contain the entire content of repository resources.

7 Binary Resource Fixity

Lead

7.1 What is fixity?

Example proceedures that may be used to verify fixity:

7.2 Transmission Fixity

  • (tick) may be verified by including a Digest header (defined in [RFC3230]) in POST
    • for example, in curl command: -H "Digest:sha=a79ca8393d8866ce4899f523235a3b8b6812e76b"
  • (tick) may be verified by including a Digest header (defined in [RFC3230])  in PUT
    • for example, in curl command: -H "Digest:sha=a79ca8393d8866ce4899f523235a3b8b6812e76b"


7.3 Persistance Fixity

  • (tick) may retrieve the checksum of an LDP-NR by performing a HEAD request on it with the Want-Digest header
    • mechanism: curl command for HEAD with header: -H "Want-Digest: md5,sha" will return, in the headers:
      Digest: sha=9f0f5b0c24303b003b5afaa0031e126cc6f7fa67,md5=0a85fd5f25c09a9f282b15e7758b3acd
  • (tick) may retrieve the checksum of an LDP-NR by performing a GET request on it with the Want-Digest header
    • mechanism: curl command for GET with header: -H "Want-Digest: md5,sha" will return, in the headers:
      Digest: sha=9f0f5b0c24303b003b5afaa0031e126cc6f7fa67,md5=0a85fd5f25c09a9f282b15e7758b3acd

  • No labels