Skip to content

Update decidim-blogs GraphQL API#14327

Merged
andreslucena merged 4 commits intofeature/api-improvementfrom
feature/api/blogs
Mar 19, 2025
Merged

Update decidim-blogs GraphQL API#14327
andreslucena merged 4 commits intofeature/api-improvementfrom
feature/api/blogs

Conversation

@alecslupu
Copy link
Copy Markdown
Contributor

@alecslupu alecslupu commented Mar 17, 2025 •
edited
Loading

🎩 What? Why?

This PR we review the blogs module, to which :

  • Add new interfaces
  • Refactor specs to use new interface tests
  • Improve the specs on types
  • Add missing field

📌 Related Issues

Link your PR to an issue

Testing

Describe the best way to test or validate your PR.

📷 Screenshots

Please add screenshots of the changes you are proposing
image

♥️ Thank you!

@alecslupu alecslupu added the graphql-api Affects the GraphQL API label Mar 17, 2025
@alecslupu alecslupu marked this pull request as draft March 17, 2025 17:56
@alecslupu alecslupu changed the title Update of the API GraphQL Update decidim-blogs GraphQL API Mar 17, 2025
@alecslupu alecslupu added the project: 2024-api Barcelona Supercomputing Center contract label Mar 17, 2025
@alecslupu alecslupu mentioned this pull request Mar 17, 2025
Closed
26 tasks
@alecslupu alecslupu marked this pull request as ready for review March 18, 2025 10:33
andreslucena
andreslucena reviewed Mar 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@andreslucena andreslucena left a comment

Choose a reason for hiding this comment

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

Comparing the information from http://localhost:3000/api/docs/object/post/ to decidim-blogs/lib/decidim/blogs/post_serializer.rb, the only missing relevant information is the url. I think it can be useful for researchers and for debugging (without having to manually recreate the URL with the process type/process-id/components/component-id/idand so on.

What do you think? Should we start adding that field?

@alecslupu
Copy link
Copy Markdown
Contributor Author

alecslupu commented Mar 18, 2025

Comparing the information from http://localhost:3000/api/docs/object/post to decidim-blogs/lib/decidim/blogs/post_serializer.rb, the only missing relevant information is the url. I think it can be useful for researchers and for debugging (without having to manually recreate the URL with the process type/process-id/components/component-id/idand so on.

What do you think? Should we start adding that field?

I will add the URL as well, but this should be a thing for all the resources. Good catch (i went only for DB / includes changes )

@alecslupu alecslupu requested a review from andreslucena March 18, 2025 16:04
@alecslupu
Copy link
Copy Markdown
Contributor Author

alecslupu commented Mar 18, 2025

@andreslucena this is ready for another round

andreslucena
andreslucena approved these changes Mar 19, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@andreslucena andreslucena left a comment

Choose a reason for hiding this comment

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

approved-pr-pull-request

@andreslucena andreslucena merged commit 09d38dd into feature/api-improvement Mar 19, 2025
43 checks passed
@andreslucena andreslucena deleted the feature/api/blogs branch March 19, 2025 08:29
andreslucena added a commit that referenced this pull request Mar 28, 2025
@alecslupu @andreslucena
Update of the API GraphQL (#13986)
ecb8dbe 
* Update of the API GraphQL

* Refactor api

* Running linters

* Update decidim-core/lib/decidim/api/interfaces/attachable_collection_interface.rb

Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>

* Update `decidim-blogs` GraphQL API (#14327)

* Update `decidim-blogs` GraphQL API

* Add url to list

* Update `decidim-debates` GraphQL API (#14331)

* Update `decidim-debates` GraphQL API

* Refactor specs

* Add more fields

* Update `decidim-budgets` GraphQL API (#14328)

* Update `decidim-budgets` GraphQL API

* Add more fields

* Apply suggestions from code review

* Add budget integration specs

* Update decidim-budgets/spec/types/project_type_spec.rb

Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>

* Sort alphabetically

---------

Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>

* Update `decidim-accountability` GraphQL API (#14326)

* Change Api for Accountability module

* Fix spec

* Add url field

* Add proposal urls field

* Add integration_spec for results

* Sort alphabetically

* More

* More sorting

* Update `decidim-conferences` GraphQL API (#14330)

* Update `decidim-conferences` GraphQL API

* Running linters

* Add more fields

* Fix usage

* Add url spec

* Implement conference schema spec

* Sort alphabetically

* Add resource fields to integration schema specs (#14358)

* Add post fields to integration_schema spec

* Add debate fields to integration_schema spec

* Sort alphabetically

* Sort alphabetically

* Update `decidim-assemblies` GraphQL API (#14329)

* Update `decidim-assemblies` GraphQL API

* Fixing specs

* Add url to assemblies

* Fix spec

* Add integration specs

* Sort alphabetically

---------

Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andreslucena andreslucena andreslucena approved these changes

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees

@andreslucena andreslucena

Labels

graphql-api Affects the GraphQL API module: blogs project: 2024-api Barcelona Supercomputing Center contract

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alecslupu @andreslucena