Skip to content

Improve OpenAPI response schemas by marking guaranteed properties as required #583

Description

@CatLover01

The OpenAPI specification appears to be missing required declarations for many response properties.

For example, properties that appear to be consistently returned by the API are not included in the schema's required arrays. This causes OpenAPI-generated clients and TypeScript types to treat these properties as optional, even though they appear to be guaranteed in actual API responses.

Could the response schemas be reviewed and have properties marked as required where they are guaranteed to be present?

This would make the OpenAPI specification more accurately reflect the actual API contract and would improve the quality of generated clients.

One related question: OAuth is currently represented through the securitySchemes definitions, with the authorization and token URLs hosted at https://secure.soundcloud.com rather than the API host. Is the intention that the OAuth endpoints themselves are intentionally excluded from the OpenAPI paths, since they belong to the separate secure.soundcloud.com service?

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions