openapi: 3.0.1
info:
  version: 1.0.11
  title: "OpenAIRE: (meta)data are registered or indexed in a searchable resource"
  description: >-
    Assessed by verifying that the metadata are exposed and harvestable via the OAI-PMH protocol in compliance with the OpenAIRE Guidelines for Data Archives, enabling the aggregation and indexing of the resource into the OpenAIRE infrastructure. Conformance to the OpenAIRE OAI-PMH requirements ensures that the (meta)data are registered in a searchable and widely accessible resource.
  x-applies_to_principle: https://fairsharing.org/10.25504/FAIRsharing.0c0d21
  contact:
    x-organization: "OpenAIRE"
    url: "https://www.openaire.eu"
    name: "Katerina Iatropoulou"
    x-role: responsible developer
    email: "kiatrop@athenarc.gr"
    x-id: "https://orcid.org/0000-0001-9991-9719"
servers:
  - url: "https://beta.services.openaire.eu/osTrails"
paths:
  /tests/F4_data:
    post:
      summary: "POST: Test F4_data"
      description: >-
        Submit a POST request with a resource identifier to test whether the resource satisfies the conditions for test F4_data.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TestRequest"
      responses:
        "200":
          description: "The test result: pass or fail"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TestResponse"
components:
  schemas:
    TestRequest:
      required:
        - resource_identifier
      properties:
        resource_identifier:
          type: string
          format: uri
          description: "A resolvable URL to an OAI PMH endpoint identifying the resource to be assessed."

    TestResponse:
      type: object
      properties:
        result:
          type: string
          enum: [pass, fail]
          description: "Outcome of the FAIR test."