Orakl

Orakl CommonContent API

Resource 'CommonContent' operations.

GitHub OpenAPI

Documentation

📖
APIReference
https://www.orakl-oncology.com/api/docs.jsonld
📖
Documentation
https://www.orakl-oncology.com/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/openapi/orakl-commoncontent-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/errors/orakl-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/conventions/orakl-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/data-model/orakl-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/conformance/orakl-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/lifecycle/orakl-lifecycle.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/orakl/refs/heads/main/apis.yml

OpenAPI Specification

orakl-commoncontent-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Orakl Oncology public website CommonContent API
  description: Orakl Oncology public website API
  version: 1.0.7
servers:
- url: /
  description: ''
security: []
tags:
- name: CommonContent
  description: Resource 'CommonContent' operations.
paths:
  /api/common_content:
    get:
      operationId: getCommonContent
      tags:
      - CommonContent
      responses:
        '200':
          description: CommonContent resource
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/CommonContent.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
            application/json:
              schema:
                $ref: '#/components/schemas/CommonContent-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
            application/x-www-form-urlencoded:
              schema:
                $ref: '#/components/schemas/CommonContent.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
        '404':
          description: Not found
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Error.jsonld'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '401':
          description: Invalid JWT Token
      summary: Retrieves a CommonContent resource.
      description: Retrieves a CommonContent resource.
      parameters:
      - name: _preview
        in: query
        description: Enables preview mode (requires a valid bearer JWT token)
        required: false
        deprecated: false
        schema:
          type: boolean
        style: form
        explode: false
        example: '1'
      security:
      - JWT: []
components:
  schemas:
    ? TranslationInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
    ? NodesSourcesHeadInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? Node-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      required:
      - nodeName
      properties:
        nodeName:
          maxLength: 255
          description: Unique node name (slug) used to build content URL
          default: ''
          example: this-is-a-node-name
          type: string
        visible:
          description: Is this node visible in website navigation?
          default: true
          example: 'true'
          type: boolean
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
    ? NodesSources-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        title:
          maxLength: 250
          description: Content title
          example: This is a title
          type:
          - string
          - 'null'
        publishedAt:
          description: Content publication date and time
          type:
          - string
          - 'null'
          format: date-time
        node:
          $ref: '#/components/schemas/Node-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
        translation:
          $ref: '#/components/schemas/TranslationInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
        slug:
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
      required:
      - node
      - translation
    HydraItemBaseSchema:
      type: object
      properties:
        '@context':
          oneOf:
          - type: string
          - type: object
            properties:
              '@vocab':
                type: string
              hydra:
                type: string
                enum:
                - http://www.w3.org/ns/hydra/core#
            required:
            - '@vocab'
            - hydra
            additionalProperties: true
        '@id':
          type: string
        '@type':
          type: string
      required:
      - '@id'
      - '@type'
    ? CommonContent-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        home:
          anyOf:
          - $ref: '#/components/schemas/NodesSources-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
          - type: 'null'
        errorPage:
          anyOf:
          - $ref: '#/components/schemas/WalkerInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
          - type: 'null'
        head:
          anyOf:
          - $ref: '#/components/schemas/NodesSourcesHeadInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
          - type: 'null'
        footers:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
    ? CommonContent.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        home:
          anyOf:
          - $ref: '#/components/schemas/NodesSources.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
          - type: 'null'
        errorPage:
          anyOf:
          - $ref: '#/components/schemas/WalkerInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
          - type: 'null'
        head:
          anyOf:
          - $ref: '#/components/schemas/NodesSourcesHeadInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
          - type: 'null'
        footers:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
    ? NodesSourcesHeadInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? WalkerInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? Tag.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        visible:
          description: Is this tag visible in website?
          default: true
          example: 'true'
          type: boolean
        slug:
          readOnly: true
          description: Unique tag name (slug) used to build content URL or filter queries.
          example: this-is-a-tag-name
          type: string
    ? WalkerInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? Tag.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : allOf:
      - $ref: '#/components/schemas/HydraItemBaseSchema'
      - type: object
        properties:
          visible:
            description: Is this tag visible in website?
            default: true
            example: 'true'
            type: boolean
          slug:
            readOnly: true
            description: Unique tag name (slug) used to build content URL or filter queries.
            example: this-is-a-tag-name
            type: string
      description: Tags are hierarchical entities used to qualify Nodes.
    ? NodesSourcesHeadInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? Tag-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        visible:
          description: Is this tag visible in website?
          default: true
          example: 'true'
          type: boolean
        slug:
          readOnly: true
          description: Unique tag name (slug) used to build content URL or filter queries.
          example: this-is-a-tag-name
          type: string
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
          - string
          - 'null'
        detail:
          readOnly: true
          description: A human-readable explanation specific to this occurrence of the problem.
          type:
          - string
          - 'null'
        status:
          type:
          - number
          - 'null'
          examples:
          - 404
          default: 400
        instance:
          readOnly: true
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
          type:
          - string
          - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
    ? NodesSources.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : allOf:
      - $ref: '#/components/schemas/HydraItemBaseSchema'
      - type: object
        properties:
          title:
            maxLength: 250
            description: Content title
            example: This is a title
            type:
            - string
            - 'null'
          publishedAt:
            description: Content publication date and time
            type:
            - string
            - 'null'
            format: date-time
          node:
            $ref: '#/components/schemas/Node.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
          translation:
            $ref: '#/components/schemas/TranslationInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
          slug:
            readOnly: true
            type: string
          '@type':
            readOnly: true
            type: string
        required:
        - node
        - translation
      description: NodesSources store Node content according to a translation and a NodeType.
    ? Node.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      required:
      - nodeName
      properties:
        nodeName:
          maxLength: 255
          description: Unique node name (slug) used to build content URL
          default: ''
          example: this-is-a-node-name
          type: string
        visible:
          description: Is this node visible in website navigation?
          default: true
          example: 'true'
          type: boolean
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
    Error.jsonld:
      allOf:
      - $ref: '#/components/schemas/HydraItemBaseSchema'
      - type: object
        properties:
          title:
            readOnly: true
            description: A short, human-readable summary of the problem.
            type:
            - string
            - 'null'
          detail:
            readOnly: true
            description: A human-readable explanation specific to this occurrence of the problem.
            type:
            - string
            - 'null'
          status:
            type:
            - number
            - 'null'
            examples:
            - 404
            default: 400
          instance:
            readOnly: true
            description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
            type:
            - string
            - 'null'
          type:
            readOnly: true
            description: A URI reference that identifies the problem type
            type: string
          description:
            readOnly: true
            type:
            - string
            - 'null'
      description: A representation of common errors.
    ? TranslationInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
    ? CommonContent.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : allOf:
      - $ref: '#/components/schemas/HydraItemBaseSchema'
      - type: object
        properties:
          home:
            anyOf:
            - $ref: '#/components/schemas/NodesSources.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
            - type: 'null'
          errorPage:
            anyOf:
            - $ref: '#/components/schemas/WalkerInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
            - type: 'null'
          head:
            anyOf:
            - $ref: '#/components/schemas/NodesSourcesHeadInterface.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid'
            - type: 'null'
          footers:
            type:
            - array
            - 'null'
            items:
              type:
              - string
              - 'null'
    ? TranslationInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
    ? WalkerInterface-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders_noid
    : type: object
    ? Node.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : allOf:
      - $ref: '#/components/schemas/HydraItemBaseSchema'
      - type: object
        required:
        - nodeName
        properties:
          nodeName:
            maxLength: 255
            description: Unique node name (slug) used to build content URL
            default: ''
            example: this-is-a-node-name
            type: string
          visible:
            description: Is this node visible in website navigation?
            default: true
            example: 'true'
            type: boolean
          tags:
            type: array
            items:
              $ref: '#/components/schemas/Tag.jsonld-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
      description: 'Node entities are the central feature of Roadiz,

        it describes a document-like object which can be inherited

        with *NodesSources* to create complex data structures.'
    ? NodesSources.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders
    : type: object
      properties:
        title:
          maxLength: 250
          description: Content title
          example: This is a title
          type:
          - string
          - 'null'
        publishedAt:
          description: Content publication date and time
          type:
          - string
          - 'null'
          format: date-time
        node:
          $ref: '#/components/schemas/Node.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
        translation:
          $ref: '#/components/schemas/TranslationInterface.x-www-form-urlencoded-get_common_content_web_response_walker_walker_level_children_children_count_nodes_sources_base_nodes_sources_cta_nodes_sources_default_urls_tag_base_translation_base_document_display_document_folders'
        slug:
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
      required:
      - node
      - translation
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT