Skip to content

Sunshine: Document the API using OpenAPI #24

Open

Description

@ReenigneArcher

Is there an existing issue for this item?

  • I have searched the existing issues

Repositories

SunshineStream/Sunshine

Languages/Skills/Technologies

Documentation, C++

Description

OpenAPI is the standard way to document APIs, let's try to move to that.

A PR has been started for this work although it is quite overwhelming as there is no auto generator for C++ (at least when using Simple-Web-Server). SunshineStream/Sunshine#3540

Estimated Effort

effort:Large

Priority

priority:Medium

Target Milestone

3-6 months

Dependencies

No response

Activity

  1. changed the title [-]Document the Sunshine API using OpenAPI[/-] [+]Sunshine: Document the API using OpenAPI[/+] on Apr 20, 2025
  2. ReenigneArcher commented on May 9, 2025

    @ReenigneArcher
    MemberAuthor

    We should probably switch to a http server framework that supports automatic OpenAPI spec generation.

    Not sure if there is any others besides oatpp that support this out of the box.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    • Status
      Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions