openapi: 3.0.3
info:
  title: D2L Brightspace Valence Learning Framework Assignments News API
  description: 'The Valence Learning Framework API is the public REST API for the D2L Brightspace learning management system (LMS). It is served from an institution''s own Brightspace host under https://{host}/d2l/api/ and is divided into two product components: "lp" (Learning Platform - users, roles, enrollments, org units, and Data Hub) and "le" (Learning Environment - content, grades, assignments/dropbox, quizzes, discussions, calendar, news, and learning outcomes). Each component is independently versioned; the version segment in a route (for example lp/1.53 or le/1.92) varies by installed Brightspace product version, and clients should confirm supported versions via GET /d2l/api/versions/ before hard-coding a value. Requests are authenticated with OAuth 2 bearer tokens issued by the D2L auth service (https://auth.brightspace.com/core/connect/token) using the authorization code grant; the older ID-Key (app-id/user-id signed URL) scheme is deprecated. Scopes take the form group:resource:action, for example users:userdata:read. The version values baked into the paths below are illustrative of a recent release and must be adjusted to the target instance. "Valence" is the historical name of the API framework; "D2L" is the vendor and "Brightspace" the product.'
  version: '1.0'
  contact:
    name: D2L Developer Platform
    url: https://docs.valence.desire2learn.com
  license:
    name: D2L Developer Terms
    url: https://www.d2l.com/legal/
servers:
- url: https://{host}/d2l/api
  description: An institution's Brightspace instance
  variables:
    host:
      default: myschool.brightspace.com
      description: Your Brightspace instance hostname.
security:
- oauth2: []
tags:
- name: News
  description: News (announcement) items.
paths:
  /le/1.92/{orgUnitId}/news/:
    get:
      operationId: listNewsItems
      tags:
      - News
      summary: List news items
      description: Retrieves the news (announcement) items in a course offering.
      parameters:
      - $ref: '#/components/parameters/OrgUnitId'
      responses:
        '200':
          description: A list of news items.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NewsItem'
    post:
      operationId: createNewsItem
      tags:
      - News
      summary: Create a news item
      description: Creates a new news (announcement) item in a course offering.
      parameters:
      - $ref: '#/components/parameters/OrgUnitId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewsItem'
      responses:
        '200':
          description: The created news item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewsItem'
  /le/1.92/{orgUnitId}/news/{newsItemId}:
    parameters:
    - $ref: '#/components/parameters/OrgUnitId'
    - name: newsItemId
      in: path
      required: true
      schema:
        type: integer
    get:
      operationId: getNewsItem
      tags:
      - News
      summary: Get a news item
      description: Retrieves a single news item by its identifier.
      responses:
        '200':
          description: The news item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewsItem'
    delete:
      operationId: deleteNewsItem
      tags:
      - News
      summary: Delete a news item
      description: Deletes a single news item.
      responses:
        '200':
          description: The news item was deleted.
components:
  parameters:
    OrgUnitId:
      name: orgUnitId
      in: path
      required: true
      schema:
        type: integer
        format: int64
  schemas:
    NewsItem:
      type: object
      properties:
        Id:
          type: integer
          format: int64
        Title:
          type: string
        Body:
          type: object
          properties:
            Text:
              type: string
            Html:
              type: string
        IsPublished:
          type: boolean
        StartDate:
          type: string
          format: date-time
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2 authorization code grant. Tokens are issued by the D2L auth service. Scopes take the form group:resource:action (for example users:userdata:read).
      flows:
        authorizationCode:
          authorizationUrl: https://auth.brightspace.com/oauth2/auth
          tokenUrl: https://auth.brightspace.com/core/connect/token
          scopes:
            core:*:*: Full access consistent with the registered application
            users:userdata:read: Read user data
            enrollment:orgunit:read: Read enrollments
            datahub:dataexports:read: Read Data Hub exports