[1.0.x] Transform API

Created on 23 April 2024, 2 months ago
Updated 23 May 2024, about 1 month ago

Transform API is meant to create a familiar path for Drupal site builders and developers to take their knowledge of entities, view modes and templates and instead use this to produce JSON instead of HTML. This enables building headless solutions while being able to use the same configuration skills that you are used to.

Project link

https://www.drupal.org/project/transform_api →

📌 Task
Status

Fixed

Component

module

Created by

🇩🇰Denmark LupusGr3y

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @LupusGr3y
  • Status changed to Active 2 months ago
  • 🇮🇳India vishal.kadam Mumbai

    Thank you for applying!

    Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.

    The important notes are the following.

    • If you have not done it yet, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
    • For the time this application is open, only your commits are allowed.
    • The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
    • We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

    To the reviewers

    Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .

    The important notes are the following.

    • It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
    • Reviewers should show the output of a CLI tool → only once per application.
    • It may be best to have the applicant fix things before further review.

    For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .

  • 🇮🇳India vishal.kadam Mumbai

    Remember to change status, when the project is ready to be reviewed. In this queue, projects are only reviewed when the status is Needs review.

  • Status changed to Needs review 2 months ago
  • 🇩🇰Denmark LupusGr3y

    There we go. Wasn't sure what the correct status was.

  • Status changed to Needs work 2 months ago
  • 🇮🇳India vishal.kadam Mumbai

    1. master is a wrong name for a branch and should be removed. Release branch names always end with the literal .x as described in Release branches → .

    2. Fix phpcs issues.

    phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml transform_api/ 
    
    FILE: transform_api/src/Plugin/Transform/Field/NumericTransformerBase.php
    -------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    -------------------------------------------------------------------------------
     70 | ERROR | The array declaration extends to column 110 (the limit is 80). The array content should be split up over multiple lines
     71 | ERROR | The array declaration extends to column 110 (the limit is 80). The array content should be split up over multiple lines
    -------------------------------------------------------------------------------
    
    FILE: transform_api/src/Transform/EntityAutocompleteEndpointTransform.php
    -------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    -------------------------------------------------------------------------------
     14 | ERROR | [x] Missing function doc comment
    -------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    -------------------------------------------------------------------------------
    
    FILE: transform_api/src/Transform/BlockTransform.php
    -------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    -------------------------------------------------------------------------------
     20 | ERROR | [x] Missing function doc comment
    -------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    -------------------------------------------------------------------------------

    3. FILE: transform_api.module

    /**
     * @file
     * Expose routes and entities transformed to JSON with an API.
     */

    The description for a .module file is Hook implementations for the [module name] module. where [module name] is the module name given in the .info.yml file.

    4. FILE: src/TransformBlockBase.php

      /**
       * {@inheritdoc}
       */
      public function __construct(array $configuration, $plugin_id, $plugin_definition) {

    FILE: src/Entity/EntityTransformDisplay.php

      /**
       * {@inheritdoc}
       */
      public function __construct(array $values, $entity_type) {

    The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

  • 🇩🇰Denmark LupusGr3y
    1. Master has been deleted.
    2. Oh, there's a newer version of the code sniffer. Corrections have been made.
    3. I have never seen this before and no other contrib module I could find does this. When was this changed?
    4. Constructor comments removed.
  • Status changed to Needs review 2 months ago
  • 🇮🇳India vishal.kadam Mumbai

    The third feedback related to the .module file description is not mandatory, but we typically recommend it. Rest looks fine to me.

    Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

  • 🇩🇰Denmark LupusGr3y

    Why do you recommend the .module description like that? Seems very non-standard and redundant.

  • Status changed to RTBC about 2 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    Thank you for your contribution!
    I updated your account so you can now opt into security advisory coverage for any project you created and every project you will create.

    These are some recommended readings to help you with maintainership:

    You can find more contributors chatting on Slack → or IRC → in #drupal-contribute. So, come hang out and stay involved → !

    Thank you for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review → . I encourage you to learn more about that process and join the group of reviewers.

    I thank also the dedicated reviewers as well.

  • Assigned to apaderno
  • Status changed to Fixed about 2 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.69.0 2024