Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update documentation with facet tags

Open
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
40/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
drupal, graphql, php

Research direction

Start by finding the existing documentation for the GraphQL Search API and the condition_group query syntax. Add the facet-exclusion explanation and the provided tagged-condition example, then verify the documentation clearly explains that conditions tagged for a facet do not alter that facet's counts.

Written by the indexing model from the issue text.

Description

documentation

We can use tags to exclude certain conditions from being counted by facets.

The idea was to introduce the concept of facet exclusion. That is, to exclude facets from being altered by conditions of that same facet in the main query.

For example:

  searchAPISearch(index_id: "anabranch_connect_index", condition_group:{
    conjunction:AND,
    groups: [
        {
          conjunction: OR,
          tags:["facet:study_fields"],
          conditions: [
            {operator: "=", name: "study_fields", value: "Finance"},
          ]
        },
        {
          conjunction: OR,
          tags:["facet:article_type"],
          conditions: [
            {operator: "=", name: "article_type", value: "Advice"},
          ]
        },
      ]
    
  },

Need to update the docs with this.

Dominant language
PHP
Stars
10
Forks
24
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from drupal-graphql/graphql-search-api

All issues in drupal-graphql/graphql-search-api

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.