---
swagger: "2.0"
info:
  description: "API for Scholix Object"
  version: "1.0.0"
  title: "Scholix API"
host: "api-dliservice-prototype-dli.d4science.org"
basePath: "/v1"
schemes:
- "https"
produces:
- "application/json"
paths:
  /linksFromPid:
    get:
      tags:
      - "Scholix"
      summary: "Retrieve all scholix links from a persistent identifier"
      description: "The linksFromPid endpoint returns a list of scholix object related\
        \ from a specific persistent identifier\n"
      operationId: "links_from_pid_get"
      parameters:
      - name: "pid"
        in: "query"
        description: "persistent Identifier"
        required: true
        type: "string"
      - name: "pidType"
        in: "query"
        description: "Persistent Identifier Type"
        required: false
        type: "string"
      - name: "typologyTarget"
        in: "query"
        description: "typology target filter should be  publication, dataset or unknown"
        required: false
        type: "string"
      - name: "datasourceTarget"
        in: "query"
        description: "a datasource provenace filter of the target relation"
        required: false
        type: "string"
      - name: "page"
        in: "query"
        description: "The page of results"
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "An array of scholix Object"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Scholix"
        default:
          description: "Unexpected error"
          schema:
            $ref: "#/definitions/Error"
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
  /linksFromDatasource:
    get:
      tags:
      - "Scholix"
      summary: "Get all scholix relation collected from a datasource"
      description: "The realtionFromDatasource endpoint returns a list of scholix\
        \ object collected from\na specific datasource\n"
      operationId: "links_from_datasource_get"
      parameters:
      - name: "datasource"
        in: "query"
        description: "the name of the datasource"
        required: true
        type: "string"
      - name: "page"
        in: "query"
        description: "The page of results"
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "An array of scholix Object"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Scholix"
        default:
          description: "Unexpected error"
          schema:
            $ref: "#/definitions/Error"
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
  /linksFromPublishers:
    get:
      tags:
      - "Scholix"
      summary: "Get all scholix relation collected from a publisher"
      description: "The linksFromPublishers endpoint returns a list of scholix\
        \ object collected from\na specific publisher\n"
      operationId: "links_from_datasource_get"
      parameters:
      - name: "publisher"
        in: "query"
        description: "the name of the publisher"
        required: true
        type: "string"
      - name: "page"
        in: "query"
        description: "The page of results"
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "An array of scholix Object"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Scholix"
        default:
          description: "Unexpected error"
          schema:
            $ref: "#/definitions/Error"
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
  /listDatasources:
    get:
      tags:
      - "Datasources"
      summary: "Get the list of all Datasources"
      description: "The realtionFromDatasource endpoint returns a list of scholix\
        \ object collected from\na specific datasource\n"
      operationId: "list_datasources_get"
      parameters:
      - name: "page"
        in: "query"
        description: "The page of results"
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "An array of Datasource name"
          schema:
            type: "array"
            items:
              type: "string"
        default:
          description: "Unexpected error"
          schema:
            $ref: "#/definitions/Error"
      x-swagger-router-controller: "swagger_server.controllers.datasources_controller"
definitions:
  Scholix:
    type: "object"
    properties:
      publicationDate:
        type: "string"
        format: "date"
      linkPublisher:
        $ref: "#/definitions/DSType"
      linkProvider:
        type: "array"
        items:
          $ref: "#/definitions/DSType"
      relationship:
        $ref: "#/definitions/RelationshipType"
      source:
        $ref: "#/definitions/ObjectType"
      target:
        $ref: "#/definitions/ObjectType"
  DSType:
    type: "object"
    properties:
      name:
        type: "string"
        description: "The name of the Repository that provides the link"
      identifiers:
        type: "array"
        description: "a List of Identifiers that identify the repository"
        items:
          $ref: "#/definitions/IdentifierType"
  ObjectType:
    type: "object"
    properties:
      identifiers:
        type: "array"
        description: "a List of Identifiers that identify the repository"
        items:
          $ref: "#/definitions/IdentifierType"
      objectType:
        $ref: "#/definitions/ObjectType_objectType"
      title:
        type: "string"
      creators:
        type: "array"
        description: "a List of Identifiers that identify the repository"
        items:
          $ref: "#/definitions/CreatorType"
      publication:
        type: "string"
        format: "date"
      objectProvider:
        type: "array"
        items:
          $ref: "#/definitions/DSType"
      publisher:
        $ref: "#/definitions/ObjectType_publisher"
  CreatorType:
    type: "object"
    properties:
      name:
        type: "string"
      identifiers:
        type: "array"
        description: "a List of Identifiers that identify the repository"
        items:
          $ref: "#/definitions/IdentifierType"
  IdentifierType:
    type: "object"
    properties:
      identifier:
        type: "string"
      schema:
        type: "string"
  RelationshipType:
    type: "object"
    properties:
      name:
        type: "string"
      schema:
        type: "string"
      inverseRelationship:
        type: "string"
  Error:
    type: "object"
    properties:
      code:
        type: "integer"
        format: "int32"
      message:
        type: "string"
  ObjectType_objectType:
    properties:
      type:
        type: "string"
      subType:
        type: "string"
  ObjectType_publisher:
    properties:
      name:
        type: "string"
      identifiers:
        type: "array"
        description: "a List of Identifiers that identify the repository"
        items:
          $ref: "#/definitions/IdentifierType"