Skip to content

Document title parameter and improve error handling for /new API#1058

Merged
jelmer merged 1 commit intoisso-comments:masterfrom
pkvach:fix/new-api-title-parameter
Jul 18, 2025
Merged

Document title parameter and improve error handling for /new API#1058
jelmer merged 1 commit intoisso-comments:masterfrom
pkvach:fix/new-api-title-parameter

Conversation

@pkvach
Copy link
Contributor

@pkvach pkvach commented Jul 17, 2025

Checklist

  • All new and existing tests are passing
  • (If docs changes needed:) I have updated the documentation accordingly.
  • I have added an entry to CHANGES.rst because this is a user-facing change or an important bugfix
  • I have written proper commit message(s)

What changes does this Pull Request introduce?

  • Update API documentation to include optional title parameter for new comments.
  • Change error handling: when creating the first comment for a new thread, return a BadRequest if the URI is inaccessible and no title is provided, prompting the user to supply a title.

Why is this necessary?

Fixes #1055

@pkvach pkvach force-pushed the fix/new-api-title-parameter branch from b7421d4 to df75a3b Compare July 17, 2025 06:36
Copy link
Member

@jelmer jelmer left a comment

Choose a reason for hiding this comment

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

Changes look good to me, but let's fix the CI before we land anything new.

@pkvach
Copy link
Contributor Author

pkvach commented Jul 17, 2025

Changes look good to me, but let's fix the CI before we land anything new.

Thanks for the quick review!
I can look into the CI issue in a separate PR.

@jelmer
Copy link
Member

jelmer commented Jul 17, 2025

Changes look good to me, but let's fix the CI before we land anything new.

Thanks for the quick review!
I can look into the CI issue in a separate PR.

That would be great - thanks!

@pkvach
Copy link
Contributor Author

pkvach commented Jul 17, 2025

I've created a pull request related to the CI here: #1059

@jelmer
Copy link
Member

jelmer commented Jul 17, 2025

Can you rebase this, and then we can land it?

…for /new API

- Update API documentation to include optional title parameter for new comments.
- Change error handling: when creating the first comment for a new thread, return a BadRequest if the URI is inaccessible and no title is provided, prompting the user to supply a title.

Fixes isso-comments#1055
@pkvach pkvach force-pushed the fix/new-api-title-parameter branch from df75a3b to ca7b15e Compare July 18, 2025 05:13
@pkvach
Copy link
Contributor Author

pkvach commented Jul 18, 2025

Can you rebase this, and then we can land it?

Thanks! I've just rebased the branch — ready for another look.

@jelmer jelmer merged commit d9fadd2 into isso-comments:master Jul 18, 2025
18 checks passed
@pkvach pkvach deleted the fix/new-api-title-parameter branch July 18, 2025 08:03
@ix5 ix5 added server (Python) server code docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use labels Aug 18, 2025
@ix5 ix5 added this to the 0.13.1 milestone Aug 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use server (Python) server code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug/Feature] /new API: Missing required title parameter on first comment creation returns 404, not documented

3 participants