Function generate_all_api_documents

scripts/describe.py:494–552

Retrieve discovery artifacts and fetch reference documentations for all apis listed in the public discovery directory. args: directory_uri (Optional[str]): uri of the public discovery directory. doc_destination_dir (Optional[str]): relative path where the reference

(
    directory_uri=DIRECTORY_URI,
    doc_destination_dir=BASE,
    artifact_destination_dir=DISCOVERY_DOC_DIR,
    discovery_uri_template=DISCOVERY_URI_TEMPLATE,
)

def generate_all_api_documents(
    directory_uri=DIRECTORY_URI,
    doc_destination_dir=BASE,
    artifact_destination_dir=DISCOVERY_DOC_DIR,
    discovery_uri_template=DISCOVERY_URI_TEMPLATE,
):
    """Retrieve discovery artifacts and fetch reference documentations
    for all apis listed in the public discovery directory.
    args:
        directory_uri (Optional[str]): uri of the public discovery directory.
        doc_destination_dir (Optional[str]): relative path where the reference
            documentation should be saved.
        artifact_destination_dir (Optional[str]): relative path where the discovery
            artifacts should be saved.
        discovery_uri_template (Optional[str]): URI template of the API's discovery
            document.
    """
    api_directory = collections.defaultdict(list)
    http = build_http()
    resp, content = http.request(directory_uri)
    if resp.status == 200:
        directory = json.loads(content)["items"]
        for api in directory:
            uri = uritemplate.expand(
                discovery_uri_template or api["discoveryRestUrl"],
                {"api": api["name"], "apiVersion": api["version"]},
            )
            document_api(
                api["name"],
                api["version"],
                uri,
                doc_destination_dir,
                artifact_destination_dir,
            )
            api_directory[api["name"]].append(api["version"])

        # sort by api name and version number
        for api in api_directory:
            api_directory[api] = sorted(api_directory[api])
        api_directory = collections.OrderedDict(
            sorted(api_directory.items(), key=lambda x: x[0])
        )

        markdown = []
        for api, versions in api_directory.items():
            markdown.append("## %s" % api)
            for version in versions:
                markdown.append(
                    "* [%s](http://googleapis.github.io/google-api-python-client/docs/dyn/%s_%s.html)"
                    % (version, api, safe_version(version))
                )
            markdown.append("\n")

        with open(doc_destination_dir / "index.md", "w") as f:
            markdown = "\n".join(markdown)
            f.write(markdown)

    else: