afs commented on code in PR #188: URL: https://github.com/apache/jena-site/pull/188#discussion_r1676229356
########## source/documentation/.DS_Store: ########## Review Comment: This should be removed. ########## source/documentation/fuseki2/prefixes-service.md: ########## @@ -0,0 +1,108 @@ +# Prefixes Service + +## Overview +The prefix service provides prefix lookup, update and remove functionalities +for 3 different implementations of prefix-namespace storage: MapStorage , which is a Java Map data structure, +RDFStorage - a DatasetGraph, and PrefixStorage, which uses a DatasetGraph's PrefixMap. + +## Operations + +The service supports fetch, remove and update operations on prefixes. +When making requests to the API the url can have 3 parameters: prefix, uri, and prefixToRemove. +The fetch request is an HTTP GET and the update and remove operations get invoked +via HTTP POST. + +### FetchURI +If only the prefix parameter is provided and the rest are null, +the service will perform a fetch operation and return the corresponding URI. +If no such prefix exists in the database the operation returns an empty String. + +### FetchPrefix +If only the URI parameter is provided and the rest are null, +the service will perform a fetch operation and return the corresponding prefixes in a JsonArray. +If no such prefix exists in the database the operation returns an empty String. + +### GetAll +A HTTP GET with no parameters returns all the prefix-URI pairs present in the dataset in a JsonArray. + +### Update +If only the prefixToRemove parameter is left null, the provided prefix-uri pair will be +added to the dataset. If the provided prefix already exists in the database, the pair will be overwritten. +In case the namespace already exists with a different prefix, the pair will be added to the dataset. + +### Remove +The remove operation is performed when only the prefixToRemove parameters is provided +and the other parameters are null. It removes the prefix-namespace pair matching the provided +prefix. The operation is considered successful when the request is correctly formed +even if the prefix doesn't exist in the database. Review Comment: This needs updating because DELETE is now used instead of `prefixToRemove`. ########## source/documentation/fuseki2/prefixes-service.md: ########## @@ -0,0 +1,108 @@ +# Prefixes Service + +## Overview +The prefix service provides prefix lookup, update and remove functionalities +for 3 different implementations of prefix-namespace storage: MapStorage , which is a Java Map data structure, +RDFStorage - a DatasetGraph, and PrefixStorage, which uses a DatasetGraph's PrefixMap. Review Comment: Might be better to focus on the form available to be configured - the PrefixMap of a DatasetGraph. ```suggestion The prefix service provides prefix lookup, update and delete functionality on a collection of prefixes. It provides a read access endpoint to look up a prefix name and to look up an URI to get prefixes for a URI and also read-write access which adds the ability to add and delete prefix entries. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@jena.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
