openapi: 3.0.0
info:
  version: "1.0.0"
  title: "Checks whether records contain a retrievable protocol."
  x-tests_metric: "https://doi.org/10.25504/FAIRsharing.xxxx"
  description: >-
    "Checks for the presence of retrievable open protocol identifiers in the document by looking for known elements and attempting to resolve them using known PID resolution services."
  x-applies_to_principle: "https://doi.org/10.25504/FAIRsharing.7612c1"
  contact:
    x-organization: "Consortium of European Social Science Data Archives"
    url: "https://cessda.eu"
    name: "John Shepherdson"
    x-role: responsible developer
    email: "john.shepherdson@cessda.eu"
    x-id: "https://orcid.org/0000-0002-4402-9644"
paths:
  "/retrievable-protocol":
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/schemas"
        required: true
      responses:
        "200":
          description:  >-
            The response is "pass", "fail" or "indeterminate"
servers:
  - url: "https://fair-tests.cessda.eu/assess/test"
components:
  schemas:
    schemas:
      required:
        - resource_identifier
      properties:
      - resource_identifier:
          type: string
          description: the GUID being tested