github.com/googleapis/api-linter@v1.65.2/docs/rules/index.md (about)

     1  ---
     2  permalink: /rules/
     3  ---
     4  
     5  # Rule Documentation
     6  
     7  Rules are divided into groups according to AIP block: each discrete block of
     8  AIPs may have a group of rules. The generally-applicable AIPs are organized
     9  into the "core" group of rules, and remaining blocks are grouped based on the
    10  `scope` name provided to the block on [aip.dev][].
    11  
    12  <ul class="glue-tile-set glue-mod-mt-std" style="margin-top: 40px;">
    13    <li>
    14      <a class="glue-tile glue-tile--border glue-tile--hoverable"
    15          aria-label="Image tile" href="rules/core/" tabindex="0">
    16        <div class="glue-tile__header glue-tile__header--icon">
    17          <svg role="img" class="glue-tile__icon">
    18            <use xlink:href="#glue-color-google-logo" x="-76"></use>
    19          </svg>
    20        </div>
    21        <div class="glue-tile__body">
    22          <h4 class="glue-tile__headline">
    23            Core rules
    24          </h4>
    25          <p class="glue-tile__description">
    26            Core rules are based on generally-applicable AIPs, and are enabled
    27            by default.
    28          </p>
    29          <ul class="glue-tile__links">
    30            <li class="glue-tile__link">
    31              <svg role="img" class="glue-tile__link glue-tile__link--arrow">
    32                <use xlink:href="#mi-arrow-forward-no-bg"></use>
    33              </svg>
    34            </li>
    35          </ul>
    36        </div>
    37      </a>
    38    </li>
    39    <li>
    40      <a class="glue-tile glue-tile--border glue-tile--hoverable"
    41          aria-label="Image tile" href="rules/client-libraries/" tabindex="0">
    42        <div class="glue-tile__header glue-tile__header--icon">
    43          <svg role="img" class="glue-tile__icon">
    44            <use xlink:href="#glue-color-google-logo" x="-76"></use>
    45          </svg>
    46        </div>
    47        <div class="glue-tile__body">
    48          <h4 class="glue-tile__headline">
    49            Client Library rules
    50          </h4>
    51          <p class="glue-tile__description">
    52            Client library rules are based on client library-specific AIPs, and are enabled by default.
    53          </p>
    54          <ul class="glue-tile__links">
    55            <li class="glue-tile__link">
    56              <svg role="img" class="glue-tile__link glue-tile__link--arrow">
    57                <use xlink:href="#mi-arrow-forward-no-bg"></use>
    58              </svg>
    59            </li>
    60          </ul>
    61        </div>
    62      </a>
    63    </li>
    64    <li>
    65      <a class="glue-tile glue-tile--border glue-tile--hoverable"
    66          aria-label="Image tile" href="rules/cloud/" tabindex="0">
    67        <div class="glue-tile__header glue-tile__header--icon">
    68          <svg role="img" class="glue-tile__icon">
    69            <use xlink:href="#glue-color-google-logo" x="-76"></use>
    70          </svg>
    71        </div>
    72        <div class="glue-tile__body">
    73          <h4 class="glue-tile__headline">
    74            Cloud rules
    75          </h4>
    76          <p class="glue-tile__description">
    77            Cloud rules are based on Cloud-specific AIPs, and are disabled by default.
    78          </p>
    79          <ul class="glue-tile__links">
    80            <li class="glue-tile__link">
    81              <svg role="img" class="glue-tile__link glue-tile__link--arrow">
    82                <use xlink:href="#mi-arrow-forward-no-bg"></use>
    83              </svg>
    84            </li>
    85          </ul>
    86        </div>
    87      </a>
    88    </li>
    89  </ul>
    90  
    91  [aip.dev]: https://aip.dev/