University of Helsinki Content - Course API

openapi: 3.2.0
info:
  title: University of Helsinki - Courses content machine - JSON…
  description: This is a JSON API compliant implementation
  version: Versioning not supported
servers:
- url: https://gw.api.helsinki.fi/course-pages-cms
tags:
- name: Content - Course
  description: Content type Course of type Content. Contains information related to a course, such as introduction text and an image.
  x-entity-type: node
  x-definition:
    $ref: '#/definitions/node--course'
paths:
  /node/course:
    get:
      tags:
      - Content - Course
      summary: List (Content - Course)
      description: Collection endpoint for the node--course resource type. Collections are a list of resource objects for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: filter
        in: query
        description: The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
        style: form
        explode: false
        schema:
          type: array
      - name: sort
        in: query
        description: The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
        style: form
        explode: false
        schema:
          type: array
      - name: page
        in: query
        description: Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
        style: form
        explode: false
        schema:
          type: array
      - name: include
        in: query
        description: 'Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.'
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                title: node:course Schema
                required:
                - data
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/node--course/properties/data'
                  meta:
                    type: object
                    additionalProperties: true
                    description: Non-standard meta-information that can not be represented as an attribute or relationship.
                  links:
                    type: object
                    additionalProperties:
                      required:
                      - href
                      type: object
                      properties:
                        href:
                          type: string
                          description: 'A string containing the link''s URL . '
                          format: uri - reference
                        meta:
                          type: object
                          additionalProperties: true
                          description: Non-standard meta-information that can not be represented as an attribute or relationship.
                      description: 'A link **MUST** be represented as either: a string containing the link''s URL or a link object . '
                  jsonapi:
                    type: object
                    additionalProperties: false
                    description: An object describing the server's implementation
                additionalProperties: true
                description: Contains information related to a course, such as introduction text and an image.
      operationId: getNodeCourse
      x-operation-id-source: derived
  /node/course/{entity}/field_component_results:
    get:
      tags:
      - Content - Course
      summary: 'Related: field_component_results (Paragraph - Title)'
      description: Related endpoint for the paragraph--title resource type through the field_component_results relationship. The related endpoint contains a resource object with the data for a particular related resource or entity.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content: {}
      operationId: getNodeCourseByEntityFieldComponentResults
      x-operation-id-source: derived
  /node/course/{entity}/relationships/field_component_results:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: field_component_results (Paragraph - Title)'
      description: Relationship endpoint for the paragraph--title resource type through the field_component_results relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    uniqueItems: true
                    type: array
                    description: An array of objects each containing \"type\" and \"id\" members for to-many relationships.
                    items:
                      type: object
                      additionalProperties: false
                      description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsFieldComponentResults
      x-operation-id-source: derived
  /node/course/{entity}/relationships/field_course_material_groups:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: field_course_material_groups (Paragraph - --OBSOLETE-- Material…'
      description: Relationship endpoint for the paragraph--material_group resource type through the field_course_material_groups relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    uniqueItems: true
                    type: array
                    description: An array of objects each containing \"type\" and \"id\" members for to-many relationships.
                    items:
                      type: object
                      additionalProperties: false
                      description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsFieldCourseMaterialGroups
      x-operation-id-source: derived
  /node/course/{entity}/field_image:
    get:
      tags:
      - Content - Course
      summary: 'Related: field_image (File)'
      description: Related endpoint for the file--file resource type through the field_image relationship. The related endpoint contains a resource object with the data for a particular related resource or entity.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content: {}
      operationId: getNodeCourseByEntityFieldImage
      x-operation-id-source: derived
  /node/course/{entity}/relationships/field_image:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: field_image (File)'
      description: Relationship endpoint for the file--file resource type through the field_image relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsFieldImage
      x-operation-id-source: derived
  /node/course/{entity}/field_materials:
    get:
      tags:
      - Content - Course
      summary: 'Related: field_materials (Paragraph - Title)'
      description: Related endpoint for the paragraph--title resource type through the field_materials relationship. The related endpoint contains a resource object with the data for a particular related resource or entity.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content: {}
      operationId: getNodeCourseByEntityFieldMaterials
      x-operation-id-source: derived
  /node/course/{entity}/relationships/field_materials:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: field_materials (Paragraph - Title)'
      description: Relationship endpoint for the paragraph--title resource type through the field_materials relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    uniqueItems: true
                    type: array
                    description: An array of objects each containing \"type\" and \"id\" members for to-many relationships.
                    items:
                      type: object
                      additionalProperties: false
                      description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsFieldMaterials
      x-operation-id-source: derived
  /node/course/{entity}:
    get:
      tags:
      - Content - Course
      summary: View (Content - Course)
      description: Individual endpoint for the node--course resource type. The individual endpoint contains a resource object with the data for a particular resource or entity.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/node--course'
      operationId: getNodeCourseByEntity
      x-operation-id-source: derived
  /node/course/{entity}/relationships/node_type:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: node_type (Content type)'
      description: Relationship endpoint for the node_type--node_type resource type through the node_type relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsNodeType
      x-operation-id-source: derived
  /node/course/{entity}/relationships/revision_uid:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: revision_uid (User)'
      description: Relationship endpoint for the user--user resource type through the revision_uid relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsRevisionUid
      x-operation-id-source: derived
  /node/course/{entity}/relationships/uid:
    get:
      tags:
      - Content - Course
      summary: 'Relationship: uid (User)'
      description: Relationship endpoint for the user--user resource type through the uid relationship. The relationship endpoint contains a resource identifier object with the data for a particular relationship.
      parameters:
      - name: resourceVersion
        in: query
        description: The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
        schema:
          type: string
      - name: entity
        in: path
        description: The uuid of the node course
        required: true
        schema: {}
      responses:
        '200':
          description: successful operation
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    description: The "type" and "id" to non-empty members.
      operationId: getNodeCourseByEntityRelationshipsUid
      x-operation-id-source: derived
components:
  schemas:
    node--course:
      title: node:course Schema
      required:
      - data
      type: object
      properties:
        data:
          type: object
          additionalProperties: false
          description: \"Resource objects\" appear in a JSON:API document to represent resources.
        meta:
          type: object
          additionalProperties: true
          description: Non-standard meta-information that can not be represented as an attribute or relationship.
        links:
          type: object
          additionalProperties:
            required:
            - href
            type: object
            properties:
              href:
                type: string
                description: 'A string containing the link''s URL . '
                format: uri - reference
              meta:
                type: object
                additionalProperties: true
                description: Non-standard meta-information that can not be represented as an attribute or relationship.
            description: 'A link **MUST** be represented as either: a string containing the link''s URL or a link object . '
        jsonapi:
          type: object
          additionalProperties: false
          description: An object describing the server's implementation
      additionalProperties: true
      description: Contains information related to a course, such as introduction text and an image.
  securitySchemes:
    oauth2:
      type: oauth2
      description: For more information see https://developers.getbase.com/docs/rest/articles/oauth2/requests
      flows: {}
    csrf_token:
      type: apiKey
      name: X-CSRF-Token
      in: header
      x-tokenUrl: https://cms.studies.helsinki.fi/user/token
x-original-swagger-version: '2.0'