v2.changelogs.list

Returns a listing of update streams, builds, and changelog entries

Authentication

const { auth } = require('osu-api-extended');

await auth.login(client_id, client_secret);

Function

await v2.changelogs.list(object)

Parameters

Parameter	Type	Description
object.from	string	Minimum build version
object.to	string	Maximum build version
object.max_id	number	Maximum build ID
object.stream	string	stable40 or stable or beta40 or cuttingedge or lazer or web
object.message_formats	string[]	html or markdown

Response

export interface response {
  streams: {
    id: number;
    name: string;
    display_name: string;
    is_featured: boolean;
    latest_build: {
      created_at: string;
      display_version: number;
      id: number;
      users: number;
      version: number;
      youtube_id: string;
      update_stream: {
        id: number;
        name: string;
        display_name: string;
        is_featured: boolean;
      };
    };
    user_count: number;
  }[];
  builds: {
    created_at: string;
    display_version: number;
    id: number;
    users: number;
    version: number;
    youtube_id?: string;
    update_stream: {
      id: number;
      name: string;
      display_name: string;
      is_featured: boolean;
    };
    changelog_entries: {
      id?: string;
      repository?: string;
      github_pull_request_id?: string;
      github_url?: string;
      url?: string;
      type: string;
      category: string;
      title: string;
      major: boolean;
      created_at: string;
      github_user: {
        id: string;
        display_name: string;
        github_url: string;
        osu_username: string;
        user_id: number;
        user_url: string;
      };
      message?: string;
      message_html?: string;
    }[];
  }[];
  search: {
    stream: string;
    from: string;
    to: string;
    max_id: string;
    limit: number;
  };
}