If you have added any endpoints, deprecated, or made any changes in your API, you would need to regenerate the API documentation to reflect the latest changes.
You don't need to manually compare the current and previous specification files to update the API documentation. The steps in generating the API documentation with an updated specification file vary with the uploading methods (URL and OpenAPI definition file).
We will preserve the custom data added in the articles during the regeneration of the API documentation.
For example, you manually added a note in an endpoint article. When you regenerate the API documentation, the endpoint article will be updated with the latest content, but the note you added will still be available.
How to regenerate the API documentation with URL?
- Go to the desired project in the Knowledge base portal
- Click API documentation in the left menu bar
- Click API references at the top left
- Click '•••' next to the desired API reference for which you want to regenerate the API documentation
- You can regenerate the API documentation with a new URL or the existing URL
-
To regenerate with the existing URL:
- Click Resync
- The API documentation will be regenerated as per the latest specification file
-
To regenerate with a new URL:
- Select Edit
- Type the latest URL in the URL field
- Click Update
- The API documentation will be regenerated as per the latest URL specification file
-
How to regenerate the API documentation with the OpenAPI definition file?
- Go to the desired project in the Knowledge base portal
- Click API documentation in the left menu bar
- Click API references at the top left
- Click '•••' next to the desired API reference for which you want to regenerate the API documentation
- Select Edit
- Drag and drop the latest JSON or YAML file from your local storage into the Drop file here section
(or)
Click the Click here to upload link, and the file manager of your local device appears. Select the desired file from which you want to import the API and click Open. Click Update - The API documentation will be regenerated as per the latest specification file
How to resync the API documentation with CI/CD flow?
You can resync the API reference in your CI/CD pipelines with the help of your d360 npm packages.
d360 apidocs:resync
--apiKey=API_key_value
--userId=user_id_value
--apiReferenceId=API_reference_value
--path=Spec_file_path
You can also perform the resync manually using the above command.