Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs for user preferences #1259

Merged
merged 6 commits into from
Dec 3, 2024

Conversation

brontolosone
Copy link
Contributor

@brontolosone brontolosone commented Oct 31, 2024

Towards #1211

I've hauled it through the sphinx circus to make sure it gets rendered.

@brontolosone brontolosone requested a review from ktuite October 31, 2024 15:51
@ktuite
Copy link
Member

ktuite commented Nov 4, 2024

I feel like this shouldn't be a top level section of the Central API, but should be nested under the Accounts and Users section, probably after Users > initiating a password reset, and before the App Users subsection.

You could also mention this in the 2024.3 section of the changelog. There is already one bullet point there.

@brontolosone
Copy link
Contributor Author

I feel like this shouldn't be a top level section of the Central API, but should be nested under the Accounts and Users section [...]

I thought about that at the time but thought it'd be better to follow the URL scheme. But yeah, the rest of the documentation doesn't do that always either. Fixed in e6a236e!

You could also mention this in the 2024.3 section of the changelog

What stopped me at the time was the Changelog subscript that says "Here major and breaking changes to the API are listed by version"; I didn't consider this API addition as major. Do you feel it's major?

Copy link
Member

@ktuite ktuite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few more minor requests but you can make those changes and go ahead and merge!

Do you feel it's major?

I think so! I mean, it's a whole new set of endpoints... now that the doors of a few user preferences have been opened, folks (like the QA team) are already starting to ask for more!

Even if it's targeted at ourselves, it would be useful to note it. I can see myself glancing through the changelog to remind myself when user preferences were added to the API.

docs/api.yaml Show resolved Hide resolved
docs/api.yaml Outdated Show resolved Hide resolved
docs/api.yaml Outdated Show resolved Hide resolved
@brontolosone brontolosone merged commit 0bc6209 into getodk:master Dec 3, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants