Skip to content

Clarify API key registration fields - #5585

Merged
obenland merged 1 commit into
WordPress:mainfrom
ekamran:sftq/clarify-api-key-registration-fields
Aug 26, 2026
Merged

obenland merged 1 commit into
WordPress:mainfrom
ekamran:sftq/clarify-api-key-registration-fields

Conversation

@ekamran

@ekamran ekamran commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Clarifies that API key registration names must be unique across registered Openverse API applications
  • Adds clearer schema help text for registration fields
  • Fixes minor grammar in the registration endpoint documentation

Fixes #1803

@ekamran
ekamran requested a review from a team as a code owner June 3, 2026 07:10
@ekamran
ekamran requested review from dhruvkb and obulat and removed request for a team June 3, 2026 07:10
@openverse-bot openverse-bot added 🧱 stack: api Related to the Django API 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository labels Jun 3, 2026
@openverse-bot openverse-bot moved this to 👀 Needs Review in Openverse PRs Jun 3, 2026
@ekamran
ekamran requested a review from a team as a code owner August 20, 2026 06:58
@ekamran

ekamran commented Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

The red CI on this PR is unrelated to the API documentation change. I temporarily pushed the build/lint fixes from #5602 onto this branch so those parts of CI could run; the affected Docker build and lint jobs are now passing.

The remaining failures are the same pre-existing issue described in #5602: the Django check and API/ingestion-server test jobs fail during the Load Docker images step, likely from the .github/actions/load-img / @actions/artifact issue. Once #5602 lands, I'll drop the temporary infra commits from this branch so this PR returns to the original docs-only change.

@ekamran
ekamran force-pushed the sftq/clarify-api-key-registration-fields branch from 7b126f3 to 4a919ef Compare August 26, 2026 05:14
@obenland
obenland merged commit 5857f91 into WordPress:main Aug 26, 2026
48 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 Needs Review to 🤝 Merged in Openverse PRs Aug 26, 2026
@ekamran
ekamran deleted the sftq/clarify-api-key-registration-fields branch August 26, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Registration for an API key doesn't disclose constraints on fields

3 participants