Eclipse RDF4J Namespaces API

openapi: 3.2.0
info:
  title: RDF4J REST Namespaces API
  version: '10'
  description: 'The RDF4J REST API is an HTTP protocol that covers a fully compliant implementation of the SPARQL 1.1 Protocol W3C Recommendation. This ensures that RDF4J Server functions as a fully standard-compliant SPARQL endpoint.


    The RDF4J REST API additionally supports the SPARQL 1.1 Graph Store HTTP Protocol W3C Recommendation. The RDF4J REST API extends the W3C standards in several aspects, the most important of which is database transaction management.'
servers:
- url: http://localhost:8080/rdf4j-server/
  description: RDF4J Server on localhost
tags:
- name: Namespaces
  description: Namespaces management
paths:
  /repositories/{repositoryID}/namespaces:
    get:
      tags:
      - Namespaces
      summary: Retrieve namespaces
      description: Fetch all namespace declaration info available in the repository
      parameters:
      - name: repositoryID
        in: path
        required: true
        description: The repository ID
        schema:
          type: string
      responses:
        200:
          description: List of namespaces encoded as tuple query result.
          content:
            application/sparql-results+xml:
              schema:
                type: object
                xml:
                  name: sparql
                  namespace: http://www.w3.org/2005/sparql-results#
              example: "<?xml version='1.0' encoding='UTF-8'?>\n<sparql xmlns='http://www.w3.org/2005/sparql-results#'>\n  <head>\n    <variable name='prefix'/>\n    <variable name='namespace'/>\n  </head>\n  <results ordered='false' distinct='false'>\n    <result>\n      <binding name='prefix'>\n        <literal>rdf</literal>\n      </binding>\n      <binding name='namespace'>\n        <literal>http://www.w3.org/1999/02/22-rdf-syntax-ns#</literal>\n      </binding>\n    </result>\n  </results>\n</sparql>\n"
            application/x-binary-rdf-results-table:
              schema:
                type: string
                format: binary
            application/sparql-results+json:
              schema:
                type: object
                format: json
      operationId: getRepositoriesByRepositoryIDNamespaces
      x-operation-id-source: derived
    delete:
      tags:
      - Namespaces
      summary: Clear all namespaces
      description: Remove all namespace declarations from the repository
      parameters:
      - name: repositoryID
        in: path
        required: true
        description: The repository ID
        schema:
          type: string
      responses:
        204:
          description: All namespaces were removed
      operationId: deleteRepositoriesByRepositoryIDNamespaces
      x-operation-id-source: derived
  /repositories/{repositoryID}/namespaces/{namespacesPrefix}:
    get:
      tags:
      - Namespaces
      summary: Get namespace by prefix
      description: Gets the namespace that has been defined for a particular prefix.
      parameters:
      - name: repositoryID
        in: path
        required: true
        description: The repository ID
        schema:
          type: string
      - name: namespacesPrefix
        in: path
        required: true
        description: URI prefix of a RDF resource
        schema:
          type: string
      responses:
        200:
          description: The defined namespace of the given prefix.
          content:
            text/plain:
              schema:
                type: string
              example: http://www.example.com
      operationId: getRepositoriesByRepositoryIDNamespacesByNamespacesPrefix
      x-operation-id-source: derived
    put:
      tags:
      - Namespaces
      summary: Set namespace for a particular prefix
      description: Sets a new namespace for a particular prefix. If the prefix was previously mapped to a different namespace, this will be overwritten.
      parameters:
      - name: repositoryID
        in: path
        required: true
        description: The repository ID
        schema:
          type: string
      - name: namespacesPrefix
        in: path
        required: true
        description: URI prefix of a RDF resource
        schema:
          type: string
        example: ex
      requestBody:
        content:
          text/plain:
            schema:
              type: string
            example: http://www.example.com
      responses:
        204:
          description: The defined namespace was successfully set to the given prefix.
      operationId: putRepositoriesByRepositoryIDNamespacesByNamespacesPrefix
      x-operation-id-source: derived
    delete:
      tags:
      - Namespaces
      summary: Remove namespace for a particular prefix
      description: Removes the namespace that has been defined for a particular prefix.
      parameters:
      - name: repositoryID
        in: path
        required: true
        description: The repository ID
        schema:
          type: string
      - name: namespacesPrefix
        in: path
        required: true
        description: URI prefix of a RDF resource
        schema:
          type: string
      responses:
        204:
          description: The defined namespace with the given prefix was successfully removed.
      operationId: deleteRepositoriesByRepositoryIDNamespacesByNamespacesPrefix
      x-operation-id-source: derived
externalDocs:
  url: https://rdf4j.org/documentation/reference/rest-api/
x-provenance:
  method: harvested
  publisher: Eclipse RDF4J
  source: https://rdf4j.org/documentation/reference/rest-api/rdf4j-openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)