docs: add links to rpc and rest documentation in repo-metadata.json

[alicejli]

As part of updating overviews in Cloud RAD, we would like to link to the language-agnostic RPC / REST documentation for each module if it exists.

That documentation is generated via a totally separate process from client library generation, so coverage is spotty and there are lots of inconsistencies in directory naming. Therefore, it isn't pruduct to assume all modules have RPC/REST documentation.
This is an initial population of URIs for REST / RPC reference that exist. Ongoing maintenance / population of these URIs to be discussed in future discussion about repo-metadata.json maintenance.

Sample script that parses each repo-metadata.json file for a product_documentation URI, creates a generic RPC/REST variation, curls it to see if it exists, and then writes it back if it does:

#!/bin/bash

# Find all .repo-metadata.json files in the current directory and its subdirectories
find . -type f -name '.repo-metadata.json' | while read -r file; do
    # Extract product_documentation values from each file
    product_documentation=$(jq -r '.product_documentation' "$file")

    # Form new documentation URLs
    if [[ "$product_documentation" == *"docs/" ]]; then
        rest_documentation="${product_documentation}reference/rest"
        rpc_documentation="${product_documentation}reference/rpc"
    elif [[ "$product_documentation" == *"docs" ]]; then
        # Add "/reference/rest" to product_documentation
        rest_documentation="${product_documentation}/reference/rest"
        rpc_documentation="${product_documentation}/reference/rpc"
    elif [[ "$product_documentation" == *"/" ]]; then
      rest_documentation="${product_documentation}docs/reference/rest"
      rpc_documentation="${product_documentation}docs/reference/rpc"
    else
        rest_documentation="${product_documentation}/docs/reference/rest"
        rpc_documentation="${product_documentation}/docs/reference/rpc"
    fi

    # Send HTTP requests and get status codes for rest and rpc documentation URLs
    http_status_rest=$(curl -o /dev/null -s -w "%{http_code}" "$rest_documentation")
    http_status_rpc=$(curl -o /dev/null -s -w "%{http_code}" "$rpc_documentation")

    # Build jq command to update the JSON file if the status code is 200
    jq_cmd='.'
    if [[ "$http_status_rest" -eq 200 ]]; then
        jq_cmd+=' | . + {rest_documentation: $rest_doc}'
    fi
    if [[ "$http_status_rpc" -eq 200 ]]; then
        jq_cmd+=' | . + {rpc_documentation: $rpc_doc}'
    fi

    # Update the .repo-metadata.json file with rest_documentation and rpc_documentation fields
    jq --arg rest_doc "$rest_documentation" --arg rpc_doc "$rpc_documentation" "$jq_cmd" "$file" > temp.json && mv temp.json "$file"
done

Out of 162 repo-metadata.json files, 124 had valid product_documentation links (e.g. return http status = 200).

Out of those, these are the repos containing either (or both) an invalid rpc/rest documentation link based on the generic URI variation: https://paste.googleplex.com/5546150802227200

[burkedavison]

💯