ibm-apidocs-cli
===============
|Status| |Latest Stable Version|
This tool allows users to generate the api documentation.
Installation
------------
- Install the CLI with ``pip`` or ``easy_install``:
.. code:: bash
pip install -U ibm-apidocs-cli
or
.. code:: bash
easy_install -U ibm-apidocs-cli
- Clone a `cloud-api-docs <https://github.ibm.com/cloud-api-docs>`__
repo to a local directory. Make sure the repo contains the required
``apiref-index.json`` file and the front-matter configuration file
(typically ``<openapi>-config.json``).
- Configure your GitHub Enterprise access token. You can skip this step
if you do not want the CLI to automatically download the latest
front-matter and SDK generator code.
Follow these steps:
1. Get an access token from `GitHub
Enterprise <https://github.ibm.com/settings/tokens>`__. For more
information, see the `GitHub
help <https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line>`__.
2. Set the ``GITHUB_TOKEN`` environment variable:
::
export GITHUB_TOKEN=<token>
- **Optional:** Configure a public GitHub access token. The CLI uses
the GitHub API to retrieve the latest SDK versions. If you encounter
errors caused by exceeding the GitHub API rate limit on anonymous
requests, try configuring the public GitHub access token.
Follow these steps:
1. Get an access token from
`GitHub <https://github.com/settings/tokens>`__. For more
information, see the `GitHub
help <https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line>`__.
2. Set the ``GITHUB_PUBLIC_TOKEN`` environment variable:
::
export GITHUB_PUBLIC_TOKEN=<token>
- **Optional:** Clone the `frontmatter
generator <https://github.ibm.com/cloud-doc-build/frontmatter-generator>`__
to a local directory. If you do not have a local clone of the
front-matter generator repo, the CLI will automatically clone it to a
temporary directory.
- **Optional:** Install the `SDK
generator <https://github.ibm.com/CloudEngineering/openapi-sdkgen/releases>`__
to a local directory. If you do not have a local copy of the SDK
generator, the CLI will automatically download the latest version to
a temporary directory.
To install the SDK generator, you do not need to clone or download
the full repository or build the project. Instead, use the
`installer <https://github.ibm.com/CloudEngineering/openapi-sdkgenreleases>`__.
For more information, see `the generator
README <https://github.ibm.comCloudEngineering/openapi-sdkgen#using-a-pre-built-installer>`__.
**Note:** The SDK generator .jar file must be named
``openapi-sdkgen.jar``. If you have downloaded or built a version of
the file with a different name
(e.g.\ ``openapi-sdkgen-<version>.jar``), you must rename it.
Usage
-----
There are two distinct modes of usage:
- **Manual mode** is used to process a single API definition, using a
local clone of the ``cloud-api-docs`` repo for the service. This mode
offers fine-grained control, with command-line arguments to specify
the front-matter config file and templates, the output location, and
other options that are specific to the file being processed. Any
required information that is not specified (other than the input API
definition) is looked up from the ``generate-apidocs.json`` map file.
Manual mode is the default.
- **Batch mode** is used to process one or more API definitions,
specified either individually or using wildcards. With batch mode,
processing is largely driven by the map file, which determines the
file-specific options for each API definition. You can use optional
command-line arguments to specify global options such as the SDK
generator to use or the target directory where ``cloud-api-docs``
repos are located. Batch mode is specified using the ``--batch`` or
``-b`` argument.
Syntax
------
.. code:: text
usage: ibm-apidocs-cli [-h | --help]
[--batch | -b]
-i <input_openapi> | --openapi <input_openapi>
[--config <config_file>]
[--mapfile <map_file>]
[--apidocs <apidocs_path>]
[--templates <templates_path>]
[--examples <examples_path>]
[--output_folder <output_path>]
[--target <target>]
[--frontmatter <frontmatter_path>]
[--sdk_generator <sdk_generator_path>]
[--sdkgen_release <sdkgen_release>]
[--commit_msg <commit_message>]
[--skip_sdkgen] [--push] [--keep_sdk] [--keep_temp]
[--no_update] [--verbose] [--version]
Required arguments:
- ``-i, --openapi <openapi_file>``: The path to the input OpenAPI
definition file(s) to process:
- In manual mode, this must be exactly one file (for example,
``assistant-v1.json``).
- In batch mode, this can be one or more file names or patterns,
separated by spaces. Any pattern containing wildcards will be
expanded. For example,
``./apis-public/*.json ./apis-private/*data*.json`` would process
all files in the ``apis-public`` subdirectory and all files
matching the pattern ``*data*.json`` in the ``apis-private``
subdirectory.
**Note:** If you specify a path that contains wildcards, do not
surround it with quotation marks. Use a backslash (``\``) to
escape spaces in the path.
Only files that are defined in the mapping file are processed. Any
file not in the mapping file is skipped, and processing continues.
Optional arguments:
- ``-h, --help``: Display usage information.
- ``-b, --batch``: Batch mode switch. Use batch mode to process
multiple files at once, using the map file to automatically look up
required values on a per-file basis. The default is manual mode,
which offers more fine-grained control over options but can process
only one file at a time.
**Note:** The handling of some command-line arguments, as well as
which arguments are valid, differ between batch mode and manual mode,
as described in this document.
- ``--config <config_file>`` *(Manual mode only)*: The front-matter
config file (e.g. ``assistant-v1-config.json``). You can optionally
specify the full path to the config file; if you do not include the
path, the file is assumed to be in the ``apidocs`` directory. If you
do not specify the config file, the file name is looked up from the
map file, and the file is assumed to be in the ``apidocs`` directory.
In batch mode, the config file name is always looked up from the map
file and retrieved from the downloaded ``cloud-api-docs`` repo for
the service.
- ``--apidocs <apidocs_path>`` *(Manual mode only)*: The path to the
``cloud-api-docs`` repository or other directory containing
``apiref-index.json`` and front matter config file. If you do not
specify this argument, the current directory is used. In batch mode,
you can use the ``--target`` argument to use local ``cloud-api-docs``
repos.
- ``--templates <templates_path>`` *(Manual mode only)*: Path to the
directory containing the front-matter templates to use. You can
specify either an absolute path or just the directory name (for
example, ``templates-data``); if you specify just the directory name,
it is assumed to be a subdirectory of the front-matter generator
location. If you do not specify a templates directory, the CLI will
use the templates directory specified in the map file.
In batch mode, the templates directory for each API definition is
looked up from the map file.
- ``--examples <examples_path>`` Path to the directory containing the
example files associated with the input OpenAPI definition(s). This
is typically the ``examples`` directory of a local clone of the
``developer-cloud--api-definitions`` repo). If you do not specify an
examples directory, the CLI will download the example files from the
``developer-cloud--api-definitions`` GHE repo. In batch mode, the
same examples directory is used for all API definitions.
The specific example files to be copied to the output directory for a
given OpenAPI file are listed in the map file. If the ``examples``
array is empty or absent for the input API definition, no example
files are copied.
- ``--output_folder <output_folder>`` *(Manual mode only)*: The output
directory for generated files. If you do not specify this argument,
output files are written to the current directory. In batch mode, you
can use the ``--target`` argument to control the location for
generated files.
- ``--target <target>`` *(Batch mode only)*: The parent directory of
the local ``cloud-api-docs`` repos you want to use for config files
and output. The CLI will look for subdirectories of this directory
named according to the service names listed in the map file, which
correspond to the ``cloud-api-docs`` repo names (for example,
``watson-assistant`` or ``discovery``). If the expected subdirectory
is not present, the CLI will clone it from GHE.
**Important:** If the ``cloud-api-docs`` directory for an affected
service already exists as a subdirectory of the ``target`` location,
the CLI uses it as-is. The config file might be modified, and the
generated files will overwrite previous versions that are already
present. Keep in mind that if this directory is not current, you
might not be able to push the changes to GHE without conflicts. It is
your responsibility to make sure any existing ``cloud-api-docs``
directories are current, or that they contain only changes you want.
(You can also delete any existing ``cloud-api-docs`` directory and
allow the CLI to clone the current version from GHE.)
If you omit the ``--target`` argument in batch mode, the
``cloud-api-docs`` directories for the affected services are cloned
to a temporary location. This means that the output is discarded
after processing completes (unless you specify the ``--keep_temp``
argument). This can still be useful if you want to run a test build
to check for build errors, but do not need to see the generated
output.
- ``--mapfile <map_file>``: The path to a local map file, including
file name (for example, ``generate-apidocs.json``). If you do not
specify a local map file, the current map file is downloaded from the
``developer-cloud--api-definitions`` repo as needed.
- ``--frontmatter <frontmatter_path>``: Path to the directory
containing the front-matter generator ``app.js`` file. Use this
option if you need to use a specific version or branch of the
front-matter generator code, or if you do not have a GitHub access
token configured. If you do not specify a location, the CLI will
automatically clone the latest version of the front-matter generator
repo to a temporary directory and use that clone.
- ``--sdk_generator <sdk_generator_path>``: Path to the directory
containing the SDK generator JAR file, optionally including the file
name. If you specify a directory but not a file name, the JAR file is
assumed to be ``openapi-sdkgen.jar``. Use this option if you need to
use local copy of the SDK generator. If you do not specify this
parameter, the CLI will automatically download the the
``openapi-sdkgen.jar`` file to a temporary directory and use that
copy.
- ``--sdkgen_release <sdkgen_release>``: Release of the SDK generator
to download, if you are allowing the CLI to download the generator
automatically. Specify the GitHub release tag (for example,
``1.0.0.1``). If you do not specify a release, the CLI uses the most
recent maintenance release for the major release specified in the map
file. This argument is ignored if ``--sdk_generator`` is specified.
- ``--commit_msg <commit_message>``: *(Batch mode only)* Custom commit
message to use when pushing generated files to the ``cloud-api-docs``
repo for the service. (Ignored if ``--push`` is not also specified.)
If you do not specify a custom commit message, the default commit
message is ``Commit by ibm-apidocs-cli: build <oas3_file>``.
- ``--skip_sdkgen``: Skips the generation of SDK-specific JSON files
using the SDK generator. Use this option to speed processing if you
only want to update the front matter or example files. For example,
you might use this option if the API definition has not changed, but
you want to update the front matter or examples. **Important:** The
input API definition file is always copied to the output or target
directory, even if you specify ``--skip_sdkgen``. If the API
definition has changed, this could cause mismatches with any existing
SDK-specific files.
- ``--push``: *(Batch mode only)* Commit and push generated files to
the ``master`` branch of the remote GitHub ``cloud-api-docs`` repo
for the service.
**Important:** This feature uses the ``git add``, ``git commit``, and
``git push`` commands to push the local target directory (where files
are generated) to GitHub. If you are using the ``--target`` argument
to generate files in an existing local directory, that directory
*must* be an up-to-date valid local clone of a remote api-docs repo,
with the ``master`` branch checked out.
The safest way to use the ``--push`` option is to omit the
``--target`` argument. This ensures that the generated files are
written to a freshly cloned local repo, which is guaranteed to be
even with the remote.
- ``--keep_sdk``: Preserve the ``_sdktemp`` directory containing
generated SDK artifacts. Useful for debugging purposes.
- ``--keep_temp``: Preserve the temporary directory containing the
downloaded front-matter and SDK generators, as well as any
``cloud-api-docs`` repos downloaded during batch processing. Useful
for debugging purposes.
- ``--no_update``: Use front-matter config file as-is without updating
SDK versions. If you do not specify this argument, the config file is
updated with the latest GitHub release for each supported SDK
language.
- ``-h``, ``--help``: Show usage information and exit.
- ``--verbose``: Verbose flag.
- ``--version``: Show program’s version number and exit.
Example commands: manual mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This example assumes that the command is being run from the ``apidocs``
repo directory containing the API Reference files, and that the CLI is
automatically downloading and using the latest code for the front-matter
and SDK generators. All output files are written to the current
directory:
.. code:: bash
ibm-apidocs-cli -i assistant-v1.json
This example uses different locations for the input and output files,
and also specifies local copies of the SDK generator and front-matter
generator code:
::
ibm-apidocs-cli -i '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/resources/config/assistant-openapi3-v1.json' \
-c '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/resources/config/test-input-config.yaml' \
--output_folder '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/target' \
--frontmatter '/Users/my_user/Documents/GitHub/frontmatter-generator' \
--sdk_generator '/Users/my_user/Documents/Release/openapi-sdkgen/lib'
Example commands: batch mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This example builds two API definitions from the current directory. All
other required files, including the map file, the ``cloud-api-docs``
repo, the front-matter generator, and the SDK generator, are downloaded
automatically. Output is written to the temporary ``cloud-api-docs``
directory and is not kept.
::
ibm-apidocs-cli -b -i assistant-v1.json assistant-v2.json
This example builds all API definitions from the ``public`` and
``private`` subdirectories, using local copies of the ``cloud-api-docs``
subdirectories for the affected services. Generated files will be
written to these same subdirectories.
::
ibm-apidocs-cli -b ./apis-public/*.json ./apis-private/*.json --target ~/github/cloud-api-docs
Mapping file
------------
The ``generate-apidocs.json`` mapping file is a configuration file that
is used by ``ibm-apidocs-cli`` to determine various default values for
each API definition.
The canonical version of this file is located in the root of the
`developer-cloud–api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions/blob/master/generate-apidocs.json>`__
repo. By default, the CLI downloads and uses the current mapping file
from GitHub, but you can use the ``--mapfile`` argument to specify a
local mapping file.
The format of the mapping file is as follows:
::
{
"name": "api-mapping",
"version": "0.1.0",
"sdkgen_major_release": "2",
"description": "api document mapping used by ibm-apidocs-cli tool",
"public": [
{
"service": "watson-assistant",
"openapi": "assistant-v1.json",
"config": "assistant-v1-config.json",
"frontmatter": "templates",
"examples": [
"assistant-v1-curl-examples.json",
"assistant-v1-dotnet-standard-examples.json",
"assistant-v1-go-examples.json",
"assistant-v1-java-examples.json",
"assistant-v1-node-examples.json",
"assistant-v1-python-examples.json",
"assistant-v1-ruby-examples.json",
"assistant-v1-swift-examples.json",
"assistant-v1-unity-examples.json"
]
},
...
],
"private": [
{
"service": "watson-assistant",
"openapi": "assistant-data-v1.json",
"config": "assistant-v1-config.json",
"frontmatter": "templates-data",
"examples": [
"assistant-v1-curl-examples.json",
"assistant-v1-dotnet-standard-examples.json",
"assistant-v1-go-examples.json",
"assistant-v1-java-examples.json",
"assistant-v1-node-examples.json",
"assistant-v1-python-examples.json",
"assistant-v1-ruby-examples.json",
"assistant-v1-swift-examples.json",
"assistant-v1-unity-examples.json"
]
},
...
]
}
where:
- ``name``: An identifier for the mapping file. This value is not used
by the CLI.
- ``version``: The mapping file version. This value is not used by the
CLI.
- ``sdkgen_major_release``: A global configuration value identifying
the major version of the `SDK
generator <https://github.ibm.com/CloudEngineering/openapi-sdkgen/releases>`__
that was used to generate the currently available SDKs. The
``ibm-apidocs-cli`` script uses this value to determine which
``sdkgen`` version to use for generating language-specific files. (By
default, the most recent maintenance release for the configured major
release is used.)
- ``description``: Description of the mapping file. This value is not
used by the CLI.
- ``public``: An array of JSON objects describing OAS3 API definitions
for public Watson services. These are the OAS3 files in the
``apis-public`` directory of the
`developer-cloud–api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions>`__
repo.
- ``private``: An array of JSON objects describing OAS3 API definitions
for private (ICP and ICP4D) Watson services. These are the OAS3 files
in the ``apis-private`` directory of the
`developer-cloud–api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions>`__
repo.
Within the ``public`` and ``private`` arrays, each object maps an API
definition to the default values used by ``ibm-apidocs-cli``:
- ``service``: An identifier for the Watson service described by the
OAS3 file. This identifier is the same as the name of the
```cloud-api-docs`` <https://github.ibm.com/cloud-api-docs>`__ repo
for the service, and is used to clone repos and push generated files
to GHE.
- ``openapi``: The name of the OAS3 file in the ``apis-public`` or
``apis-private`` directory.
- ``config``: The name of the front-matter configuration file to use
when building the API Reference for the OAS3 file. The specified
configuration file is assumed to exist in the ``cloud-api-docs`` repo
for the service.
- ``frontmatter``: The name of the directory containing the
front-matter templates to use when building the API Reference for the
OAS3 files. The specified directory must exist in the
`frontmatter-generator <https://github.ibm.com/cloud-doc-build/frontmatter-generator>`__
repo.
- ``examples``: An array listing the names of the JSON files containing
request examples to be merged with the OpenAPI definition at build
time. The listed example files will be copied to the output directory
along with the input OpenAPI file.
Python version
--------------
✅ Tested on Python 3.5, 3.6, and 3.7.
Contributing
------------
See `CONTRIBUTING.md <./CONTRIBUTING.md>`__.
License
-------
MIT
.. |Status| image:: https://img.shields.io/badge/status-beta-yellow.svg
.. |Latest Stable Version| image:: https://img.shields.io/pypi/v/ibm-apidocs-cli.svg
:target: https://pypi.python.org/pypi/ibm-apidocs-cli
Raw data
{
"_id": null,
"home_page": "https://cloud.ibm.com/apidocs",
"name": "ibm-apidocs-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "api-reference, ibm-watson, ibm-cloud",
"author": "IBM Corp",
"author_email": "germanatt@us.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/c5/7d/f1b46baa45d0eec1bd22444ab2029f395f698939b6bfbe815e48f935e9fa/ibm_apidocs_cli-0.19.0.tar.gz",
"platform": null,
"description": "ibm-apidocs-cli\n===============\n\n|Status| |Latest Stable Version|\n\nThis tool allows users to generate the api documentation.\n\nInstallation\n------------\n\n- Install the CLI with ``pip`` or ``easy_install``:\n\n .. code:: bash\n\n pip install -U ibm-apidocs-cli\n\n or\n\n .. code:: bash\n\n easy_install -U ibm-apidocs-cli\n\n- Clone a `cloud-api-docs <https://github.ibm.com/cloud-api-docs>`__\n repo to a local directory. Make sure the repo contains the required\n ``apiref-index.json`` file and the front-matter configuration file\n (typically ``<openapi>-config.json``).\n\n- Configure your GitHub Enterprise access token. You can skip this step\n if you do not want the CLI to automatically download the latest\n front-matter and SDK generator code.\n\n Follow these steps:\n\n 1. Get an access token from `GitHub\n Enterprise <https://github.ibm.com/settings/tokens>`__. For more\n information, see the `GitHub\n help <https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line>`__.\n\n 2. Set the ``GITHUB_TOKEN`` environment variable:\n\n ::\n\n export GITHUB_TOKEN=<token>\n\n- **Optional:** Configure a public GitHub access token. The CLI uses\n the GitHub API to retrieve the latest SDK versions. If you encounter\n errors caused by exceeding the GitHub API rate limit on anonymous\n requests, try configuring the public GitHub access token.\n\n Follow these steps:\n\n 1. Get an access token from\n `GitHub <https://github.com/settings/tokens>`__. For more\n information, see the `GitHub\n help <https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line>`__.\n\n 2. Set the ``GITHUB_PUBLIC_TOKEN`` environment variable:\n\n ::\n\n export GITHUB_PUBLIC_TOKEN=<token>\n\n- **Optional:** Clone the `frontmatter\n generator <https://github.ibm.com/cloud-doc-build/frontmatter-generator>`__\n to a local directory. If you do not have a local clone of the\n front-matter generator repo, the CLI will automatically clone it to a\n temporary directory.\n\n- **Optional:** Install the `SDK\n generator <https://github.ibm.com/CloudEngineering/openapi-sdkgen/releases>`__\n to a local directory. If you do not have a local copy of the SDK\n generator, the CLI will automatically download the latest version to\n a temporary directory.\n\n To install the SDK generator, you do not need to clone or download\n the full repository or build the project. Instead, use the\n `installer <https://github.ibm.com/CloudEngineering/openapi-sdkgenreleases>`__.\n For more information, see `the generator\n README <https://github.ibm.comCloudEngineering/openapi-sdkgen#using-a-pre-built-installer>`__.\n\n **Note:** The SDK generator .jar file must be named\n ``openapi-sdkgen.jar``. If you have downloaded or built a version of\n the file with a different name\n (e.g.\\ ``openapi-sdkgen-<version>.jar``), you must rename it.\n\nUsage\n-----\n\nThere are two distinct modes of usage:\n\n- **Manual mode** is used to process a single API definition, using a\n local clone of the ``cloud-api-docs`` repo for the service. This mode\n offers fine-grained control, with command-line arguments to specify\n the front-matter config file and templates, the output location, and\n other options that are specific to the file being processed. Any\n required information that is not specified (other than the input API\n definition) is looked up from the ``generate-apidocs.json`` map file.\n Manual mode is the default.\n\n- **Batch mode** is used to process one or more API definitions,\n specified either individually or using wildcards. With batch mode,\n processing is largely driven by the map file, which determines the\n file-specific options for each API definition. You can use optional\n command-line arguments to specify global options such as the SDK\n generator to use or the target directory where ``cloud-api-docs``\n repos are located. Batch mode is specified using the ``--batch`` or\n ``-b`` argument.\n\nSyntax\n------\n\n.. code:: text\n\n usage: ibm-apidocs-cli [-h | --help]\n [--batch | -b]\n -i <input_openapi> | --openapi <input_openapi>\n [--config <config_file>]\n [--mapfile <map_file>]\n [--apidocs <apidocs_path>]\n [--templates <templates_path>]\n [--examples <examples_path>]\n [--output_folder <output_path>]\n [--target <target>]\n [--frontmatter <frontmatter_path>]\n [--sdk_generator <sdk_generator_path>]\n [--sdkgen_release <sdkgen_release>]\n [--commit_msg <commit_message>]\n [--skip_sdkgen] [--push] [--keep_sdk] [--keep_temp]\n [--no_update] [--verbose] [--version]\n\nRequired arguments:\n\n- ``-i, --openapi <openapi_file>``: The path to the input OpenAPI\n definition file(s) to process:\n\n - In manual mode, this must be exactly one file (for example,\n ``assistant-v1.json``).\n\n - In batch mode, this can be one or more file names or patterns,\n separated by spaces. Any pattern containing wildcards will be\n expanded. For example,\n ``./apis-public/*.json ./apis-private/*data*.json`` would process\n all files in the ``apis-public`` subdirectory and all files\n matching the pattern ``*data*.json`` in the ``apis-private``\n subdirectory.\n\n **Note:** If you specify a path that contains wildcards, do not\n surround it with quotation marks. Use a backslash (``\\``) to\n escape spaces in the path.\n\n Only files that are defined in the mapping file are processed. Any\n file not in the mapping file is skipped, and processing continues.\n\nOptional arguments:\n\n- ``-h, --help``: Display usage information.\n\n- ``-b, --batch``: Batch mode switch. Use batch mode to process\n multiple files at once, using the map file to automatically look up\n required values on a per-file basis. The default is manual mode,\n which offers more fine-grained control over options but can process\n only one file at a time.\n\n **Note:** The handling of some command-line arguments, as well as\n which arguments are valid, differ between batch mode and manual mode,\n as described in this document.\n\n- ``--config <config_file>`` *(Manual mode only)*: The front-matter\n config file (e.g.\u00a0``assistant-v1-config.json``). You can optionally\n specify the full path to the config file; if you do not include the\n path, the file is assumed to be in the ``apidocs`` directory. If you\n do not specify the config file, the file name is looked up from the\n map file, and the file is assumed to be in the ``apidocs`` directory.\n\n In batch mode, the config file name is always looked up from the map\n file and retrieved from the downloaded ``cloud-api-docs`` repo for\n the service.\n\n- ``--apidocs <apidocs_path>`` *(Manual mode only)*: The path to the\n ``cloud-api-docs`` repository or other directory containing\n ``apiref-index.json`` and front matter config file. If you do not\n specify this argument, the current directory is used. In batch mode,\n you can use the ``--target`` argument to use local ``cloud-api-docs``\n repos.\n\n- ``--templates <templates_path>`` *(Manual mode only)*: Path to the\n directory containing the front-matter templates to use. You can\n specify either an absolute path or just the directory name (for\n example, ``templates-data``); if you specify just the directory name,\n it is assumed to be a subdirectory of the front-matter generator\n location. If you do not specify a templates directory, the CLI will\n use the templates directory specified in the map file.\n\n In batch mode, the templates directory for each API definition is\n looked up from the map file.\n\n- ``--examples <examples_path>`` Path to the directory containing the\n example files associated with the input OpenAPI definition(s). This\n is typically the ``examples`` directory of a local clone of the\n ``developer-cloud--api-definitions`` repo). If you do not specify an\n examples directory, the CLI will download the example files from the\n ``developer-cloud--api-definitions`` GHE repo. In batch mode, the\n same examples directory is used for all API definitions.\n\n The specific example files to be copied to the output directory for a\n given OpenAPI file are listed in the map file. If the ``examples``\n array is empty or absent for the input API definition, no example\n files are copied.\n\n- ``--output_folder <output_folder>`` *(Manual mode only)*: The output\n directory for generated files. If you do not specify this argument,\n output files are written to the current directory. In batch mode, you\n can use the ``--target`` argument to control the location for\n generated files.\n\n- ``--target <target>`` *(Batch mode only)*: The parent directory of\n the local ``cloud-api-docs`` repos you want to use for config files\n and output. The CLI will look for subdirectories of this directory\n named according to the service names listed in the map file, which\n correspond to the ``cloud-api-docs`` repo names (for example,\n ``watson-assistant`` or ``discovery``). If the expected subdirectory\n is not present, the CLI will clone it from GHE.\n\n **Important:** If the ``cloud-api-docs`` directory for an affected\n service already exists as a subdirectory of the ``target`` location,\n the CLI uses it as-is. The config file might be modified, and the\n generated files will overwrite previous versions that are already\n present. Keep in mind that if this directory is not current, you\n might not be able to push the changes to GHE without conflicts. It is\n your responsibility to make sure any existing ``cloud-api-docs``\n directories are current, or that they contain only changes you want.\n (You can also delete any existing ``cloud-api-docs`` directory and\n allow the CLI to clone the current version from GHE.)\n\n If you omit the ``--target`` argument in batch mode, the\n ``cloud-api-docs`` directories for the affected services are cloned\n to a temporary location. This means that the output is discarded\n after processing completes (unless you specify the ``--keep_temp``\n argument). This can still be useful if you want to run a test build\n to check for build errors, but do not need to see the generated\n output.\n\n- ``--mapfile <map_file>``: The path to a local map file, including\n file name (for example, ``generate-apidocs.json``). If you do not\n specify a local map file, the current map file is downloaded from the\n ``developer-cloud--api-definitions`` repo as needed.\n\n- ``--frontmatter <frontmatter_path>``: Path to the directory\n containing the front-matter generator ``app.js`` file. Use this\n option if you need to use a specific version or branch of the\n front-matter generator code, or if you do not have a GitHub access\n token configured. If you do not specify a location, the CLI will\n automatically clone the latest version of the front-matter generator\n repo to a temporary directory and use that clone.\n\n- ``--sdk_generator <sdk_generator_path>``: Path to the directory\n containing the SDK generator JAR file, optionally including the file\n name. If you specify a directory but not a file name, the JAR file is\n assumed to be ``openapi-sdkgen.jar``. Use this option if you need to\n use local copy of the SDK generator. If you do not specify this\n parameter, the CLI will automatically download the the\n ``openapi-sdkgen.jar`` file to a temporary directory and use that\n copy.\n\n- ``--sdkgen_release <sdkgen_release>``: Release of the SDK generator\n to download, if you are allowing the CLI to download the generator\n automatically. Specify the GitHub release tag (for example,\n ``1.0.0.1``). If you do not specify a release, the CLI uses the most\n recent maintenance release for the major release specified in the map\n file. This argument is ignored if ``--sdk_generator`` is specified.\n\n- ``--commit_msg <commit_message>``: *(Batch mode only)* Custom commit\n message to use when pushing generated files to the ``cloud-api-docs``\n repo for the service. (Ignored if ``--push`` is not also specified.)\n If you do not specify a custom commit message, the default commit\n message is ``Commit by ibm-apidocs-cli: build <oas3_file>``.\n\n- ``--skip_sdkgen``: Skips the generation of SDK-specific JSON files\n using the SDK generator. Use this option to speed processing if you\n only want to update the front matter or example files. For example,\n you might use this option if the API definition has not changed, but\n you want to update the front matter or examples. **Important:** The\n input API definition file is always copied to the output or target\n directory, even if you specify ``--skip_sdkgen``. If the API\n definition has changed, this could cause mismatches with any existing\n SDK-specific files.\n\n- ``--push``: *(Batch mode only)* Commit and push generated files to\n the ``master`` branch of the remote GitHub ``cloud-api-docs`` repo\n for the service.\n\n **Important:** This feature uses the ``git add``, ``git commit``, and\n ``git push`` commands to push the local target directory (where files\n are generated) to GitHub. If you are using the ``--target`` argument\n to generate files in an existing local directory, that directory\n *must* be an up-to-date valid local clone of a remote api-docs repo,\n with the ``master`` branch checked out.\n\n The safest way to use the ``--push`` option is to omit the\n ``--target`` argument. This ensures that the generated files are\n written to a freshly cloned local repo, which is guaranteed to be\n even with the remote.\n\n- ``--keep_sdk``: Preserve the ``_sdktemp`` directory containing\n generated SDK artifacts. Useful for debugging purposes.\n\n- ``--keep_temp``: Preserve the temporary directory containing the\n downloaded front-matter and SDK generators, as well as any\n ``cloud-api-docs`` repos downloaded during batch processing. Useful\n for debugging purposes.\n\n- ``--no_update``: Use front-matter config file as-is without updating\n SDK versions. If you do not specify this argument, the config file is\n updated with the latest GitHub release for each supported SDK\n language.\n\n- ``-h``, ``--help``: Show usage information and exit.\n\n- ``--verbose``: Verbose flag.\n\n- ``--version``: Show program\u2019s version number and exit.\n\nExample commands: manual mode\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis example assumes that the command is being run from the ``apidocs``\nrepo directory containing the API Reference files, and that the CLI is\nautomatically downloading and using the latest code for the front-matter\nand SDK generators. All output files are written to the current\ndirectory:\n\n.. code:: bash\n\n ibm-apidocs-cli -i assistant-v1.json\n\nThis example uses different locations for the input and output files,\nand also specifies local copies of the SDK generator and front-matter\ngenerator code:\n\n::\n\n ibm-apidocs-cli -i '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/resources/config/assistant-openapi3-v1.json' \\\n -c '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/resources/config/test-input-config.yaml' \\\n --output_folder '/Users/my_user/Documents/GitHub/api-apidocs-cli/test/target' \\\n --frontmatter '/Users/my_user/Documents/GitHub/frontmatter-generator' \\\n --sdk_generator '/Users/my_user/Documents/Release/openapi-sdkgen/lib'\n\nExample commands: batch mode\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis example builds two API definitions from the current directory. All\nother required files, including the map file, the ``cloud-api-docs``\nrepo, the front-matter generator, and the SDK generator, are downloaded\nautomatically. Output is written to the temporary ``cloud-api-docs``\ndirectory and is not kept.\n\n::\n\n ibm-apidocs-cli -b -i assistant-v1.json assistant-v2.json\n\nThis example builds all API definitions from the ``public`` and\n``private`` subdirectories, using local copies of the ``cloud-api-docs``\nsubdirectories for the affected services. Generated files will be\nwritten to these same subdirectories.\n\n::\n\n ibm-apidocs-cli -b ./apis-public/*.json ./apis-private/*.json --target ~/github/cloud-api-docs\n\nMapping file\n------------\n\nThe ``generate-apidocs.json`` mapping file is a configuration file that\nis used by ``ibm-apidocs-cli`` to determine various default values for\neach API definition.\n\nThe canonical version of this file is located in the root of the\n`developer-cloud\u2013api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions/blob/master/generate-apidocs.json>`__\nrepo. By default, the CLI downloads and uses the current mapping file\nfrom GitHub, but you can use the ``--mapfile`` argument to specify a\nlocal mapping file.\n\nThe format of the mapping file is as follows:\n\n::\n\n {\n \"name\": \"api-mapping\",\n \"version\": \"0.1.0\",\n \"sdkgen_major_release\": \"2\",\n \"description\": \"api document mapping used by ibm-apidocs-cli tool\",\n \"public\": [\n {\n \"service\": \"watson-assistant\",\n \"openapi\": \"assistant-v1.json\",\n \"config\": \"assistant-v1-config.json\",\n \"frontmatter\": \"templates\",\n \"examples\": [\n \"assistant-v1-curl-examples.json\",\n \"assistant-v1-dotnet-standard-examples.json\",\n \"assistant-v1-go-examples.json\",\n \"assistant-v1-java-examples.json\",\n \"assistant-v1-node-examples.json\",\n \"assistant-v1-python-examples.json\",\n \"assistant-v1-ruby-examples.json\",\n \"assistant-v1-swift-examples.json\",\n \"assistant-v1-unity-examples.json\"\n ]\n },\n ...\n ],\n \"private\": [\n {\n \"service\": \"watson-assistant\",\n \"openapi\": \"assistant-data-v1.json\",\n \"config\": \"assistant-v1-config.json\",\n \"frontmatter\": \"templates-data\",\n \"examples\": [\n \"assistant-v1-curl-examples.json\",\n \"assistant-v1-dotnet-standard-examples.json\",\n \"assistant-v1-go-examples.json\",\n \"assistant-v1-java-examples.json\",\n \"assistant-v1-node-examples.json\",\n \"assistant-v1-python-examples.json\",\n \"assistant-v1-ruby-examples.json\",\n \"assistant-v1-swift-examples.json\",\n \"assistant-v1-unity-examples.json\"\n ]\n },\n ...\n ]\n }\n\nwhere:\n\n- ``name``: An identifier for the mapping file. This value is not used\n by the CLI.\n\n- ``version``: The mapping file version. This value is not used by the\n CLI.\n\n- ``sdkgen_major_release``: A global configuration value identifying\n the major version of the `SDK\n generator <https://github.ibm.com/CloudEngineering/openapi-sdkgen/releases>`__\n that was used to generate the currently available SDKs. The\n ``ibm-apidocs-cli`` script uses this value to determine which\n ``sdkgen`` version to use for generating language-specific files. (By\n default, the most recent maintenance release for the configured major\n release is used.)\n\n- ``description``: Description of the mapping file. This value is not\n used by the CLI.\n\n- ``public``: An array of JSON objects describing OAS3 API definitions\n for public Watson services. These are the OAS3 files in the\n ``apis-public`` directory of the\n `developer-cloud\u2013api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions>`__\n repo.\n\n- ``private``: An array of JSON objects describing OAS3 API definitions\n for private (ICP and ICP4D) Watson services. These are the OAS3 files\n in the ``apis-private`` directory of the\n `developer-cloud\u2013api-definitions <https://github.ibm.com/Watson/developer-cloud--api-definitions>`__\n repo.\n\nWithin the ``public`` and ``private`` arrays, each object maps an API\ndefinition to the default values used by ``ibm-apidocs-cli``:\n\n- ``service``: An identifier for the Watson service described by the\n OAS3 file. This identifier is the same as the name of the\n ```cloud-api-docs`` <https://github.ibm.com/cloud-api-docs>`__ repo\n for the service, and is used to clone repos and push generated files\n to GHE.\n\n- ``openapi``: The name of the OAS3 file in the ``apis-public`` or\n ``apis-private`` directory.\n\n- ``config``: The name of the front-matter configuration file to use\n when building the API Reference for the OAS3 file. The specified\n configuration file is assumed to exist in the ``cloud-api-docs`` repo\n for the service.\n\n- ``frontmatter``: The name of the directory containing the\n front-matter templates to use when building the API Reference for the\n OAS3 files. The specified directory must exist in the\n `frontmatter-generator <https://github.ibm.com/cloud-doc-build/frontmatter-generator>`__\n repo.\n\n- ``examples``: An array listing the names of the JSON files containing\n request examples to be merged with the OpenAPI definition at build\n time. The listed example files will be copied to the output directory\n along with the input OpenAPI file.\n\nPython version\n--------------\n\n\u2705 Tested on Python 3.5, 3.6, and 3.7.\n\nContributing\n------------\n\nSee `CONTRIBUTING.md <./CONTRIBUTING.md>`__.\n\nLicense\n-------\n\nMIT\n\n.. |Status| image:: https://img.shields.io/badge/status-beta-yellow.svg\n.. |Latest Stable Version| image:: https://img.shields.io/pypi/v/ibm-apidocs-cli.svg\n :target: https://pypi.python.org/pypi/ibm-apidocs-cli\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI library to automate the API Reference generation",
"version": "0.19.0",
"project_urls": {
"Homepage": "https://cloud.ibm.com/apidocs"
},
"split_keywords": [
"api-reference",
" ibm-watson",
" ibm-cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a2fd6b72f0e9df13c00c8d457985e5ca83d47558eac4bdfd02ddb80f5bd64c7",
"md5": "1c55322f30e67ec13f302c71fab0d473",
"sha256": "54817f96ec94351f494266cde129e1ae934b21e281b12fb121ca45c529a86f20"
},
"downloads": -1,
"filename": "ibm_apidocs_cli-0.19.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c55322f30e67ec13f302c71fab0d473",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16352,
"upload_time": "2024-05-10T18:08:32",
"upload_time_iso_8601": "2024-05-10T18:08:32.533836Z",
"url": "https://files.pythonhosted.org/packages/5a/2f/d6b72f0e9df13c00c8d457985e5ca83d47558eac4bdfd02ddb80f5bd64c7/ibm_apidocs_cli-0.19.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c57df1b46baa45d0eec1bd22444ab2029f395f698939b6bfbe815e48f935e9fa",
"md5": "2b889a723f4b251611a31af5477e17f8",
"sha256": "5ee31388d5a7c614dde1e04ea3a100633fec3444627c56a20ea1f22ba2017596"
},
"downloads": -1,
"filename": "ibm_apidocs_cli-0.19.0.tar.gz",
"has_sig": false,
"md5_digest": "2b889a723f4b251611a31af5477e17f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25541,
"upload_time": "2024-05-10T18:08:35",
"upload_time_iso_8601": "2024-05-10T18:08:35.865422Z",
"url": "https://files.pythonhosted.org/packages/c5/7d/f1b46baa45d0eec1bd22444ab2029f395f698939b6bfbe815e48f935e9fa/ibm_apidocs_cli-0.19.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 18:08:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ibm-apidocs-cli"
}
JSON