>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3218285. --> Reported by: [grasmash](https://www.drupal.org/user/455714) >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>The Project Browser Initiative requires a web API provided by Drupal.org. Many, but not all, of the requirements are already met by existing APIs. The purpose of this issue is to define "Must/Should/Could have" requirements.</p> <div class="note-warning"> <p>Per <a href="https://www.drupal.org/u/hestenet">@hestenet</a> - Drupal.org's RestWS API is effectively deprecated as we approach the end of life of Drupal 7, and must begin migrating to Drupal 9. As such, this issue should define a *complete* specification for the JSON implementation of what's needed by the project_browser (rather than just what needs to be <em>added</em> so we don't lose any of the existing data in the new implementation).</p> </div> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>Through the process of building a Proof of Concept for this initiative, I've identified the following API needs. For each requirement, I've used the following annotations:</p> <ul> <li>&#10003; requirement is already met in existing web API</li> <li>~ requirements are mostly met, but not ideal</li> </ul> <h4>Must have</h4> <pre>- API endpoint that lists all Drupal.org projects<br>&nbsp;&nbsp;&nbsp; - Filters:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Core compatibility, E.g.,`?core_compatibility=9.1.x`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Type, E.g., `type[]=project_module&amp;type[]=project_theme`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Scope (utility/framework/tool/simpleFunctionality/config/feature)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ ] Note ability to specify multiple values for a given filter<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Status, E.g., `?status=1`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Project release type, E.g., `?field_project_type=full`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Project has releases, E.g., `field_project_has_releases=1`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; Maintenance status, E.g., `taxonomy_vocabulary_44=13028`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; But we need this filter like `taxonomy_vocabulary_44[]=13028&amp;taxonomy_vocabulary_44[]=19370`.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; Development status, E.g., `taxonomy_vocabulary_46=13030`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; But we need this filter like `taxonomy_vocabulary_46[]=13030&amp;taxonomy_vocabulary_46[]=16538`.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Security coverage, E.g., `field_security_advisory_coverage=covered`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Project has issue queue, E.g., `field_project_has_issue_queue=1`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Keywords, E.g.,`keywords=admin`<br>&nbsp;&nbsp;&nbsp; - Sort fields:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Star count, E.g., `?sort[sort-star_count][direction]=DESC`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Project Usage, E.g., `?sort[sort-project_usage][direction]=DESC`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ability to specify multiple sort fields in above examples<br>&nbsp;&nbsp;&nbsp; - Top level response properties:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Previous - link to previous page of results<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Next - link to next page of results<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; Last - link to last page of results<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Count - total number of results in set<br>&nbsp;&nbsp;&nbsp; - Properties for each project object:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; author<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; body<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; created<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; changed<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; field_project_images<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ideally this would include the actual image src rather than a file reference. This would drastically reduce the number of requests.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; status<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; type<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; scope<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; url<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; project_usage<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; field_security_advisory_coverage<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; field_project_machine_name<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; field_support_organizations<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ideally this would include the organization name, description, and url rather than a field collection item reference. This would drastically reduce the number of requests.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [&#10003;]&nbsp; flag_project_star_user<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; module categories E.g., taxonomy_vocabulary_3<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ideally this would include the term name and description rather than only a term reference. This would drastically reduce the number of requests.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; maintenance status E.g., taxonomy_vocabulary_44<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ideally this would include the term name and description rather than only a term reference. This would drastically reduce the number of requests.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [~]&nbsp; development status E.g., taxonomy_vocabulary_46<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - [ ]&nbsp; Ideally this would include the term name and description rather than only a term reference. This would drastically reduce the number of requests.</pre><h3 id="summary-remaining-tasks">Remaining tasks</h3> <ul> <li>Review with rest of Project Browser Initiative team</li> <li>Determine path forward. Options include: <ul> <li>Modify current API</li> <li>Create "API Contract" with mock requests and responses</li> <li>Start building new API</li> </ul> </li> </ul> <h3 id="summary-ui-changes">User interface changes</h3> <p>None.</p> <h3 id="summary-api-changes">API changes</h3> <p>Web API changes as listed.</p> <h3 id="summary-data-model-changes">Data model changes</h3> <p>Data model changes as listed.</p> <h3 id="summary-release-notes">Release notes snippet</h3> > Related issue: [Issue #3224709](https://www.drupal.org/node/3224709) > Related issue: [Issue #3240319](https://www.drupal.org/node/3240319)