FDP Open API

openapi.yaml

openapi: 3.0.0
info:
  description:
    Find more about [FAIR Data Point](https://github.com/NLeSC/fairdatapoint).
  version: "1.0.0"
  title: FAIR Data Point REST APIs
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
  - description: API version 1
    url: /
tags:
  - name: Metadata
    description: Metadata Controller
  - name: Users
    description: Uers Controller
paths:
  /fdp:
    get:
      tags:
        - Metadata
      summary: Get FDP metadata
      operationId: fdp.api.FDP.get
      responses:
        '200':
          $ref: '#/components/responses/withRDFContent'
    post:
      tags:
        - Metadata
      summary: Create FDP metadta
      operationId: fdp.api.FDP.post
      requestBody:
        required: true
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '405':
          description: Validation exception
    put:
      tags:
        - Metadata
      summary: Update FDP metadta
      operationId: fdp.api.FDP.put
      requestBody:
        required: true
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '405':
          description: Validation exception
  /catalog:
    get:
      tags:
        - Metadata
      summary: Get catalog list
      operationId: fdp.api.Catalog.get_all
      responses:
        '200':
          description: Successful operation
        '204':
          description: No Content
    post:
      tags:
        - Metadata
      summary: Create Catalog metadta
      operationId: fdp.api.Catalog.post
      requestBody:
        required: true
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '405':
          description: Validation exception
  /catalog/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Catalog identifier
        schema:
          type: string
        example: 'catalog01'
    get:
      tags:
        - Metadata
      summary: Get Catalog metadata
      operationId: fdp.api.Catalog.get
      responses:
        '200':
          $ref: '#/components/responses/withRDFContent'
        '404':
          description: Invalid ID supplied
    put:
      tags:
        - Metadata
      summary: Update Catalog metadta
      operationId: fdp.api.Catalog.put
      requestBody:
        required: true
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '404':
          description: Invalid ID supplied
        '405':
          description: Validation exception
    delete:
      tags:
        - Metadata
      summary: Delete Catalog metadta
      operationId: fdp.api.Catalog.delete
      responses:
        '204':
          description: Successful operation
        '404':
          description: Invalid ID supplied
  /dataset:
    get:
      tags:
        - Metadata
      summary: Get dataset list
      operationId: fdp.api.Dataset.get_all
      responses:
        '200':
          description: Successful operation
    post:
      tags:
        - Metadata
      summary: Create Dataset metadta
      operationId: fdp.api.Dataset.post
      requestBody:
        required: true
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '405':
          description: Validation exception
  /dataset/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Dataset identifier
        schema:
          type: string
        example: 'dataset01'
    get:
      tags:
        - Metadata
      summary: Get Dataset metadata
      operationId: fdp.api.Dataset.get
      responses:
        '200':
          $ref: '#/components/responses/withRDFContent'
        '404':
          description: Invalid ID supplied
    put:
      tags:
        - Metadata
      summary: Update Dataset metadta
      operationId: fdp.api.Dataset.put
      requestBody:
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '404':
          description: Invalid ID supplied
        '405':
          description: Validation exception
    delete:
      tags:
        - Metadata
      summary: Delete Dataset metadta
      operationId: fdp.api.Dataset.delete
      responses:
        '204':
          description: Successful operation
        '404':
          description: Invalid ID supplied
  /distribution:
    get:
      tags:
        - Metadata
      summary: Get distribution list
      operationId: fdp.api.Distribution.get_all
      responses:
        '200':
          description: Successful operation
          # content:
          #   '*/*':
          #     example: |-
          #       http://distribution/cata01
          #       http://distribution/cata02
    post:
      tags:
        - Metadata
      summary: Create Distribution metadta
      operationId: fdp.api.Distribution.post
      requestBody:
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '405':
          description: Validation exception
  /distribution/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: Distribution identifier
        schema:
          type: string
        example: 'distribution01'
    get:
      tags:
        - Metadata
      summary: Get Distribution metadata
      operationId: fdp.api.Distribution.get
      responses:
        '200':
          $ref: '#/components/responses/withRDFContent'
        '404':
          description: Invalid ID supplied
    put:
      tags:
        - Metadata
      summary: Update Distribution metadta
      operationId: fdp.api.Distribution.put
      requestBody:
        $ref: '#/components/requestBodies/RDF'
      responses:
        '200':
          description: Successful operation
        '404':
          description: Invalid ID supplied
        '405':
          description: Validation exception
    delete:
      tags:
        - Metadata
      summary: Delete Distribution metadta
      operationId: fdp.api.Distribution.delete
      responses:
        '204':
          description: Successful operation
        '404':
          description: Invalid ID supplied
components:
  requestBodies:
    RDF:
      content:
        text/turtle:
          schema:
            {}
        text/n3:
          schema:
            {}
        application/ld+json:
          schema:
            {}
        application/rdf+xml:
          schema:
            {}
        application/n-triples:
          schema:
            {}
  responses:
    withRDFContent:
      description: Successful operation
      content:
        text/turtle:
          {}
        text/n3:
          {}
        application/rdf+xml:
          {}
        application/ld+json:
          {}
        application/n-triples:
          {}