decidim-api 0.27.10 → 0.28.0.rc4

data/app/packs/entrypoints/decidim_api_graphiql.js

@@ -1,6 +1,9 @@
 /* eslint-disable require-jsdoc */
 
 import "entrypoints/decidim_api_graphiql.scss";
+// Styles from node_modules/graphiql/graphiql.css
+// It needs to be done in JS because postcss-import does not find files in node_modules/
+import "graphiql/graphiql.css"
 
 import React from "react";
 import ReactDOM from "react-dom";

data/app/packs/entrypoints/decidim_api_graphiql.scss

@@ -1,10 +1,8 @@
 html,
 body,
-#graphiql-container{
+#graphiql-container {
   height: 100%;
   margin: 0;
   overflow: hidden;
   width: 100%;
 }
-
-@import "graphiql/graphiql.css";

data/app/views/decidim/api/documentation/graphql_docs_template.html.erb

@@ -1,5 +1,5 @@
 <div class="content"><%= contents %></div>
-<div id="sidebar"><%= include.("sidebar.html") %></div>
+<div id="sidebar"><%= include.call("sidebar.html") %></div>
 
 <!-- mobile only -->
 <div id="mobile-header">

data/docs/usage.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable-file link-fragments -->
+
 ## About the GraphQL API
 
 [Decidim](https://github.com/decidim/decidim) comes with an API that follows the [GraphQL](https://graphql.org/) specification. It has a comprehensive coverage of all the public content that can be found on the website.
@@ -14,11 +16,9 @@ Typically (although some particular installations may change that) you will find
 
 The GraphQL format is a JSON formatted text that is specified in a query. Response is a JSON object as well. For details about specification check the official [GraphQL site](https://graphql.org/learn/).
 
-Exercise caution when utilizing the output of this API, as it may include HTML that has not been escaped. Take particular care in handling this data, specially if you intend to render it on a webpage.
-
 For instance, you can check the version of a Decidim installation by using `curl` in the terminal:
 
-```
+```bash
 curl -sSH "Content-Type: application/json" \
 -d '{"query": "{ decidim { version } }"}' \
 https://www.decidim.barcelona/api/
@@ -28,7 +28,7 @@ Note that `Content-Type` needs to be specified.
 
 The query can also be used in GraphiQL, in that case you can skip the `"query"` text:
 
-```
+```graphql
 {
   decidim {
     version
@@ -68,7 +68,7 @@ Each "Type" is just a pre-defined structure with fields, or just an Scalar (Stri
 
 For instance, to obtain *all the participatory processes in a Decidim installation published since January 2018* and order them by published date, we could execute the next query:
 
-```
+```graphql
 {
   participatoryProcesses(filter: {publishedSince: "2018-01-01"}, order: {publishedAt: "asc"}) {
     slug
@@ -81,7 +81,7 @@ For instance, to obtain *all the participatory processes in a Decidim installati
 
 Response should look like:
 
-```
+```json
 {
   "data": {
     "participatoryProcesses": [
@@ -108,10 +108,10 @@ In the former query, each keyword represents a type, the words `publishedSince`,
 
 The other keywords however, are objects representing certain entities:
 
-- `participatoryProcesses` is a type that represents a collection of participatory spaces. It accepts arguments (`filter` and `order`), which are other object types as well. `slug` and `title` are the fields of the participatory process we are interested in, there are "Types" too.
-- `filter` is a [ParticipatoryProcessFilter](#ParticipatoryProcessFilter)\* input type, it has several properties that allows us to refine our search. One of them is the `publishedSince` property with the initial date from which to list entries.
-- `order ` is a [ParticipatoryProcessSort](#ParticipatoryProcessSort) type, works the same way as the filter but with the goal of ordering the results.
-- `title` is a [TranslatedField](#TranslatedField) type, which allows us to deal with multi-language fields.
+* `participatoryProcesses` is a type that represents a collection of participatory spaces. It accepts arguments (`filter` and `order`), which are other object types as well. `slug` and `title` are the fields of the participatory process we are interested in, there are "Types" too.
+* `filter` is a [ParticipatoryProcessFilter](#ParticipatoryProcessFilter)\* input type, it has several properties that allows us to refine our search. One of them is the `publishedSince` property with the initial date from which to list entries.
+* `order` is a [ParticipatoryProcessSort](#ParticipatoryProcessSort) type, works the same way as the filter but with the goal of ordering the results.
+* `title` is a [TranslatedField](#TranslatedField) type, which allows us to deal with multi-language fields.
 
 Finally, note that the returned object is an array, each item of which is a representation of the object we requested.
 
@@ -119,20 +119,20 @@ Finally, note that the returned object is an array, each item of which is a repr
 >
 > There are two types of objects to filter and ordering collections in Decidim, they all work in a similar fashion. The type involved in filtering always have the suffix "Filter", for ordering it has the suffix "Sort".
 >
-> The types used to filter participatory spaces are: [ParticipatoryProcessFilter](#ParticipatoryProcessFilter), [AssemblyFilter](#AssemblyFilter), [ConsultationFilter](#ConsultationFilter) and so on.
+> The types used to filter participatory spaces are: [ParticipatoryProcessFilter](#ParticipatoryProcessFilter), [AssemblyFilter](#AssemblyFilter), and so on.
 >
 > Other collections (or connections) may have their own filters (i.e. [ComponentFilter](#ComponentFilter)).
 >
 > Each filter has its own properties, you should check any object in particular for details. The way they work with multi-languages fields, however, is the same:
 >
-> Let's say we have some searchable object with a multi-language field called *title*, and we have a filter that allows us to search through this field. How should it work? Should we look up content for every language in the field? or should we stick to a specific language?
+> We can say we have some searchable object with a multi-language field called *title*, and we have a filter that allows us to search through this field. How should it work? Should we look up content for every language in the field? or should we stick to a specific language?
 >
-> In our case, we've decided to search only one particular language of a multi-language field but we let you choose which language to search.
+> In our case, we have decided to search only one particular language of a multi-language field but we let you choose which language to search.
 > If no language is specified, the configured as default in the organization will be used. The keyword to specify the language is `locale`, and it should be provided in the 2 letters ISO 639-1 format (en = English, es = Spanish, ...).
 >
 > Example (this is not a real Decidim query):
 >
-> ```
+> ```graphql
 >  some_collection(filter: { locale: "en", title: "ideas"}) {
 >    id
 >  }
@@ -144,7 +144,7 @@ Finally, note that the returned object is an array, each item of which is a repr
 >
 > Example of ordering alphabetically by the title content in French language:
 >
-> ```
+> ```graphql
 > some_collection(order: { locale: "en", title: "asc"}) {
 >   id
 > }
@@ -156,13 +156,13 @@ Finally, note that the returned object is an array, each item of which is a repr
 
 Decidim has 2 main types of objects through which content is provided. These are Participatory Spaces and Components.
 
-A participatory space is the first level, currently there are 5 officially supported: *Participatory Processes*, *Assemblies*, *Consultations*, *Conferences* and *Initiatives*. For each participatory process there will correspond a collection type and a "single item" type.
+A participatory space is the first level, currently there are 5 officially supported: *Participatory Processes*, *Assemblies*, *Conferences* and *Initiatives*. For each participatory process there will correspond a collection type and a "single item" type.
 
-The previous example uses the collection type for participatory processes. You can try `assemblies`, `conferences`, `consultations` or `initiatives` for the others. Note that each collection can implement their own filter and order types with different properties.
+The previous example uses the collection type for participatory processes. You can try `assemblies`, `conferences`, or `initiatives` for the others. Note that each collection can implement their own filter and order types with different properties.
 
 As an example for a single item query, you can run:
 
-```
+```graphql
 {
   participatoryProcess(slug: "consectetur-at") {
     slug
@@ -175,7 +175,7 @@ As an example for a single item query, you can run:
 
 And the response will be:
 
-```
+```json
 {
   "data": {
     "participatoryProcess": {
@@ -188,7 +188,7 @@ And the response will be:
 }
 ```
 
-#### What's different?
+#### What is different?
 
 First, note that we are querying, in singular, the type `participatoryProcess`, with a different parameter, `slug`\*, (a String). We can use the `id` instead if we know it.
 
@@ -208,7 +208,7 @@ Every participatory space may (and should) have some components. There are 9 off
 
 If you know the `id`\* of a specific component you can obtain it by querying it directly:
 
-```
+```graphql
 {
   component(id:2) {
     id
@@ -226,7 +226,7 @@ If you know the `id`\* of a specific component you can obtain it by querying it
 
 Response:
 
-```
+```json
 {
   "data": {
     "component": {
@@ -252,13 +252,13 @@ The process is analogue as what has been explained in the case of searching for
 >
 > In this case, 3257.
 
-#### What about component's collections?
+##### What about component's collections?
 
 Glad you asked, component's collections cannot be retrieved directly, the are available *in the context* of a participatory space.
 
 For instance, we can query all the components in an particular Assembly as follows:
 
-```
+```graphql
 {
   assembly(id: 3) {
     components {
@@ -274,7 +274,7 @@ For instance, we can query all the components in an particular Assembly as follo
 
 The response will be similar to:
 
-```
+```json
 {
   "data": {
     "assembly": {
@@ -315,7 +315,7 @@ The response will be similar to:
 
 We can also apply some filters by using the [ComponentFilter](#ComponentFilter) type. In the next query we would like to *find all the components with geolocation enabled in the assembly with id=2*:
 
-```
+```graphql
 {
   assembly(id: 2) {
     components(filter: {withGeolocationEnabled: true}) {
@@ -331,7 +331,7 @@ We can also apply some filters by using the [ComponentFilter](#ComponentFilter)
 
 The response:
 
-```
+```json
 {
   "data": {
     "assembly": {
@@ -359,14 +359,13 @@ For instance, components in a participatory space are polymorphic, while the con
 
 Another example are the case of linked resources, these are properties that may link objects of different nature between components or participatory spaces.
 
-In a very simplified way (to know more please refer to the official guide), GraphQL polymorphism is handled through the operator `... on`. You'll know when a field is polymorphic because the property `__typename`, which tells you the type of that particular object, will change accordingly.
+In a very simplified way (to know more please refer to the official guide), GraphQL polymorphism is handled through the operator `... on`. You will know when a field is polymorphic because the property `__typename`, which tells you the type of that particular object, will change accordingly.
 
-In the previous examples we've queried for this property:
+In the previous examples we have queried for this property:
 
 Response fragment:
 
-```
-...
+```json
       "components": [
         {
           "id": "38",
@@ -375,12 +374,11 @@ Response fragment:
           },
           "__typename": "Meetings"
         }
-...
 ```
 
 So, if we want to access the rest of the properties in a polymorphic object, we should do it through the `... on` operator as follows:
 
-```
+```graphql
 {
   assembly(id: 2) {
     components {
@@ -395,7 +393,7 @@ So, if we want to access the rest of the properties in a polymorphic object, we
 
 Consider this query:
 
-```
+```graphql
 {
   assembly(id: 3) {
     components(filter: {type: "Proposals"}) {
@@ -422,7 +420,7 @@ Consider this query:
 
 The response:
 
-```
+```json
 {
   "data": {
     "assembly": {
@@ -493,9 +491,9 @@ The response:
 }
 ```
 
-#### What's going on?
+#### What is going on?
 
-Until the `... on Proposals` line, there's nothing new. We are requesting the *Assembly* participatory space identified by the `id=3`, then listing all its components with the type "Proposals". All the components share the *id* and *name* properties, so we can just add them at the query.
+Until the `... on Proposals` line, there is nothing new. We are requesting the *Assembly* participatory space identified by the `id=3`, then listing all its components with the type "Proposals". All the components share the *id* and *name* properties, so we can just add them at the query.
 
 After that, we want content specific from the *Proposals* type. In order to do that we must tell the server that the content we will request shall only be executed if the types matches *Proposals*. We do that by wrapping the rest of the query in the `... on Proposals` clause.
 
@@ -503,14 +501,14 @@ The next line is just a property of the type *Proposals* which is a type of coll
 
 Typically, a connection is used to paginate long results, for this purpose the results are not directly available but encapsulated inside the list *edges* in several *node* results. Also there are more arguments available in order to navigate between pages. This are the arguments:
 
-- `first`: Returns the first *n* elements from the list
-- `after`: Returns the elements in the list that come after the specified *cursor*
-- `last`: Returns the last *n* elements from the list
-- `before`: Returns the elements in the list that come before the specified *cursor*
+* `first`: Returns the first *n* elements from the list
+* `after`: Returns the elements in the list that come after the specified *cursor*
+* `last`: Returns the last *n* elements from the list
+* `before`: Returns the elements in the list that come before the specified *cursor*
 
 Example:
 
-```
+```graphql
 {
   assembly(id: 3) {
     components(filter: {type: "Proposals"}) {
@@ -543,7 +541,7 @@ Example:
 
 Being the response:
 
-```
+```json
 {
   "data": {
     "assembly": {
@@ -594,5 +592,3 @@ As you can see, a part from the *edges* list, you can access to the object *page
 For more info on how connections work, you can check the official guide:
 
 https://graphql.org/learn/pagination/
-
-

data/lib/decidim/api/engine.rb

@@ -23,7 +23,7 @@ module Decidim
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::Api
 
-      initializer "decidim-api.middleware" do |app|
+      initializer "decidim_api.middleware" do |app|
         app.config.middleware.insert_before 0, Rack::Cors do
           allow do
             origins "*"
@@ -32,12 +32,12 @@ module Decidim
         end
       end
 
-      initializer "decidim-api.graphiql" do
+      initializer "decidim_api.graphiql" do
         Decidim::GraphiQL::Rails.config.tap do |config|
           config.query_params = true
-          config.initial_query = ERB::Util.html_escape(
-            File.read(File.join(__dir__, "graphiql-initial-query.txt"))
-          )
+          config.initial_query = File.read(
+            File.join(__dir__, "graphiql-initial-query.txt")
+          ).html_safe
         end
       end
 

data/lib/decidim/api/test/type_context.rb

@@ -23,12 +23,12 @@ shared_context "with a graphql class type" do
   def execute_query(query, variables)
     result = schema.execute(
       query,
-      root_value: root_value,
+      root_value:,
       context: {
-        current_organization: current_organization,
-        current_user: current_user
+        current_organization:,
+        current_user:
       },
-      variables: variables
+      variables:
     )
 
     raise StandardError, result["errors"].map { |e| e["message"] }.join(", ") if result["errors"]

data/lib/decidim/api/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-api version.
   module Api
     def self.version
-      "0.27.10"
+      "0.28.0.rc4"
     end
   end
 end

data/lib/tasks/decidim_api_docs.rake

@@ -9,7 +9,7 @@ namespace :decidim_api do
 
     GraphQLDocs.build(
       schema: Decidim::Api::Schema,
-      output_dir: output_dir,
+      output_dir:,
       base_url: "/api/docs",
       landing_pages: {
         index: File.expand_path("../../docs/usage.md", __dir__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-api
 version: !ruby/object:Gem::Version
-  version: 0.27.10
+  version: 0.28.0.rc4
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,56 +10,56 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: decidim-core
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.23.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.23.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.9
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: graphql-docs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: rack-cors
   requirement: !ruby/object:Gem::Requirement
@@ -80,42 +80,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0.rc4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0.rc4
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
 - !ruby/object:Gem::Dependency
   name: decidim-participatory_processes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.10
+        version: 0.28.0.rc4
 description: API engine for decidim
 email:
 - josepjaume@gmail.com
@@ -141,7 +155,6 @@ files:
 - app/views/layouts/decidim/api/documentation.html.erb
 - config/assets.rb
 - config/routes.rb
-- decidim-api.gemspec
 - docs/usage.md
 - lib/decidim/api.rb
 - lib/decidim/api/engine.rb
@@ -166,26 +179,31 @@ files:
 - lib/decidim/api/types/base_union.rb
 - lib/decidim/api/version.rb
 - lib/tasks/decidim_api_docs.rake
-homepage: https://github.com/decidim/decidim
+homepage: https://decidim.org
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/decidim/decidim/issues
+  documentation_uri: https://docs.decidim.org/
+  funding_uri: https://opencollective.com/decidim
+  homepage_uri: https://decidim.org
+  source_code_uri: https://github.com/decidim/decidim
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Decidim API module

data/decidim-api.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.push File.expand_path("lib", __dir__)
-
-# Maintain your gem's version:
-require "decidim/api/version"
-
-# Describe your gem and declare its dependencies:
-Gem::Specification.new do |s|
-  s.version = Decidim::Api.version
-  s.authors = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
-  s.email = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]
-  s.license = "AGPL-3.0"
-  s.homepage = "https://github.com/decidim/decidim"
-  s.required_ruby_version = "~> 3.0.0"
-
-  s.name = "decidim-api"
-  s.summary = "Decidim API module"
-  s.description = "API engine for decidim"
-
-  s.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").select do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w(app/ config/ docs/ lib/ Rakefile README.md))
-    end
-  end
-
-  s.add_dependency "decidim-core", Decidim::Api.version
-  s.add_dependency "graphql", "~> 1.12", "< 1.13"
-  s.add_dependency "graphql-docs", "~> 2.1.0"
-  s.add_dependency "rack-cors", "~> 1.0"
-
-  s.add_development_dependency "decidim-comments", Decidim::Api.version
-  s.add_development_dependency "decidim-dev", Decidim::Api.version
-  s.add_development_dependency "decidim-participatory_processes", Decidim::Api.version
-end