Skip to content

Remove usable example data from API registration documentation #1233

Open

Description

Problem

The API registration documentation includes example cURL requests that people actually try on occasion. This encourages API users to reuse the example registration data rather than filling in more useful information like a descriptive application name. Ex: https://openverse.sentry.io/share/issue/8780a79fd7a04eaab42f1f53fe528583/ who used "My amazing project 20230416-072251" which is surprisingly uniform!

Description

Remove the existing documentation and replace it with a simple form that makes the registration request from the browser. This form could be implemented on the frontend or inside the Django docs.

Alternatives

Remove the example cURL request and just list the required fields, without example data and without a working curl request example.

Additional context

A separate issue exists to address the unhandled database error caused by duplicate keys in the example Sentry link above.

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

Metadata

Assignees

No one assigned

    Labels

    ✨ goal: improvementImprovement to an existing user-facing feature📄 aspect: textConcerns the textual material in the repository🟩 priority: lowLow priority and doesn't need to be rushed🧱 stack: documentationRelated to Sphinx documentation

    Type

    No type

    Projects

    • Status

      📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions