API legal

This page is for the person who connects a program to the API.

The terms and the privacy notice that the operator of the installation writes. A person reads them with no account.

getLegalDocument

GET /legal/{document}

Read one legal document of the installation.

Answers the terms or the privacy notice as one HTML document that the server builds from the Markdown file of the operator, with the one sanitized renderer (record 0140). The page holds no script, and its only style sheet is the built style sheet of the application. The operation declares an empty security requirement, so a person reads the documents before they have an account. A document that the operator names by an external address, or does not name, answers not found.

Authentication

No security scheme is declared. See the operation description.

Parameters

x-request-id

JSON

{
  "name": "x-request-id",
  "in": "header",
  "required": false,
  "style": "simple",
  "explode": false,
  "description": "Optional caller supplied correlation identifier. The server echoes the value and generates a UUID when the header is absent. A value outside the pattern below is rejected with a 400 problem.",
  "schema": {
    "type": "string",
    "minLength": 1,
    "maxLength": 128,
    "pattern": "^[A-Za-z0-9._-]+$"
  }
}

document

JSON

{
  "name": "document",
  "in": "path",
  "required": true,
  "style": "simple",
  "explode": false,
  "description": "Which legal document to read, the terms or the privacy notice.",
  "schema": {
    "type": "string",
    "enum": [
      "terms",
      "privacy"
    ]
  }
}

Responses

200

The legal document, as one HTML document.

JSON

{
  "description": "The legal document, as one HTML document.",
  "headers": {
    "cache-control": {
      "description": "States that the browser checks the page again each time and that no shared cache stores it. The document changes only when the server starts again.",
      "schema": {
        "type": "string",
        "maxLength": 256
      }
    }
  },
  "content": {
    "text/html": {
      "schema": {
        "$ref": "#/components/schemas/LegalPageDocument"
      }
    }
  }
}

Schemas: LegalPageDocument.

400

The request did not match the contract.

JSON

{
  "description": "The request did not match the contract.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}

Schemas: ProblemDetails.

404

The requested resource does not exist.

JSON

{
  "description": "The requested resource does not exist.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}

Schemas: ProblemDetails.

500

The service failed to complete the request.

JSON

{
  "description": "The service failed to complete the request.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}

Schemas: ProblemDetails.